Class Delegation

constructor

• new Delegation(
      envelope: DecodedEnvelope<"dlg">,
      bytes: Uint8Array<ArrayBufferLike>,
      cid: CID<any, number, number, Version>,
  ): Delegation

  Parameters

  • envelope: DecodedEnvelope<"dlg">
  • bytes: Uint8Array<ArrayBufferLike>
  • cid: CID<any, number, number, Version>

  Returns Delegation

aud

bytes

cid

cmd

envelope

exp

iss

meta

nbf

nonce

pol

sub

toJSON

• toJSON(): {
      cid: string;
      envelope: {
          alg: SignatureType;
          enc: VarsigEncoding;
          payload: {
              aud: string;
              cmd: string;
              exp: number
              | null;
              iss: string;
              meta: Record<string, unknown> | undefined;
              nbf: number | undefined;
              nonce: string;
              pol: Policy;
              sub: string | null;
          };
          signature: string;
          spec: "dlg";
          version: string;
      };
      token: string;
  }

  Returns {
      cid: string;
      envelope: {
          alg: SignatureType;
          enc: VarsigEncoding;
          payload: {
              aud: string;
              cmd: string;
              exp: number | null;
              iss: string;
              meta: Record<string, unknown> | undefined;
              nbf: number | undefined;
              nonce: string;
              pol: Policy;
              sub: string | null;
          };
          signature: string;
          spec: "dlg";
          version: string;
      };
      token: string;
  }

toString

• toString(): string

  Returns string

validate

• validate(options: DelegationValidateOptions): Promise<boolean>

  Validate a delegation

  Checks the structure, "not before" time, signature, and revocation status

  Parameters

  • options: DelegationValidateOptions

  Returns Promise<boolean>

Staticcreate

• create<Schema extends StandardSchemaV1<any, any>>(
      options: DelegationOptions<Schema>,
  ): Promise<Delegation>

  Type Parameters

  • Schema extends StandardSchemaV1<any, any>

  Parameters

  • options: DelegationOptions<Schema>

  Returns Promise<Delegation>

Staticfrom

• from(options: DelegationFromOptions): Promise<Delegation>

  Create a delegation from bytes and validate it

  Does not validate "not before" time, call Delegation.validate to validate it

  Parameters

  • options: DelegationFromOptions

  Returns Promise<Delegation>

StaticfromString

• fromString(token: string): Promise<Delegation>

  Create a delegation from a base64 encoded string

  Parameters

  • token: string

  Returns Promise<Delegation>