Class Certificate

cert

Staticcreate

• create(
      options: utils.agent.CreateCertificateOptions,
  ): Promise<utils.agent.Certificate>

  Create a new instance of a certificate, automatically verifying it.

  Parameters

  • options: utils.agent.CreateCertificateOptions

    CreateCertificateOptions

    • certificate: Uint8Array

      The bytes encoding the certificate to be verified

    • rootKey: Uint8Array

      The root key against which to verify the certificate (normally, the root key of the IC main network)

    • canisterId: types.Principal

      The effective canister ID of the request when verifying a response, or the signing canister ID when verifying a certified variable.

    • OptionalblsVerify?: VerifyFunc

      BLS Verification strategy. Default strategy uses bls12_381 from @noble/curves

    • OptionalmaxAgeInMinutes?: number

      The maximum age of the certificate in minutes. Default is 5 minutes.

      Default

      5
      This is used to verify the time the certificate was signed, particularly for validating Delegation certificates, which can live for longer than the default window of +/- 5 minutes. If the certificate is
      older than the specified age, it will fail verification.
      Copy

    • OptionaldisableTimeVerification?: boolean

      Overrides the maxAgeInMinutes setting and skips comparing the client's time against the certificate. Used for scenarios where the machine's clock is known to be out of sync, or for inspecting expired certificates.

  Returns Promise<utils.agent.Certificate>

  Throws

  if the certificate cannot be verified

lookup_path

• lookup_path(path: utils.agent.NodePath): utils.agent.LookupResult

  Lookup a path in the certificate tree, using lookup_path.

  Parameters

  • path: utils.agent.NodePath

    The path to lookup.

  Returns utils.agent.LookupResult

  The result of the lookup.

lookup_subtree

• lookup_subtree(path: utils.agent.NodePath): utils.agent.SubtreeLookupResult

  Lookup a subtree in the certificate tree, using lookup_subtree.

  Parameters

  • path: utils.agent.NodePath

    The path to lookup.

  Returns utils.agent.SubtreeLookupResult

  The result of the lookup.