Graphorin API reference v0.8.0

---

Graphorin API reference / @graphorin/core / / PairingStore

Interface: PairingStore

Defined in: packages/core/src/contracts/pairing-store.ts:52

Pluggable persistent storage for channel pairing. Expiry POLICY lives in the access controller (@graphorin/channels), which injects its clock; the store only filters by the timestamps it is handed so behavior stays deterministic under test.

Stable

Methods

addPairedPeer()

addPairedPeer(peer): Promise<void>;

Defined in: packages/core/src/contracts/pairing-store.ts:62

Parameters

Parameter	Type
peer	PairedPeerRecord

Returns

Promise<void>

---

countPendingRequests()

countPendingRequests(channelId, nowIso): Promise<number>;

Defined in: packages/core/src/contracts/pairing-store.ts:59

Count pending requests on a channel whose expiresAt is after nowIso.

Parameters

Parameter	Type
channelId	string
nowIso	string

Returns

Promise<number>

---

deleteRequest()

deleteRequest(channelId, code): Promise<void>;

Defined in: packages/core/src/contracts/pairing-store.ts:57

Parameters

Parameter	Type
channelId	string
code	string

Returns

Promise<void>

---

findRequestByCode()

findRequestByCode(channelId, code): Promise<
  | PairingRequestRecord
| null>;

Defined in: packages/core/src/contracts/pairing-store.ts:56

Parameters

Parameter	Type
channelId	string
code	string

Returns

Promise< | PairingRequestRecord | null>

---

findRequestByPeer()

findRequestByPeer(peer): Promise<
  | PairingRequestRecord
| null>;

Defined in: packages/core/src/contracts/pairing-store.ts:55

Parameters

Parameter	Type
peer	PairingPeerRef

Returns

Promise< | PairingRequestRecord | null>

---

isPaired()

isPaired(peer): Promise<boolean>;

Defined in: packages/core/src/contracts/pairing-store.ts:63

Parameters

Parameter	Type
peer	PairingPeerRef

Returns

Promise&lt;boolean&gt;

---

listPairedPeers()

listPairedPeers(channelId?): Promise<readonly PairedPeerRecord[]>;

Defined in: packages/core/src/contracts/pairing-store.ts:65

Parameters

Parameter	Type
channelId?	string

Returns

Promise&lt;readonly PairedPeerRecord[]&gt;

---

pruneExpiredRequests()

pruneExpiredRequests(nowIso): Promise<number>;

Defined in: packages/core/src/contracts/pairing-store.ts:61

Delete requests whose expiresAt is at or before nowIso; returns the number removed.

Parameters

Parameter	Type
nowIso	string

Returns

Promise&lt;number&gt;

---

removePairedPeer()

removePairedPeer(peer): Promise<void>;

Defined in: packages/core/src/contracts/pairing-store.ts:64

Parameters

Parameter	Type
peer	PairingPeerRef

Returns

Promise&lt;void&gt;

---

upsertRequest()

upsertRequest(request): Promise<void>;

Defined in: packages/core/src/contracts/pairing-store.ts:54

Insert or replace the (single) pending request for the peer.

Parameters

Parameter	Type
request	PairingRequestRecord

Returns

Promise&lt;void&gt;