nooschain / payload-backfill/payload-fetch-client / FetchEncryptedPayloadOptions
Interface: FetchEncryptedPayloadOptions
Defined in: payload-backfill/payload-fetch-client.ts:20
Options for fetching one encrypted payload from a peer.
Properties
createMembershipProof?
optionalcreateMembershipProof?:CreateMembershipProof
Defined in: payload-backfill/payload-fetch-client.ts:34
Optional factory used to create a request-bound membership proof.
localNodePublicKey?
optionallocalNodePublicKey?:string
Defined in: payload-backfill/payload-fetch-client.ts:26
Optional local node public key sent so the peer can check authorization.
membershipChallenge?
optionalmembershipChallenge?:object
Defined in: payload-backfill/payload-fetch-client.ts:30
Challenge signed by the requesting node key and bound to the request path.
audience?
optionalaudience?:string
issuedAt
issuedAt:
string=isoDateSchema
method?
optionalmethod?:string
nodeId
nodeId:
string
nonce?
optionalnonce?:string
path?
optionalpath?:string
recordIds?
optionalrecordIds?:string[]
membershipChallengeSignature?
optionalmembershipChallengeSignature?:string
Defined in: payload-backfill/payload-fetch-client.ts:32
Base64 Ed25519 signature over membershipChallenge.
membershipCredential?
optionalmembershipCredential?:object
Defined in: payload-backfill/payload-fetch-client.ts:28
Optional signed membership credential proving the requesting node's org membership.
credentialId?
optionalcredentialId?: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
peer
peer:
SyncPeer
Defined in: payload-backfill/payload-fetch-client.ts:22
Peer whose /records/:id/payload endpoint should be queried.
recordId
recordId:
string
Defined in: payload-backfill/payload-fetch-client.ts:24
Encrypted record id to fetch.