nooschain v0.1.0

---

nooschain / payload-backfill/payload-fetch-client / FetchEncryptedPayloadBatchOptions

Interface: FetchEncryptedPayloadBatchOptions

Defined in: payload-backfill/payload-fetch-client.ts:38

Options for fetching a bounded batch of encrypted payloads from a peer.

Properties

batchSize?

optional batchSize?: number

Defined in: payload-backfill/payload-fetch-client.ts:54

Optional batch size, capped at the endpoint's 100-record contract.

---

createMembershipProof?

optional createMembershipProof?: CreateMembershipProof

Defined in: payload-backfill/payload-fetch-client.ts:52

Optional factory used to create a request-bound membership proof for each HTTP batch.

---

localNodePublicKey?

optional localNodePublicKey?: string

Defined in: payload-backfill/payload-fetch-client.ts:44

Optional local node public key sent so the peer can check authorization.

---

membershipChallenge?

optional membershipChallenge?: object

Defined in: payload-backfill/payload-fetch-client.ts:48

Challenge signed by the requesting node key and bound to the request path.

audience?

optional audience?: string

issuedAt

issuedAt: string = isoDateSchema

method?

optional method?: string

nodeId

nodeId: string

nonce?

optional nonce?: string

path?

optional path?: string

recordIds?

optional recordIds?: string[]

---

membershipChallengeSignature?

optional membershipChallengeSignature?: string

Defined in: payload-backfill/payload-fetch-client.ts:50

Base64 Ed25519 signature over membershipChallenge.

---

membershipCredential?

optional membershipCredential?: object

Defined in: payload-backfill/payload-fetch-client.ts:46

Optional signed membership credential proving the requesting node's org membership.

credentialId?

optional credentialId?: string

expiresAt

expiresAt: string = isoDateSchema

issuedAt

issuedAt: string = isoDateSchema

issuer

issuer: string

nodeId

nodeId: string

nodePublicKey

nodePublicKey: string

organizationId

organizationId: string

permissions

permissions: ("replicate" | "serve_payloads")[]

signature

signature: string

---

onBatch?

optional onBatch?: (event) => void | Promise<void>

Defined in: payload-backfill/payload-fetch-client.ts:56

Optional progress callback for chunk diagnostics.

Parameters

event

batchNumber

number

batchSize

number

totalBatches

number

Returns

void | Promise<void>

---

peer

peer: SyncPeer

Defined in: payload-backfill/payload-fetch-client.ts:40

Peer whose /records/payloads endpoint should be queried.

---

recordIds

recordIds: string[]

Defined in: payload-backfill/payload-fetch-client.ts:42

Encrypted record ids to fetch.