Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used by the build function when creating new UCAN tokens.

Hierarchy

Index

Properties

addNonce?: boolean

Reserved for future use.

audience: string

DID string containing the public key of the recipient (who the token is "for")

capabilities: StorageCapability[]

Capabilities (permissions) for storage services that should be granted by this UCAN token.

expiration?: number

Expiration time (as unix timestamp). If set, overrides lifetimeInSeconds

facts?: Fact[]

Optional collection of arbitrary "facts" attached to the token.

issuer: KeyPair

Signing key for the token issuer (who the token is "from")

lifetimeInSeconds?: number

How long the token should be valid (in seconds). Ignored if expiration is set explicitly.

notBefore?: number

Earliest time (as unix timestamp) that the token should be considered valid. If set, must be < expiration. If not set, any time before expiration will be considered valid.

proofs?: string[]

Array of "proofs" (encoded UCAN tokens) used to validate delegated UCAN chains.

Generated using TypeDoc