Interface CCF

Hierarchy

CCF

Index

Properties

consensus crypto historical historicalState? kv rpc

Methods

bufToJsonCompatible bufToStr digest generateAesKey generateRsaKeyPair isValidX509CertBundle isValidX509CertChain jsonCompatibleToBuf strToBuf wrapKey

Properties

consensus

consensus: CCFConsensus

crypto

crypto: CCFCrypto

historical

historical: CCFHistorical

`Optional` historicalState

historicalState?: HistoricalState

State associated with a specific historic transaction. Only defined for endpoints with "mode" set to "historical".

kv

An object that provides access to the maps of the Key-Value Store of CCF. Fields are map names and values are KvMap objects.

rpc

Methods

bufToJsonCompatible

bufToJsonCompatible<T>(v: ArrayBuffer): T
Parse JSON from an ArrayBuffer.

Equivalent to JSON.parse(ccf.bufToStr(v)).
Type Parameters
- T extends unknown
Parameters
- v: ArrayBuffer
Returns T
- Defined in global.ts:377

bufToStr

bufToStr(v: ArrayBuffer): string
Convert an ArrayBuffer into a string.
Parameters
- v: ArrayBuffer
Returns string
- Defined in global.ts:363

digest

digest(algorithm: "SHA-256", data: ArrayBuffer): ArrayBuffer
Generate a digest (hash) of the given data.
Parameters
- algorithm: "SHA-256"
- data: ArrayBuffer
Returns ArrayBuffer
- Defined in global.ts:409

generateAesKey

generateAesKey(size: number): ArrayBuffer
Generate an AES key.
Parameters
- size: number
  
  The length in bits of the key to generate. 128, 192, or 256.
Returns ArrayBuffer
- Defined in global.ts:384

generateRsaKeyPair

generateRsaKeyPair(size: number, exponent?: number): CryptoKeyPair
Generate an RSA key pair.
Parameters
- size: number
  
  The length in bits of the RSA modulus. Minimum: 2048.
- Optional exponent: number
  
  The public exponent. Default: 65537.
Returns CryptoKeyPair
- Defined in global.ts:392

isValidX509CertBundle

isValidX509CertBundle(pem: string): boolean
Returns whether a string is a PEM-encoded bundle of X.509 certificates.

A bundle consists of one or more certificates. Certificates in the bundle do not have to be related to each other. Validation is only syntactical, properties like validity dates are not evaluated.
Parameters
- pem: string
Returns boolean
- Defined in global.ts:418

isValidX509CertChain

isValidX509CertChain(chain: string, trusted: string): boolean
Returns whether a certificate chain is valid given a set of trusted certificates. The chain and trusted certificates are PEM-encoded bundles of X.509 certificates.
Parameters
- chain: string
- trusted: string
Returns boolean
- Defined in global.ts:424

jsonCompatibleToBuf

jsonCompatibleToBuf<T>(v: T): ArrayBuffer
Serialize a value to JSON and convert it to an ArrayBuffer.

Equivalent to ccf.strToBuf(JSON.stringify(v)).
Type Parameters
- T extends unknown
Parameters
- v: T
Returns ArrayBuffer
- Defined in global.ts:370

strToBuf

strToBuf(v: string): ArrayBuffer
Convert a string into an ArrayBuffer.
Parameters
- v: string
Returns ArrayBuffer
- Defined in global.ts:358

wrapKey

wrapKey(key: ArrayBuffer, wrappingKey: ArrayBuffer, wrapAlgo: WrapAlgoParams): ArrayBuffer
Wraps a key using a wrapping key.

Constraints on the key and wrappingKey parameters depend on the wrapping algorithm that is used (wrapAlgo).
Parameters
- key: ArrayBuffer
- wrappingKey: ArrayBuffer
- wrapAlgo: WrapAlgoParams
Returns ArrayBuffer
- Defined in global.ts:400

Generated using TypeDoc