CreateCertificateOptions
Defined in: packages/agent/src/certificate.ts:155
agent?
Section titled “agent?”
optional
agent:Agent
Defined in: packages/agent/src/certificate.ts:195
The agent used to sync time with the IC network, if the certificate fails the freshness check. If the agent does not implement the HttpAgent.getTimeDiffMsecs, HttpAgent.hasSyncedTime and HttpAgent.syncTime methods, time will not be synced in case of a freshness check failure.
Default
Section titled “Default”undefined
blsVerify?
Section titled “blsVerify?”
optional
blsVerify:VerifyFunc
Defined in: packages/agent/src/certificate.ts:173
BLS Verification strategy. Default strategy uses bls12_381 from @noble/curves
canisterId
Section titled “canisterId”canisterId:
Principal
Defined in: packages/agent/src/certificate.ts:169
The effective canister ID of the request when verifying a response, or the signing canister ID when verifying a certified variable.
certificate
Section titled “certificate”certificate:
Uint8Array
Defined in: packages/agent/src/certificate.ts:159
The bytes encoding the certificate to be verified
disableTimeVerification?
Section titled “disableTimeVerification?”
optional
disableTimeVerification:boolean
Defined in: packages/agent/src/certificate.ts:187
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.
Default
Section titled “Default”false
maxAgeInMinutes?
Section titled “maxAgeInMinutes?”
optional
maxAgeInMinutes:number
Defined in: packages/agent/src/certificate.ts:181
The maximum age of the certificate in minutes. Default is 5 minutes. 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.
Default
Section titled “Default”5
rootKey
Section titled “rootKey”rootKey:
Uint8Array
Defined in: packages/agent/src/certificate.ts:164
The root key against which to verify the certificate (normally, the root key of the IC main network)