1.13.3

🧰 Functions

• initialize
• getLastAnswerId
• sendMessageToNode
• sendWalletToOperatorMessage

⚙ initialize

Function	Type
initialize	(intf: any) => void

⚙ getLastAnswerId

Function	Type
getLastAnswerId	() => any

⚙ sendMessageToNode

Function	Type
sendMessageToNode	(url: any, schemaId: any, object: any) => Promise<unknown>

⚙ sendWalletToOperatorMessage

Function	Type
sendWalletToOperatorMessage	<T = unknown>(url: any, schemaId: any, object: any) => Promise<T>

🔧 Constants

• TYPE_UNKNOWN
• TYPE_ARRAY
• TYPE_OBJECT
• TYPE_STRING
• TYPE_NUMBER
• TYPE_BOOLEAN
• TYPE_NULL
• TYPE_UINT8
• TYPE_UINT16
• TYPE_UINT24
• TYPE_UINT32
• TYPE_UINT48
• TYPE_BINARY
• TYPE_BIN256
• TYPE_HASH_STR
• TYPE_MAIN
• TYPE_ARRAY_OF
• TYPE_NAMES
• HASHABLE
• MASKABLE
• PROPERTIES
• REDACTED
• HASHED
• MASKED
• FORMAT
• MAGIC_STRING
• PROTOCOL_VERSION
• VB_ACCOUNT
• VB_VALIDATOR_NODE
• VB_ORGANIZATION
• VB_APPLICATION
• VB_APP_LEDGER
• N_VIRTUAL_BLOCKCHAINS
• VB_NAME
• MAX_MICROBLOCK_PAST_DELAY
• MAX_MICROBLOCK_FUTURE_DELAY
• MB_STATUS_UNRECOVERABLE_ERROR
• MB_STATUS_TIMESTAMP_ERROR
• MB_STATUS_PREVIOUS_HASH_ERROR
• ERROR
• RECORD_DESCRIPTION
• ACCOUNT_STATE
• ACCOUNT_HISTORY
• VIRTUAL_BLOCKCHAIN_STATE
• VB_STATES
• BLOCK_INFORMATION
• BLOCK_CONTENT
• MICROBLOCK_HEADER_PREVIOUS_HASH_OFFSET
• MICROBLOCK_HEADER_BODY_HASH_OFFSET
• MICROBLOCK_HEADER_SIZE
• MICROBLOCK_HEADER
• MICROBLOCK_SECTION
• MICROBLOCK_BODY
• MICROBLOCK_VB_INFORMATION
• MSG_ERROR
• MSG_GET_CHAIN_INFORMATION
• MSG_CHAIN_INFORMATION
• MSG_GET_BLOCK_INFORMATION
• MSG_BLOCK_INFORMATION
• MSG_GET_BLOCK_CONTENT
• MSG_BLOCK_CONTENT
• MSG_GET_VIRTUAL_BLOCKCHAIN_STATE
• MSG_VIRTUAL_BLOCKCHAIN_STATE
• MSG_GET_VIRTUAL_BLOCKCHAIN_UPDATE
• MSG_VIRTUAL_BLOCKCHAIN_UPDATE
• MSG_GET_MICROBLOCK_INFORMATION
• MSG_MICROBLOCK_INFORMATION
• MSG_AWAIT_MICROBLOCK_ANCHORING
• MSG_MICROBLOCK_ANCHORING
• MSG_GET_MICROBLOCK_BODYS
• MSG_MICROBLOCK_BODYS
• MSG_GET_ACCOUNT_STATE
• MSG_ACCOUNT_STATE
• MSG_GET_ACCOUNT_HISTORY
• MSG_ACCOUNT_HISTORY
• MSG_GET_ACCOUNT_BY_PUBLIC_KEY_HASH
• MSG_ACCOUNT_BY_PUBLIC_KEY_HASH
• MSG_GET_VALIDATOR_NODE_BY_ADDRESS
• MSG_VALIDATOR_NODE_BY_ADDRESS
• MSG_GET_OBJECT_LIST
• MSG_OBJECT_LIST
• MSG_GET_GENESIS_SNAPSHOT
• MSG_GENESIS_SNAPSHOT
• NODE_MESSAGES
• WI_MAX_SERVER_URL_LENGTH
• WI_QR_CODE
• WIMSG_REQUEST
• WIMSG_UPDATE_QR
• WIMSG_CONNECTION_TOKEN
• WIMSG_FORWARDED_ANSWER
• WIMSG_GET_CONNECTION_INFO
• WIMSG_ANSWER
• WIMSG_CONNECTION_INFO
• WIMSG_CONNECTION_ACCEPTED
• WIMSG_FORWARDED_REQUEST
• WI_MESSAGES
• WIRQ_AUTH_BY_PUBLIC_KEY
• WIRQ_DATA_APPROVAL
• WIRQ_GET_EMAIL
• WIRQ_GET_USER_DATA
• WI_REQUESTS
• WI_ANSWERS
• MSG_ANS_ERROR
• MSG_APPROVAL_HANDSHAKE
• MSG_ACTOR_KEY
• MSG_APPROVAL_SIGNATURE
• MSG_ANS_ACTOR_KEY_REQUIRED
• MSG_ANS_APPROVAL_DATA
• MSG_ANS_APPROVAL_SIGNATURE
• WALLET_OP_MESSAGES
• ALL_SCHEMAS
• TOKEN_NAME
• TOKEN
• CENTITOKEN
• MILLITOKEN
• INITIAL_OFFER
• MINIMUM_GAS_PRICE
• MAXIMUM_GAS_PRICE
• FIXED_GAS_FEE
• GAS_PER_BYTE
• GAS_UNIT
• BK_PLUS
• BK_PAID_TX_FEES
• BK_PAID_BLOCK_FEES
• BK_SENT_ISSUANCE
• BK_SALE
• BK_SENT_PAYMENT
• BK_EARNED_TX_FEES
• BK_EARNED_BLOCK_FEES
• BK_RECEIVED_ISSUANCE
• BK_PURCHASE
• BK_RECEIVED_PAYMENT
• BK_REF_BLOCK
• BK_REF_MICROBLOCK
• BK_REF_SECTION
• BK_REFERENCES
• BK_NAMES
• ACCOUNT_BURNT_TOKENS
• ACCOUNT_STANDARD
• ACCOUNT_BLOCK_FEES
• ACCOUNT_LOCKED_TOKENS
• ACCOUNT_NAMES
• ACCOUNT_ALLOWED_TRANSFERS
• ZERO
• ONE
• AT_LEAST_ONE
• AT_MOST_ONE
• ANY
• CONSTRAINT_NAMES
• ACCOUNT_SIG_ALGORITHM
• ACCOUNT_PUBLIC_KEY
• ACCOUNT_TOKEN_ISSUANCE
• ACCOUNT_CREATION
• ACCOUNT_TRANSFER
• ACCOUNT_SIGNATURE
• VN_SIG_ALGORITHM
• VN_DECLARATION
• VN_DESCRIPTION
• VN_RPC_ENDPOINT
• VN_NETWORK_INTEGRATION
• VN_SIGNATURE
• ORG_SIG_ALGORITHM
• ORG_PUBLIC_KEY
• ORG_DESCRIPTION
• ORG_SERVER
• ORG_SIGNATURE
• APP_SIG_ALGORITHM
• APP_DECLARATION
• APP_DESCRIPTION
• APP_SIGNATURE
• APP_LEDGER_SIG_ALGORITHM
• APP_LEDGER_PKE_ALGORITHM
• APP_LEDGER_DECLARATION
• APP_LEDGER_ACTOR_CREATION
• APP_LEDGER_CHANNEL_CREATION
• APP_LEDGER_SHARED_SECRET
• APP_LEDGER_CHANNEL_INVITATION
• APP_LEDGER_ACTOR_SUBSCRIPTION
• APP_LEDGER_PUBLIC_CHANNEL_DATA
• APP_LEDGER_PRIVATE_CHANNEL_DATA
• APP_LEDGER_AUTHOR
• APP_LEDGER_ENDORSER
• APP_LEDGER_ENDORSER_SIGNATURE
• APP_LEDGER_AUTHOR_SIGNATURE
• ALL_SECTIONS_SCHEMAS
• DEF
• WI_INVALID_SIGNATURE
• Utf8Encoder
• Utils
• Random
• Hashes
• Aes
• MLDsa
• MLKem
• Secp256k1
• Crypto
• BlockchainUtils
• PathManager
• MaskManager
• RPCNodeStatusResponseSchema
• Base64
• Economics
• NewBlockEventSchema
• RADIX_CST
• RadixUtils
• RadixChecker

⚙ TYPE_UNKNOWN

Constant	Type
TYPE_UNKNOWN	0

⚙ TYPE_ARRAY

Constant	Type
TYPE_ARRAY	1

⚙ TYPE_OBJECT

Constant	Type
TYPE_OBJECT	2

⚙ TYPE_STRING

Constant	Type
TYPE_STRING	3

⚙ TYPE_NUMBER

Constant	Type
TYPE_NUMBER	4

⚙ TYPE_BOOLEAN

Constant	Type
TYPE_BOOLEAN	5

⚙ TYPE_NULL

Constant	Type
TYPE_NULL	6

⚙ TYPE_UINT8

Constant	Type
TYPE_UINT8	7

⚙ TYPE_UINT16

Constant	Type
TYPE_UINT16	8

⚙ TYPE_UINT24

Constant	Type
TYPE_UINT24	9

⚙ TYPE_UINT32

Constant	Type
TYPE_UINT32	10

⚙ TYPE_UINT48

Constant	Type
TYPE_UINT48	11

⚙ TYPE_BINARY

Constant	Type
TYPE_BINARY	12

⚙ TYPE_BIN256

Constant	Type
TYPE_BIN256	13

⚙ TYPE_HASH_STR

Constant	Type
TYPE_HASH_STR	14

⚙ TYPE_MAIN

Constant	Type
TYPE_MAIN	31

⚙ TYPE_ARRAY_OF

Constant	Type
TYPE_ARRAY_OF	32

⚙ TYPE_NAMES

Constant	Type
TYPE_NAMES	string[]

⚙ HASHABLE

Constant	Type
HASHABLE	1

⚙ MASKABLE

Constant	Type
MASKABLE	2

⚙ PROPERTIES

Constant	Type
PROPERTIES	3

⚙ REDACTED

Constant	Type
REDACTED	4

⚙ HASHED

Constant	Type
HASHED	8

⚙ MASKED

Constant	Type
MASKED	16

⚙ FORMAT

Constant	Type
FORMAT	28

⚙ MAGIC_STRING

Constant	Type
MAGIC_STRING	"CMTS"

⚙ PROTOCOL_VERSION

Constant	Type
PROTOCOL_VERSION	1

⚙ VB_ACCOUNT

Constant	Type
VB_ACCOUNT	0

⚙ VB_VALIDATOR_NODE

Constant	Type
VB_VALIDATOR_NODE	1

⚙ VB_ORGANIZATION

Constant	Type
VB_ORGANIZATION	2

⚙ VB_APPLICATION

Constant	Type
VB_APPLICATION	3

⚙ VB_APP_LEDGER

Constant	Type
VB_APP_LEDGER	4

⚙ N_VIRTUAL_BLOCKCHAINS

Constant	Type
N_VIRTUAL_BLOCKCHAINS	5

⚙ VB_NAME

Constant	Type
VB_NAME	string[]

⚙ MAX_MICROBLOCK_PAST_DELAY

Constant	Type
MAX_MICROBLOCK_PAST_DELAY	300

⚙ MAX_MICROBLOCK_FUTURE_DELAY

Constant	Type
MAX_MICROBLOCK_FUTURE_DELAY	60

⚙ MB_STATUS_UNRECOVERABLE_ERROR

Constant	Type
MB_STATUS_UNRECOVERABLE_ERROR	1

⚙ MB_STATUS_TIMESTAMP_ERROR

Constant	Type
MB_STATUS_TIMESTAMP_ERROR	2

⚙ MB_STATUS_PREVIOUS_HASH_ERROR

Constant	Type
MB_STATUS_PREVIOUS_HASH_ERROR	3

⚙ ERROR

Constant	Type
ERROR	Schema

⚙ RECORD_DESCRIPTION

Constant	Type
RECORD_DESCRIPTION	Schema

⚙ ACCOUNT_STATE

Constant	Type
ACCOUNT_STATE	Schema

⚙ ACCOUNT_HISTORY

Constant	Type
ACCOUNT_HISTORY	Schema

⚙ VIRTUAL_BLOCKCHAIN_STATE

Constant	Type
VIRTUAL_BLOCKCHAIN_STATE	Schema

⚙ VB_STATES

Constant	Type
VB_STATES	Schema[]

⚙ BLOCK_INFORMATION

Constant	Type
BLOCK_INFORMATION	{ label: string; definition: { name: string; type: number; }[]; }

⚙ BLOCK_CONTENT

Constant	Type
BLOCK_CONTENT	{ label: string; definition: { name: string; type: number; definition: { name: string; type: number; }[]; }[]; }

⚙ MICROBLOCK_HEADER_PREVIOUS_HASH_OFFSET

Constant	Type
MICROBLOCK_HEADER_PREVIOUS_HASH_OFFSET	12

⚙ MICROBLOCK_HEADER_BODY_HASH_OFFSET

Constant	Type
MICROBLOCK_HEADER_BODY_HASH_OFFSET	57

⚙ MICROBLOCK_HEADER_SIZE

Constant	Type
MICROBLOCK_HEADER_SIZE	89

⚙ MICROBLOCK_HEADER

Constant	Type
MICROBLOCK_HEADER	Schema

⚙ MICROBLOCK_SECTION

Constant	Type
MICROBLOCK_SECTION	Schema

⚙ MICROBLOCK_BODY

Constant	Type
MICROBLOCK_BODY	Schema

⚙ MICROBLOCK_VB_INFORMATION

Constant	Type
MICROBLOCK_VB_INFORMATION	Schema

⚙ MSG_ERROR

Constant	Type
MSG_ERROR	0

⚙ MSG_GET_CHAIN_INFORMATION

Constant	Type
MSG_GET_CHAIN_INFORMATION	1

⚙ MSG_CHAIN_INFORMATION

Constant	Type
MSG_CHAIN_INFORMATION	2

⚙ MSG_GET_BLOCK_INFORMATION

Constant	Type
MSG_GET_BLOCK_INFORMATION	3

⚙ MSG_BLOCK_INFORMATION

Constant	Type
MSG_BLOCK_INFORMATION	4

⚙ MSG_GET_BLOCK_CONTENT

Constant	Type
MSG_GET_BLOCK_CONTENT	5

⚙ MSG_BLOCK_CONTENT

Constant	Type
MSG_BLOCK_CONTENT	6

⚙ MSG_GET_VIRTUAL_BLOCKCHAIN_STATE

Constant	Type
MSG_GET_VIRTUAL_BLOCKCHAIN_STATE	7

⚙ MSG_VIRTUAL_BLOCKCHAIN_STATE

Constant	Type
MSG_VIRTUAL_BLOCKCHAIN_STATE	8

⚙ MSG_GET_VIRTUAL_BLOCKCHAIN_UPDATE

Constant	Type
MSG_GET_VIRTUAL_BLOCKCHAIN_UPDATE	9

⚙ MSG_VIRTUAL_BLOCKCHAIN_UPDATE

Constant	Type
MSG_VIRTUAL_BLOCKCHAIN_UPDATE	10

⚙ MSG_GET_MICROBLOCK_INFORMATION

Constant	Type
MSG_GET_MICROBLOCK_INFORMATION	11

⚙ MSG_MICROBLOCK_INFORMATION

Constant	Type
MSG_MICROBLOCK_INFORMATION	12

⚙ MSG_AWAIT_MICROBLOCK_ANCHORING

Constant	Type
MSG_AWAIT_MICROBLOCK_ANCHORING	13

⚙ MSG_MICROBLOCK_ANCHORING

Constant	Type
MSG_MICROBLOCK_ANCHORING	14

⚙ MSG_GET_MICROBLOCK_BODYS

Constant	Type
MSG_GET_MICROBLOCK_BODYS	15

⚙ MSG_MICROBLOCK_BODYS

Constant	Type
MSG_MICROBLOCK_BODYS	16

⚙ MSG_GET_ACCOUNT_STATE

Constant	Type
MSG_GET_ACCOUNT_STATE	17

⚙ MSG_ACCOUNT_STATE

Constant	Type
MSG_ACCOUNT_STATE	18

⚙ MSG_GET_ACCOUNT_HISTORY

Constant	Type
MSG_GET_ACCOUNT_HISTORY	19

⚙ MSG_ACCOUNT_HISTORY

Constant	Type
MSG_ACCOUNT_HISTORY	20

⚙ MSG_GET_ACCOUNT_BY_PUBLIC_KEY_HASH

Constant	Type
MSG_GET_ACCOUNT_BY_PUBLIC_KEY_HASH	21

⚙ MSG_ACCOUNT_BY_PUBLIC_KEY_HASH

Constant	Type
MSG_ACCOUNT_BY_PUBLIC_KEY_HASH	22

⚙ MSG_GET_VALIDATOR_NODE_BY_ADDRESS

Constant	Type
MSG_GET_VALIDATOR_NODE_BY_ADDRESS	23

⚙ MSG_VALIDATOR_NODE_BY_ADDRESS

Constant	Type
MSG_VALIDATOR_NODE_BY_ADDRESS	24

⚙ MSG_GET_OBJECT_LIST

Constant	Type
MSG_GET_OBJECT_LIST	25

⚙ MSG_OBJECT_LIST

Constant	Type
MSG_OBJECT_LIST	26

⚙ MSG_GET_GENESIS_SNAPSHOT

Constant	Type
MSG_GET_GENESIS_SNAPSHOT	27

⚙ MSG_GENESIS_SNAPSHOT

Constant	Type
MSG_GENESIS_SNAPSHOT	28

⚙ NODE_MESSAGES

Constant	Type
NODE_MESSAGES	Schema[]

⚙ WI_MAX_SERVER_URL_LENGTH

Constant	Type
WI_MAX_SERVER_URL_LENGTH	100

⚙ WI_QR_CODE

Constant	Type
WI_QR_CODE	Schema

⚙ WIMSG_REQUEST

Constant	Type
WIMSG_REQUEST	0

⚙ WIMSG_UPDATE_QR

Constant	Type
WIMSG_UPDATE_QR	1

⚙ WIMSG_CONNECTION_TOKEN

Constant	Type
WIMSG_CONNECTION_TOKEN	2

⚙ WIMSG_FORWARDED_ANSWER

Constant	Type
WIMSG_FORWARDED_ANSWER	3

⚙ WIMSG_GET_CONNECTION_INFO

Constant	Type
WIMSG_GET_CONNECTION_INFO	4

⚙ WIMSG_ANSWER

Constant	Type
WIMSG_ANSWER	5

⚙ WIMSG_CONNECTION_INFO

Constant	Type
WIMSG_CONNECTION_INFO	6

⚙ WIMSG_CONNECTION_ACCEPTED

Constant	Type
WIMSG_CONNECTION_ACCEPTED	7

⚙ WIMSG_FORWARDED_REQUEST

Constant	Type
WIMSG_FORWARDED_REQUEST	8

⚙ WI_MESSAGES

Constant	Type
WI_MESSAGES	Schema[]

⚙ WIRQ_AUTH_BY_PUBLIC_KEY

Constant	Type
WIRQ_AUTH_BY_PUBLIC_KEY	0

⚙ WIRQ_DATA_APPROVAL

Constant	Type
WIRQ_DATA_APPROVAL	1

⚙ WIRQ_GET_EMAIL

Constant	Type
WIRQ_GET_EMAIL	2

⚙ WIRQ_GET_USER_DATA

Constant	Type
WIRQ_GET_USER_DATA	3

⚙ WI_REQUESTS

Constant	Type
WI_REQUESTS	Schema[]

⚙ WI_ANSWERS

Constant	Type
WI_ANSWERS	Schema[]

⚙ MSG_ANS_ERROR

Constant	Type
MSG_ANS_ERROR	0

⚙ MSG_APPROVAL_HANDSHAKE

Constant	Type
MSG_APPROVAL_HANDSHAKE	1

⚙ MSG_ACTOR_KEY

Constant	Type
MSG_ACTOR_KEY	2

⚙ MSG_APPROVAL_SIGNATURE

Constant	Type
MSG_APPROVAL_SIGNATURE	3

⚙ MSG_ANS_ACTOR_KEY_REQUIRED

Constant	Type
MSG_ANS_ACTOR_KEY_REQUIRED	4

⚙ MSG_ANS_APPROVAL_DATA

Constant	Type
MSG_ANS_APPROVAL_DATA	5

⚙ MSG_ANS_APPROVAL_SIGNATURE

Constant	Type
MSG_ANS_APPROVAL_SIGNATURE	6

⚙ WALLET_OP_MESSAGES

Constant	Type
WALLET_OP_MESSAGES	Schema[]

⚙ ALL_SCHEMAS

Constant	Type
ALL_SCHEMAS	{ singles: Schema[]; collections: { label: string; list: Schema[]; }[]; }

⚙ TOKEN_NAME

Constant	Type
TOKEN_NAME	"CMTS"

⚙ TOKEN

Constant	Type
TOKEN	100000

⚙ CENTITOKEN

Constant	Type
CENTITOKEN	1000

⚙ MILLITOKEN

Constant	Type
MILLITOKEN	100

⚙ INITIAL_OFFER

Constant	Type
INITIAL_OFFER	number

⚙ MINIMUM_GAS_PRICE

Constant	Type
MINIMUM_GAS_PRICE	1

⚙ MAXIMUM_GAS_PRICE

Constant	Type
MAXIMUM_GAS_PRICE	number

⚙ FIXED_GAS_FEE

Constant	Type
FIXED_GAS_FEE	1000

⚙ GAS_PER_BYTE

Constant	Type
GAS_PER_BYTE	1

⚙ GAS_UNIT

Constant	Type
GAS_UNIT	1000

⚙ BK_PLUS

Constant	Type
BK_PLUS	1

⚙ BK_PAID_TX_FEES

Constant	Type
BK_PAID_TX_FEES	0

⚙ BK_PAID_BLOCK_FEES

Constant	Type
BK_PAID_BLOCK_FEES	2

⚙ BK_SENT_ISSUANCE

Constant	Type
BK_SENT_ISSUANCE	4

⚙ BK_SALE

Constant	Type
BK_SALE	6

⚙ BK_SENT_PAYMENT

Constant	Type
BK_SENT_PAYMENT	8

⚙ BK_EARNED_TX_FEES

Constant	Type
BK_EARNED_TX_FEES	number

⚙ BK_EARNED_BLOCK_FEES

Constant	Type
BK_EARNED_BLOCK_FEES	number

⚙ BK_RECEIVED_ISSUANCE

Constant	Type
BK_RECEIVED_ISSUANCE	number

⚙ BK_PURCHASE

Constant	Type
BK_PURCHASE	number

⚙ BK_RECEIVED_PAYMENT

Constant	Type
BK_RECEIVED_PAYMENT	number

⚙ BK_REF_BLOCK

Constant	Type
BK_REF_BLOCK	0

⚙ BK_REF_MICROBLOCK

Constant	Type
BK_REF_MICROBLOCK	1

⚙ BK_REF_SECTION

Constant	Type
BK_REF_SECTION	2

⚙ BK_REFERENCES

Constant	Type
BK_REFERENCES	number[]

⚙ BK_NAMES

Constant	Type
BK_NAMES	string[]

⚙ ACCOUNT_BURNT_TOKENS

Constant	Type
ACCOUNT_BURNT_TOKENS	0

⚙ ACCOUNT_STANDARD

Constant	Type
ACCOUNT_STANDARD	1

⚙ ACCOUNT_BLOCK_FEES

Constant	Type
ACCOUNT_BLOCK_FEES	2

⚙ ACCOUNT_LOCKED_TOKENS

Constant	Type
ACCOUNT_LOCKED_TOKENS	3

⚙ ACCOUNT_NAMES

Constant	Type
ACCOUNT_NAMES	string[]

⚙ ACCOUNT_ALLOWED_TRANSFERS

Constant	Type
ACCOUNT_ALLOWED_TRANSFERS	number[]

⚙ ZERO

Constant	Type
ZERO	0

⚙ ONE

Constant	Type
ONE	1

⚙ AT_LEAST_ONE

Constant	Type
AT_LEAST_ONE	2

⚙ AT_MOST_ONE

Constant	Type
AT_MOST_ONE	3

⚙ ANY

Constant	Type
ANY	4

⚙ CONSTRAINT_NAMES

Constant	Type
CONSTRAINT_NAMES	string[]

⚙ ACCOUNT_SIG_ALGORITHM

Constant	Type
ACCOUNT_SIG_ALGORITHM	SectionType.ACCOUNT_SIG_ALGORITHM

⚙ ACCOUNT_PUBLIC_KEY

Constant	Type
ACCOUNT_PUBLIC_KEY	SectionType.ACCOUNT_PUBLIC_KEY

⚙ ACCOUNT_TOKEN_ISSUANCE

Constant	Type
ACCOUNT_TOKEN_ISSUANCE	SectionType.ACCOUNT_TOKEN_ISSUANCE

⚙ ACCOUNT_CREATION

Constant	Type
ACCOUNT_CREATION	SectionType.ACCOUNT_CREATION

⚙ ACCOUNT_TRANSFER

Constant	Type
ACCOUNT_TRANSFER	SectionType.ACCOUNT_TRANSFER

⚙ ACCOUNT_SIGNATURE

Constant	Type
ACCOUNT_SIGNATURE	SectionType.ACCOUNT_SIGNATURE

⚙ VN_SIG_ALGORITHM

Constant	Type
VN_SIG_ALGORITHM	0

⚙ VN_DECLARATION

Constant	Type
VN_DECLARATION	1

⚙ VN_DESCRIPTION

Constant	Type
VN_DESCRIPTION	2

⚙ VN_RPC_ENDPOINT

Constant	Type
VN_RPC_ENDPOINT	3

⚙ VN_NETWORK_INTEGRATION

Constant	Type
VN_NETWORK_INTEGRATION	4

⚙ VN_SIGNATURE

Constant	Type
VN_SIGNATURE	5

⚙ ORG_SIG_ALGORITHM

Constant	Type
ORG_SIG_ALGORITHM	SectionType.ORG_SIG_ALGORITHM

⚙ ORG_PUBLIC_KEY

Constant	Type
ORG_PUBLIC_KEY	SectionType.ORG_PUBLIC_KEY

⚙ ORG_DESCRIPTION

Constant	Type
ORG_DESCRIPTION	SectionType.ORG_DESCRIPTION

⚙ ORG_SERVER

Constant	Type
ORG_SERVER	SectionType.ORG_SERVER

⚙ ORG_SIGNATURE

Constant	Type
ORG_SIGNATURE	SectionType.ORG_SIGNATURE

⚙ APP_SIG_ALGORITHM

Constant	Type
APP_SIG_ALGORITHM	SectionType.APP_SIG_ALGORITHM

⚙ APP_DECLARATION

Constant	Type
APP_DECLARATION	SectionType.APP_DECLARATION

⚙ APP_DESCRIPTION

Constant	Type
APP_DESCRIPTION	SectionType.APP_DESCRIPTION

⚙ APP_SIGNATURE

Constant	Type
APP_SIGNATURE	SectionType.APP_SIGNATURE

⚙ APP_LEDGER_SIG_ALGORITHM

Constant	Type
APP_LEDGER_SIG_ALGORITHM	SectionType.APP_LEDGER_SIG_ALGORITHM

⚙ APP_LEDGER_PKE_ALGORITHM

Constant	Type
APP_LEDGER_PKE_ALGORITHM	SectionType.APP_LEDGER_PKE_ALGORITHM

⚙ APP_LEDGER_DECLARATION

Constant	Type
APP_LEDGER_DECLARATION	SectionType.APP_LEDGER_DECLARATION

⚙ APP_LEDGER_ACTOR_CREATION

Constant	Type
APP_LEDGER_ACTOR_CREATION	SectionType.APP_LEDGER_ACTOR_CREATION

⚙ APP_LEDGER_CHANNEL_CREATION

Constant	Type
APP_LEDGER_CHANNEL_CREATION	SectionType.APP_LEDGER_CHANNEL_CREATION

⚙ APP_LEDGER_SHARED_SECRET

Constant	Type
APP_LEDGER_SHARED_SECRET	SectionType.APP_LEDGER_SHARED_SECRET

⚙ APP_LEDGER_CHANNEL_INVITATION

Constant	Type
APP_LEDGER_CHANNEL_INVITATION	SectionType.APP_LEDGER_CHANNEL_INVITATION

⚙ APP_LEDGER_ACTOR_SUBSCRIPTION

Constant	Type
APP_LEDGER_ACTOR_SUBSCRIPTION	SectionType.APP_LEDGER_ACTOR_SUBSCRIPTION

⚙ APP_LEDGER_PUBLIC_CHANNEL_DATA

Constant	Type
APP_LEDGER_PUBLIC_CHANNEL_DATA	SectionType.APP_LEDGER_PUBLIC_CHANNEL_DATA

⚙ APP_LEDGER_PRIVATE_CHANNEL_DATA

Constant	Type
APP_LEDGER_PRIVATE_CHANNEL_DATA	SectionType.APP_LEDGER_PRIVATE_CHANNEL_DATA

⚙ APP_LEDGER_AUTHOR

Constant	Type
APP_LEDGER_AUTHOR	SectionType.APP_LEDGER_AUTHOR

⚙ APP_LEDGER_ENDORSER

Constant	Type
APP_LEDGER_ENDORSER	SectionType.APP_LEDGER_ENDORSER

⚙ APP_LEDGER_ENDORSER_SIGNATURE

Constant	Type
APP_LEDGER_ENDORSER_SIGNATURE	SectionType.APP_LEDGER_ENDORSER_SIGNATURE

⚙ APP_LEDGER_AUTHOR_SIGNATURE

Constant	Type
APP_LEDGER_AUTHOR_SIGNATURE	SectionType.APP_LEDGER_AUTHOR_SIGNATURE

⚙ ALL_SECTIONS_SCHEMAS

Constant	Type
ALL_SECTIONS_SCHEMAS	{ [x: number]: Schema; length: number; toString(): string; toLocaleString(): string; toLocaleString(locales: string or string[], options?: (NumberFormatOptions and DateTimeFormatOptions) or undefined): string; ... 30 more ...; [Symbol.unscopables]: { ...; }; }

⚙ DEF

Constant	Type
DEF	Schema[][]

⚙ WI_INVALID_SIGNATURE

Constant	Type
WI_INVALID_SIGNATURE	0

⚙ Utf8Encoder

Constant	Type
Utf8Encoder	{ encode: (str: any) => Uint8Array<ArrayBuffer>; decode: (array: any) => string; }

⚙ Utils

Constant	Type
Utils	{ numberToHexa: (value: number, size?: number or undefined) => string; truncateString: (str: string, size: number) => string; truncateStringMiddle: (str: string, leadingSize: number, trailingSize: number) => string; ... 14 more ...; getGenesisEpochInTimestamp: () => number; }

⚙ Random

Constant	Type
Random	{ getBytes: (n: any) => Uint8Array<ArrayBufferLike>; getInteger: (max: any) => number; getKey256: () => string; }

⚙ Hashes

Constant	Type
Hashes	{ sha256AsBinary: (data: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>; sha256: (data: Uint8Array<ArrayBufferLike>) => string; sha512AsBinary: (data: any) => Uint8Array<...>; sha512: (data: any) => string; }

⚙ Aes

Constant	Type
Aes	{ encryptGcm: (key: any, data: any, iv: any) => Uint8Array<ArrayBufferLike>; decryptGcm: (key: any, data: any, iv: any) => false or Uint8Array<ArrayBufferLike>; }

⚙ MLDsa

Constant	Type
MLDsa	{ generateKeyPair: (seed: any) => { publicKey: Uint8Array<ArrayBufferLike>; privateKey: Uint8Array<ArrayBufferLike>; }; sign: (privateKey: any, data: any) => Uint8Array<...>; verify: (publicKey: any, data: any, signature: any) => boolean; }

⚙ MLKem

Constant	Type
MLKem	{ generateKeyPair: (seed: any) => { publicKey: Uint8Array<ArrayBufferLike>; secretKey: Uint8Array<ArrayBufferLike>; }; encapsulate: (publicKey: any) => { ...; }; decapsulate: (cipherText: any, privateKey: any) => Uint8Array<...>; }

⚙ Secp256k1

Constant	Type
Secp256k1	{ publicKeyFromPrivateKey: (privateKey: any) => Bytes; sign: (privateKey: any, data: any) => Bytes; verify: (publicKey: any, data: any, signature: any) => boolean; }

⚙ Crypto

Constant	Type
Crypto	{ KEM_ALGORITHMS: { name: string; }[]; Random: { getBytes: (n: any) => Uint8Array<ArrayBufferLike>; getInteger: (max: any) => number; getKey256: () => string; }; Hashes: { ...; }; ... 7 more ...; ML_DSA: number; }

⚙ BlockchainUtils

Constant	Type
BlockchainUtils	{ checkHeaderList: (headers: any) => { valid: boolean; hashes: never[]; }; previousHashFromHeader: (header: any) => any; decodeMicroblockHeader: (data: Uint8Array<ArrayBufferLike>) => MicroBlockHeaderDto; ... 5 more ...; decodeVirtualBlockchainCustomState: (type: number, data: Uint8Array<...>) => object; }

⚙ PathManager

Constant	Type
PathManager	{ parsePrefix: (pathString: any) => { prefix: string; pathString: any; }; toNumericPath: (irObject: any, pathString: any) => never[]; fromNumericPath: (irObject: any, numericPath: any) => string; processCallback: (irObject: any, pathString: any, callback: any) => void; fromParents: (parents: any) => string; }

⚙ MaskManager

Constant	Type
MaskManager	{ getListFromRegex: (str: any, regex: any, substitution: any) => any; applyMask: (str: any, list: any) => { visible: any; hidden: any; }; getVisibleText: (visible: any) => any; getFullText: (visible: any, hidden: any) => any; }

⚙ RPCNodeStatusResponseSchema

Constant	Type
RPCNodeStatusResponseSchema	ZodObject<{ jsonrpc: ZodLiteral<"2.0">; id: ZodNumber; result: ZodObject<{ node_info: ZodObject<{ protocol_version: ZodObject<{ p2p: ZodString; block: ZodString; app: ZodString; }, "strip", ZodTypeAny, { ...; }, { ...; }>; ... 6 more ...; other: ZodObject<...>; }, "strip", ZodTypeAny, { ...; }, { ...; }>; sync_info:...

⚙ Base64

Constant	Type
Base64	{ BASE64: string; URL: string; encodeString: (str: any, alphabet?: string, padding?: boolean) => string; decodeString: (str: any, alphabet?: string) => string; encodeBinary: (bin: any, alphabet?: string, padding?: boolean) => string; decodeBinary: (str: any, alphabet?: string) => Uint8Array<...>; }

⚙ Economics

Constant	Type
Economics	{ getAccountTypeFromIdentifier: (accountIdentifier: Uint8Array<ArrayBufferLike>) => number; getSpecialAccountTypeIdentifier: (type: number) => Uint8Array<...>; isAllowedTransfer: (accountType: number, transferType: number) => number; }

⚙ NewBlockEventSchema

Constant	Type
NewBlockEventSchema	ZodObject<{ jsonrpc: ZodLiteral<"2.0">; id: ZodNumber; result: ZodObject<{ query: ZodString; data: ZodObject<{ type: ZodLiteral<"tendermint/event/NewBlock">; value: ZodObject<...>; }, "strip", ZodTypeAny, { ...; }, { ...; }>; events: ZodObject<...>; }, "strip", ZodTypeAny, { ...; }, { ...; }>; }, "strip", ZodTypeAny...

⚙ RADIX_CST

Constant	Type
RADIX_CST	{ CACHE_HORIZON: number; HASH_SIZE: number; ROOT_ANCHORING_HASH: Uint8Array<ArrayBuffer>; }

⚙ RadixUtils

Constant	Type
RadixUtils	{ keyDifference: (depth: any, key: any, node: any) => 0 or 1; getHashList: (msk: any, node: any) => never[]; }

⚙ RadixChecker

Constant	Type
RadixChecker	{ verifyProof: (key: any, value: any, proof: any) => Promise<any>; }

🏭 EncoderFactory

EncoderFactory is a class responsible for providing encoder instances. It contains static utility methods to create and retrieve encoders for specific purposes.

Static Methods

• defaultBytesToStringEncoder
• bytesToBase64Encoder
• bytesToHexEncoder

⚙ defaultBytesToStringEncoder

Provides the default encoder for converting Uint8Array bytes to a hexadecimal string representation.

Method	Type
defaultBytesToStringEncoder	() => EncoderInterface<Uint8Array<ArrayBufferLike>, string>

⚙ bytesToBase64Encoder

Provides an encoder for converting Uint8Array bytes to a base64 string representation.

Method	Type
bytesToBase64Encoder	() => EncoderInterface<Uint8Array<ArrayBufferLike>, string>

⚙ bytesToHexEncoder

Retrieves an encoder instance that converts bytes (Uint8Array) into a hexadecimal string representation.

Method	Type
bytesToHexEncoder	() => EncoderInterface<Uint8Array<ArrayBufferLike>, string>

🏭 BytesToBase64Encoder

A class that implements an encoder to convert between byte arrays (Uint8Array) and base64 string representations. It provides methods for both encoding byte arrays to base64 strings and decoding base64 strings back to byte arrays.

This class adheres to the EncoderInterface interface, parameterized with Uint8Array for the input/output data type and string for the encoded format.

Methods:

• encode: Converts a given Uint8Array into its base64 string equivalent.
• decode: Converts a base64 string back into a Uint8Array representation.

Methods

• decode
• encode

⚙ decode

Decodes a base64 string into a Uint8Array.

Method	Type
decode	(data: string) => Uint8Array<ArrayBufferLike>

Parameters:

• data: The base64 string to decode.

⚙ encode

Encodes the given Uint8Array data into a base64 string representation.

Method	Type
encode	(data: Uint8Array<ArrayBufferLike>) => string

Parameters:

• data: - The byte array to be encoded.

🏭 BytesToHexEncoder

A class that implements an encoder to convert between byte arrays (Uint8Array) and hexadecimal string representations. It provides methods for both encoding byte arrays to hex strings and decoding hex strings back to byte arrays.

This class adheres to the EncoderInterface interface, parameterized with Uint8Array for the input/output data type and string for the encoded format.

Methods:

• encode: Converts a given Uint8Array into its hexadecimal string equivalent.
• decode: Converts a hexadecimal string back into a Uint8Array representation.

Methods

• decode
• encode

⚙ decode

Decodes a hexadecimal string into a Uint8Array.

Method	Type
decode	(data: string) => Uint8Array<ArrayBufferLike>

Parameters:

• data: The hexadecimal string to decode.

⚙ encode

Encodes the given Uint8Array data into a hexadecimal string representation.

Method	Type
encode	(data: Uint8Array<ArrayBufferLike>) => string

Parameters:

• data: - The byte array to be encoded.

🏭 BasePrivateSignatureKey

Abstract base class representing a private signature key. It provides methods for retrieving the private key, generating signatures, and accessing associated metadata and functionalities related to the signature scheme.

Methods

• getPrivateKeyAsString
• getSignatureAlgorithmId
• getSignatureSize

⚙ getPrivateKeyAsString

Method	Type
getPrivateKeyAsString	(encoder?: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

⚙ getSignatureAlgorithmId

Method	Type
getSignatureAlgorithmId	() => SignatureAlgorithmId

⚙ getSignatureSize

Method	Type
getSignatureSize	() => number

🏭 BasePublicSignatureKey

Abstract class representing the base implementation of a public signature key. This class provides a partial implementation for handling public keys and signing operations. It serves as a foundation for specific public signature key implementations.

Methods

• getPublicKeyAsString
• getSignatureSize
• getSignatureAlgorithmId

⚙ getPublicKeyAsString

Method	Type
getPublicKeyAsString	(encoder?: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

⚙ getSignatureSize

Method	Type
getSignatureSize	() => number

⚙ getSignatureAlgorithmId

Method	Type
getSignatureAlgorithmId	() => SignatureAlgorithmId

🏭 AES256GCMSymmetricEncryptionScheme

Methods

• getSymmetricEncryptionSchemeId
• getSupportedKeyLengths
• getDefaultKeyLength

⚙ getSymmetricEncryptionSchemeId

Method	Type
getSymmetricEncryptionSchemeId	() => number

⚙ getSupportedKeyLengths

Method	Type
getSupportedKeyLengths	() => number[]

⚙ getDefaultKeyLength

Method	Type
getDefaultKeyLength	() => number

🏭 AES256GCMSymmetricEncryptionKey

This class provides methods for creating, managing, and utilizing a symmetric encryption key specifically designed for AES-256-GCM encryption. It implements the SymmetricEncryptionKey interface, enabling compatibility with other cryptographic operations requiring symmetric key encryption.

AES-256-GCM (Advanced Encryption Standard with 256-bit keys in Galois/Counter Mode) ensures high-level cryptographic security with authenticated encryption, combining data confidentiality with integrity protection.

Static Methods

• generate
• createFromBytes

⚙ generate

Generates a new AES-256-GCM symmetric encryption key.

Method	Type
generate	() => AES256GCMSymmetricEncryptionKey

⚙ createFromBytes

Creates an instance of AES256GCMSymmetricEncryptionKey from the given byte array.

Method	Type
createFromBytes	(keyBytes: Uint8Array<ArrayBufferLike>) => AES256GCMSymmetricEncryptionKey

Parameters:

• keyBytes: - The byte array representing the encryption key.

Methods

• getRawSecretKey
• getSymmetricEncryptionSchemeId
• encrypt
• decrypt

⚙ getRawSecretKey

Retrieves the raw secret key as a Uint8Array. This method provides access to the underlying key data stored in this instance.

Method	Type
getRawSecretKey	() => Uint8Array<ArrayBufferLike>

⚙ getSymmetricEncryptionSchemeId

Retrieves the identifier of the encryption algorithm being used.

Method	Type
getSymmetricEncryptionSchemeId	() => number

⚙ encrypt

Encrypts the given plaintext using AES-GCM encryption. A random initialization vector (IV) is generated for each encryption operation. The result is a concatenation of the IV and the encrypted ciphertext.

Method	Type
encrypt	(plaintext: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

Parameters:

• plaintext: - The plaintext data to be encrypted.

⚙ decrypt

Decrypts the provided ciphertext using the GCM block cipher mode with the instance's key.

Method	Type
decrypt	(ciphertext: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

Parameters:

• ciphertext: - The encrypted data to be decrypted. The first 12 bytes are assumed to be the initialization vector (IV), and the rest is the encrypted content.

🏭 ExtendedSymmetricEncryptionKey

A class that extends the functionality of a symmetric encryption key. This class enables encryption and decryption of strings, while delegating the underlying encryption and decryption operations to a wrapped key.

Methods

• encryptString
• decryptString
• getSymmetricEncryptionSchemeId
• encrypt
• decrypt
• getRawSecretKey

⚙ encryptString

Encrypts a given plaintext string and returns the encrypted data as a Base64-encoded string.

Method	Type
encryptString	(plaintext: string) => string

Parameters:

• plaintext: - The plain text string to be encrypted.

⚙ decryptString

Decrypts a given string that is encoded in Base64 format.

Method	Type
decryptString	(ciphertext: string) => string

Parameters:

• ciphertext: The Base64 encoded string to be decrypted.

⚙ getSymmetricEncryptionSchemeId

Retrieves the identifier of the encryption algorithm used.

Method	Type
getSymmetricEncryptionSchemeId	() => number

⚙ encrypt

Encrypts the given plaintext using the wrapped key.

Method	Type
encrypt	(plaintext: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

Parameters:

• plaintext: - The data to be encrypted.

⚙ decrypt

Decrypts the provided ciphertext using the wrapped key.

Method	Type
decrypt	(ciphertext: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

Parameters:

• ciphertext: - The ciphertext to be decrypted.

⚙ getRawSecretKey

Retrieves the raw secret key from the wrapped key.

Method	Type
getRawSecretKey	() => Uint8Array<ArrayBufferLike>

🏭 MLDSA65SignatureScheme

Methods

• getSignatureAlgorithmId
• getSignatureSize

⚙ getSignatureAlgorithmId

Method	Type
getSignatureAlgorithmId	() => number

⚙ getSignatureSize

Method	Type
getSignatureSize	() => number

🏭 MLDSA65PublicSignatureKey

Represents a public signature key for the MLDSA65 signature scheme.

This class provides functionalities to verify digital signatures and retrieve the raw public key used in the signing process. It extends the MLDSA44SignatureScheme and implements the PublicSignatureKey interface.

Constructors

public: Constructs an instance of the class.

Parameters:

• publicKey: - The public key used for initialization.

Methods

• getPublicKeyAsString
• verify
• getPublicKeyAsBytes
• getScheme

⚙ getPublicKeyAsString

Method	Type
getPublicKeyAsString	(encoder?: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

⚙ verify

Verifies the provided data and its signature using the stored public key.

Method	Type
verify	(data: Uint8Array<ArrayBufferLike>, signature: Uint8Array<ArrayBufferLike>) => boolean

Parameters:

• data: - The data to be verified.
• signature: - The signature of the data to be verified.

⚙ getPublicKeyAsBytes

Retrieves the raw public key as a Uint8Array.

Method	Type
getPublicKeyAsBytes	() => Uint8Array<ArrayBufferLike>

⚙ getScheme

Method	Type
getScheme	() => SignatureScheme

🏭 MLDSA65PrivateSignatureKey

Represents a private signature key for the MLDSA65 signature scheme.

Constructors

public: Constructs a new instance of the class, initializes the public and private keys using the provided seed value.

Parameters:

• seed: - The seed value used to generate key pairs.

Static Methods

• gen

⚙ gen

Generates and returns a new private signature key.

This method creates a private signature key instance using a randomly generated 32-byte seed.

Method	Type
gen	() => MLDSA65PrivateSignatureKey

Methods

• getPrivateKeyAsString
• getPublicKey
• getPrivateKeyAsBytes
• sign
• getScheme

⚙ getPrivateKeyAsString

Method	Type
getPrivateKeyAsString	(encoder: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

⚙ getPublicKey

Retrieves the public signature key associated with this instance.

Method	Type
getPublicKey	() => MLDSA65PublicSignatureKey

⚙ getPrivateKeyAsBytes

Method	Type
getPrivateKeyAsBytes	() => Uint8Array<ArrayBufferLike>

⚙ sign

Signs the provided data using the signature key.

Method	Type
sign	(data: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

Parameters:

• data: - The data to be signed.

⚙ getScheme

Method	Type
getScheme	() => SignatureScheme

🏭 Sha256CryptographicHash

Methods

• getHashSchemeId
• hash

⚙ getHashSchemeId

Method	Type
getHashSchemeId	() => CryptographicHashAlgorithmId

⚙ hash

Method	Type
hash	(data: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

🏭 Secp256k1SignatureScheme

The Secp256k1SignatureScheme class implements the SignatureScheme interface and provides functionality specific to the Secp256k1 elliptic curve cryptographic signature scheme.

Methods

• getSignatureAlgorithmId
• getSignatureSize

⚙ getSignatureAlgorithmId

Method	Type
getSignatureAlgorithmId	() => number

⚙ getSignatureSize

Method	Type
getSignatureSize	() => number

🏭 Secp256k1PublicSignatureKey

A class representing a Secp256k1 public signature key. This class is responsible for handling the public key operations such as retrieving the raw public key and verifying signatures against specified data.

This class extends the Secp256k1SignatureScheme and implements the PublicSignatureKey interface.

Methods

• getPublicKeyAsBytes
• verify
• getScheme

⚙ getPublicKeyAsBytes

Method	Type
getPublicKeyAsBytes	() => Uint8Array<ArrayBufferLike>

⚙ verify

Method	Type
verify	(data: Uint8Array<ArrayBufferLike>, signature: Uint8Array<ArrayBufferLike>) => boolean

⚙ getScheme

Method	Type
getScheme	() => SignatureScheme

🏭 Secp256k1PrivateSignatureKey

Represents a private signature key using the Secp256k1 curve. This class extends from Secp256k1PublicSignatureKey and implements the PrivateSignatureKey interface. It provides functionality to generate a private key, derive its corresponding public key, and sign data.

Methods enable key generation, retrieving the associated public key, and signing cryptographic hashes.

Static Methods

• gen
• genFromSeed

⚙ gen

Generates and returns a new instance of Secp256k1PrivateSignatureKey initialized with a randomly generated private key.

Method	Type
gen	() => Secp256k1PrivateSignatureKey

⚙ genFromSeed

Generates a Secp256k1 private signature key from a given seed.

Method	Type
genFromSeed	(seed: Uint8Array<ArrayBufferLike>) => Secp256k1PrivateSignatureKey

Parameters:

• seed: - The seed used to generate the private key.

Methods

• getPrivateKeyAsString
• getPublicKey
• getPrivateKeyAsBytes
• sign
• getScheme

⚙ getPrivateKeyAsString

Method	Type
getPrivateKeyAsString	(encoder: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

⚙ getPublicKey

Method	Type
getPublicKey	() => PublicSignatureKey

⚙ getPrivateKeyAsBytes

Method	Type
getPrivateKeyAsBytes	() => Uint8Array<ArrayBufferLike>

⚙ sign

Method	Type
sign	(data: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ getScheme

Method	Type
getScheme	() => SignatureScheme

🏭 PasswordBasedKeyDerivationFunction

Methods

• deriveKeyNoSalt

⚙ deriveKeyNoSalt

Method	Type
deriveKeyNoSalt	(password: string, keyLength: number) => Uint8Array<ArrayBufferLike>

🏭 PBKDF2

Methods

• getKeyDerivationFunctionAlgorithmId
• deriveKey

⚙ getKeyDerivationFunctionAlgorithmId

Method	Type
getKeyDerivationFunctionAlgorithmId	() => PasswordBasedKeyDerivationFunctionAlgorithmId

⚙ deriveKey

Method	Type
deriveKey	(password: string, salt: string, keyLength: number) => Uint8Array<ArrayBufferLike>

🏭 KeyDerivationFunction

Methods

• deriveKeyNoSalt

⚙ deriveKeyNoSalt

Method	Type
deriveKeyNoSalt	(inputKeyingMaterial: Uint8Array<ArrayBufferLike>, info: Uint8Array<ArrayBufferLike>, keyLength: number) => Uint8Array<...>

🏭 HKDF

Methods

• getKeyDerivationFunctionAlgorithmId
• deriveKey

⚙ getKeyDerivationFunctionAlgorithmId

Method	Type
getKeyDerivationFunctionAlgorithmId	() => KeyDerivationFunctionAlgorithmId

⚙ deriveKey

Method	Type
deriveKey	(inputKeyingMaterial: Uint8Array<ArrayBufferLike>, salt: Uint8Array<ArrayBufferLike>, info: Uint8Array<ArrayBufferLike>, keyLength: number) => Uint8Array<...>

🏭 AbstractPublicKeyEncryptionScheme

🏭 AbstractPublicEncryptionKey

Methods

• encode
• getSchemeId

⚙ encode

Method	Type
encode	(encoder?: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

⚙ getSchemeId

Method	Type
getSchemeId	() => PublicKeyEncryptionAlgorithmId

🏭 AbstractPrivateDecryptionKey

Methods

• encode

⚙ encode

Method	Type
encode	(encoder?: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

🏭 MlKemPublicKeyEncryptionScheme

Methods

• getSchemeId
• getSupportedSeedLength

⚙ getSchemeId

Returns the identifier of the scheme.

Method	Type
getSchemeId	() => PublicKeyEncryptionAlgorithmId

⚙ getSupportedSeedLength

Method	Type
getSupportedSeedLength	() => number[]

🏭 MlKemCiphertextEncoder

Methods

• encode
• decode

⚙ encode

Method	Type
encode	(encryptedSharedSecret: Uint8Array<ArrayBufferLike>, encryptedMessage: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ decode

Method	Type
decode	(ciphertext: Uint8Array<ArrayBufferLike>) => MlKemCiphertextType

🏭 MlKemPublicEncryptionKey

Methods

• encrypt
• getRawPublicKey
• getScheme

⚙ encrypt

Method	Type
encrypt	(message: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ getRawPublicKey

Method	Type
getRawPublicKey	() => Uint8Array<ArrayBufferLike>

⚙ getScheme

Method	Type
getScheme	() => AbstractPublicKeyEncryptionScheme

🏭 MlKemPrivateDecryptionKey

Static Methods

• genFromSeed
• gen

⚙ genFromSeed

Generates a private decryption key from a seed.

Method	Type
genFromSeed	(seed: Uint8Array<ArrayBufferLike>) => MlKemPrivateDecryptionKey

⚙ gen

Generates a random private decryption key.

Method	Type
gen	() => MlKemPrivateDecryptionKey

Methods

• getSupportedSeedLength
• getScheme
• getPublicKey
• getRawPrivateKey
• decrypt

⚙ getSupportedSeedLength

Returns the supported seed lengths for the scheme.

Method	Type
getSupportedSeedLength	() => number[]

⚙ getScheme

Method	Type
getScheme	() => MlKemPublicKeyEncryptionScheme

⚙ getPublicKey

Method	Type
getPublicKey	() => MlKemPublicEncryptionKey

⚙ getRawPrivateKey

Method	Type
getRawPrivateKey	() => Uint8Array<ArrayBufferLike>

⚙ decrypt

Method	Type
decrypt	(ciphertext: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

🏭 CryptoSchemeFactory

Static Methods

• createPrivateSignatureKey
• createVirtualBlockchainPrivateSignature
• deriveKeyFromPassword
• createPublicSignatureKey
• createPublicEncryptionKey
• createPrivateDecryptionKey
• createSymmetricEncryptionKey
• createSymmetricEncryptionKeyScheme
• createCryptographicHash
• createDefaultCryptographicHash
• createDefaultPBKDF
• createDefaultKDF

⚙ createPrivateSignatureKey

Method	Type
createPrivateSignatureKey	(schemeId: number, seed: Uint8Array<ArrayBufferLike>) => PrivateSignatureKey

⚙ createVirtualBlockchainPrivateSignature

Method	Type
createVirtualBlockchainPrivateSignature	(kdf: KeyDerivationFunction, schemeId: SignatureAlgorithmId, walletSeed: Uint8Array<ArrayBufferLike>, vbSeed: Uint8Array<...>) => PrivateSignatureKey

⚙ deriveKeyFromPassword

Derives a symmetric encryption key from the provided password using the specified key derivation and encryption algorithms.

Method	Type
deriveKeyFromPassword	(password: string, pbkdfAlgorithmId?: PasswordBasedKeyDerivationFunctionAlgorithmId, symmetricEncryptionSchemeId?: SymmetricEncryptionAlgorithmId) => SymmetricEncryptionKey

Parameters:

• password: - The password from which the encryption key will be derived.
• pbkdfAlgorithmId: - The ID of the password-based key derivation function algorithm to use.
• symmetricEncryptionSchemeId: - The ID of the symmetric encryption algorithm to create the key for.

⚙ createPublicSignatureKey

Method	Type
createPublicSignatureKey	(schemeId: number, publicKey: Uint8Array<ArrayBufferLike>) => PublicSignatureKey

⚙ createPublicEncryptionKey

Method	Type
createPublicEncryptionKey	(schemeId: number, publicKey: Uint8Array<ArrayBufferLike>) => AbstractPublicEncryptionKey

⚙ createPrivateDecryptionKey

Method	Type
createPrivateDecryptionKey	(schemeId: number, privateKeyOrSeed: Uint8Array<ArrayBufferLike>) => AbstractPrivateDecryptionKey

⚙ createSymmetricEncryptionKey

Method	Type
createSymmetricEncryptionKey	(symmetricEncryptionSchemeId: number, rawKey: Uint8Array<ArrayBufferLike>) => SymmetricEncryptionKey

⚙ createSymmetricEncryptionKeyScheme

Method	Type
createSymmetricEncryptionKeyScheme	(symmetricEncryptionSchemeId: number) => SymmetricEncryptionKeyScheme

⚙ createCryptographicHash

Method	Type
createCryptographicHash	(schemeId: CryptographicHashAlgorithmId) => CryptographicHash

⚙ createDefaultCryptographicHash

Method	Type
createDefaultCryptographicHash	() => CryptographicHash

⚙ createDefaultPBKDF

Method	Type
createDefaultPBKDF	() => PasswordBasedKeyDerivationFunction

⚙ createDefaultKDF

Method	Type
createDefaultKDF	() => HKDF

Methods

• createVirtualBlockchainPrivateSignatureScheme
• createDecapsulationKey
• createVirtualBlockchainDecapsulationKey
• createPublicSignatureKey
• createSymmetricEncryptionKey

⚙ createVirtualBlockchainPrivateSignatureScheme

Method	Type
createVirtualBlockchainPrivateSignatureScheme	(schemeId: SignatureAlgorithmId, walletSeed: Uint8Array<ArrayBufferLike>, vbSeed: Uint8Array<ArrayBufferLike>) => PrivateSignatureKey

⚙ createDecapsulationKey

Method	Type
createDecapsulationKey	(schemeId: number, walletSeed: Uint8Array<ArrayBufferLike>) => DecapsulationKey

⚙ createVirtualBlockchainDecapsulationKey

Method	Type
createVirtualBlockchainDecapsulationKey	(schemeId: number, walletSeed: Uint8Array<ArrayBufferLike>, vbSeed: Uint8Array<ArrayBufferLike>) => DecapsulationKey

⚙ createPublicSignatureKey

Method	Type
createPublicSignatureKey	(schemeId: number, publicKey: Uint8Array<ArrayBufferLike>) => PublicSignatureKey

⚙ createSymmetricEncryptionKey

Creates a symmetric encryption key based on the provided encryption scheme ID and raw key data.

Method	Type
createSymmetricEncryptionKey	(symmetricEncryptionSchemeId: number, rawKey: Uint8Array<ArrayBufferLike>) => SymmetricEncryptionKey

Parameters:

• symmetricEncryptionSchemeId: - The ID of the symmetric encryption scheme to use.
• rawKey: - The raw key data used to create the symmetric encryption key.

🏭 HCVDecoded

HCVDecoded class represents the result of decoding an HCV string. It provides methods to access the keys and value, and to check if a given key sequence matches.

Constructors

public: Creates a new HCVDecoded instance.

Parameters:

• keys: - The list of keys from the decoded string
• value: - The value from the decoded string

Methods

• matchesKeys
• getKeys
• getValue

⚙ matchesKeys

Checks if the given keys match the keys in this decoded object.

Method	Type
matchesKeys	(...keys: string[]) => boolean

Parameters:

• keys: - The keys to check against

Returns:

True if the keys match, false otherwise

⚙ getKeys

Gets the list of keys from the decoded string.

Method	Type
getKeys	() => string[]

Returns:

The list of keys

⚙ getValue

Gets the value from the decoded string.

Method	Type
getValue	() => string

Returns:

The value

🏭 HCVCodec

HCVCodec (Hierarchical Context Value Codec) provides methods to encode and decode strings in the format key1:key2:...

.

Static Methods

• encode
• decode

⚙ encode

Encodes a list of keys and a value into a string in the format key1:key2:...

. The last parameter is treated as the value, and all preceding parameters are treated as keys.

Method	Type
encode	(...args: string[]) => string

Parameters:

• args: - The keys followed by the value (at least one key and one value)

Returns:

The encoded string

⚙ decode

Decodes a string in the format key1:key2:...

into an HCVDecoded object.

Method	Type
decode	(encoded: string) => HCVDecoded

Parameters:

• encoded: - The encoded string to decode

Returns:

An HCVDecoded object containing the keys and value

🏭 HCVSignatureEncoder

Static Methods

• createHexHCVSignatureEncoder
• createBase64HCVSignatureEncoder

⚙ createHexHCVSignatureEncoder

Method	Type
createHexHCVSignatureEncoder	() => HCVSignatureEncoder

⚙ createBase64HCVSignatureEncoder

Method	Type
createBase64HCVSignatureEncoder	() => HCVSignatureEncoder

Methods

• decodeMessage
• decodePrivateKey
• decodePublicKey
• decodeSignature
• encodeMessage
• encodePrivateKey
• encodePublicKey
• encodeSignature

⚙ decodeMessage

Decodes the provided message into a Uint8Array.

Method	Type
decodeMessage	(message: string) => Uint8Array<ArrayBufferLike>

⚙ decodePrivateKey

Decodes the provided private key and returns a private signature key object.

Method	Type
decodePrivateKey	(privateKey: string) => PrivateSignatureKey

⚙ decodePublicKey

Decodes a given public key object into a public signature key.

Method	Type
decodePublicKey	(publicKey: string) => PublicSignatureKey

⚙ decodeSignature

Decodes the provided signature into a Uint8Array.

Method	Type
decodeSignature	(signature: string) => Uint8Array<ArrayBufferLike>

⚙ encodeMessage

Encodes a given message into a specific format.

Method	Type
encodeMessage	(message: Uint8Array<ArrayBufferLike>) => string

⚙ encodePrivateKey

Encodes the given private key into a specific format.

Method	Type
encodePrivateKey	(privateKey: PrivateSignatureKey) => string

⚙ encodePublicKey

Encodes the given public signature key into a specific format.

Method	Type
encodePublicKey	(publicKey: PublicSignatureKey) => string

⚙ encodeSignature

Encodes a given digital signature into a specific format.

Method	Type
encodeSignature	(signature: Uint8Array<ArrayBufferLike>) => string

🏭 BytesSignatureEncoder

Class responsible for encoding and decoding digital signature-related data. Provides methods to convert signatures, public keys, and private keys between raw formats and serialized representations.

Methods

• encodeSignature
• decodeSignature
• encodeMessage
• decodeMessage
• encodePublicKey
• decodePublicKey
• encodePrivateKey
• decodePrivateKey

⚙ encodeSignature

Encodes a given digital signature into a specific format.

Method	Type
encodeSignature	(signature: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ decodeSignature

Decodes the provided signature into a Uint8Array.

Method	Type
decodeSignature	(signature: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ encodeMessage

Encodes a given message into a specific format.

Method	Type
encodeMessage	(message: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ decodeMessage

Decodes the provided message into a Uint8Array.

Method	Type
decodeMessage	(message: Uint8Array<ArrayBufferLike>) => Uint8Array<ArrayBufferLike>

⚙ encodePublicKey

Encodes the given public signature key into a specific format.

Method	Type
encodePublicKey	(publicKey: PublicSignatureKey) => Uint8Array<ArrayBufferLike>

⚙ decodePublicKey

Decodes a given public key object into a public signature key.

Method	Type
decodePublicKey	(publicKey: Uint8Array<ArrayBufferLike>) => PublicSignatureKey

⚙ encodePrivateKey

Encodes the given private key into a specific format.

Method	Type
encodePrivateKey	(privateKey: PrivateSignatureKey) => Uint8Array<ArrayBufferLike>

⚙ decodePrivateKey

Decodes the provided private key and returns a private signature key object.

Method	Type
decodePrivateKey	(privateKey: Uint8Array<ArrayBufferLike>) => PrivateSignatureKey

🏭 StringSignatureEncoder

The StringSignatureEncoder class provides encoding and decoding methods for public keys, private keys, and digital signatures. It acts as an intermediate layer, converting between string representations and their binary counterparts using a combination of a bytes encoder and another signature encoder.

Constructors

public: Constructs an instance of the class with the provided encoders.

Parameters:

• bytesEncoder: - The encoder used to encode or decode bytes.
• signatureEncoder: - The encoder used to handle signature encoding. Defaults to a new instance of BytesSignatureEncoder.

Static Methods

• defaultStringSignatureEncoder
• defaultBytesSignatureEncoder

⚙ defaultStringSignatureEncoder

Provides the default encoder for string signatures by utilizing the default bytes-to-string encoder from the EncoderFactory.

Method	Type
defaultStringSignatureEncoder	() => SignatureEncoderInterface<string>

⚙ defaultBytesSignatureEncoder

Method	Type
defaultBytesSignatureEncoder	() => BytesSignatureEncoder

Methods

• encodePublicKey
• decodePublicKey
• decodePrivateKey
• decodeSignature
• encodePrivateKey
• encodeSignature
• decodeMessage
• encodeMessage

⚙ encodePublicKey

Encodes a given public signature key into its string representation.

Method	Type
encodePublicKey	(publicKey: PublicSignatureKey) => string

Parameters:

• publicKey: - The public signature key to be encoded.

⚙ decodePublicKey

Decodes the provided public key string into a PublicSignatureKey object.

Method	Type
decodePublicKey	(publicKey: string) => PublicSignatureKey

Parameters:

• publicKey: - The public key string to be decoded.

⚙ decodePrivateKey

Decodes a given private key from its string representation to a PrivateSignatureKey object.

Method	Type
decodePrivateKey	(privateKey: string) => PrivateSignatureKey

Parameters:

• privateKey: - The private key in its encoded string format to be decoded.

⚙ decodeSignature

Decodes a given signature string into a Uint8Array.

Method	Type
decodeSignature	(signature: string) => Uint8Array<ArrayBufferLike>

Parameters:

• signature: - The signature string to decode.

⚙ encodePrivateKey

Encodes a given private key into a string format.

Method	Type
encodePrivateKey	(privateKey: PrivateSignatureKey) => string

Parameters:

• privateKey: - The private key to be encoded.

⚙ encodeSignature

Encodes a given signature into a string format.

Method	Type
encodeSignature	(signature: Uint8Array<ArrayBufferLike>) => string

Parameters:

• signature: - The signature to be encoded, represented as a Uint8Array.

⚙ decodeMessage

Decodes the given encoded message string into a Uint8Array.

Method	Type
decodeMessage	(message: string) => Uint8Array<ArrayBufferLike>

Parameters:

• message: - The encoded message as a string.

⚙ encodeMessage

Encodes a given Uint8Array message into a string format.

Method	Type
encodeMessage	(message: Uint8Array<ArrayBufferLike>) => string

Parameters:

• message: - The message to be encoded as a Uint8Array.

🏭 Hash

Represents a hash object that allows encoding and creation from a string or Uint8Array.

Constructors

public: Constructs a new instance of the class with the provided hash value.

Parameters:

• hash: - The hash value to be used for this instance.

Static Methods

• from

⚙ from

Creates a new instance of Hash from a string or Uint8Array.

const hash = Hash.from('0x1234567890abcdef');
const hash = Hash.from(new Uint8Array([0x12, 0x34, 0x56, 0x78, 0x90, 0xab, 0xcd, 0xef]));

Method	Type
from	(hash: string or Uint8Array<ArrayBufferLike>) => Hash

Parameters:

• hash: - The hash input, which can either be a string or a Uint8Array.

Methods

• encode
• toBytes
• equals

⚙ encode

Encodes the current hash using the provided encoder.

const hash = Hash.from('0x1234567890abcdef');
const hexEncoder = EncoderFactory.bytesToHexEncoder();
const hexString = hash.encode(hexEncoder); // '0x1234567890abcdef'
const hexString = hash.encode(); // '0x1234567890abcdef'

Method	Type
encode	(encoder?: EncoderInterface<Uint8Array<ArrayBufferLike>, string>) => string

Parameters:

• encoder: - The encoder used to encode the hash. Defaults to a BytesToHexEncoder.

⚙ toBytes

Converts and retrieves the hash value as a Uint8Array.

const hash = Hash.from('0x1234567890abcdef');
const bytes = hash.toBytes(); // Uint8Array([0x12, 0x34, 0x56, 0x78, 0x90, 0xab, 0xcd, 0xef])

Method	Type
toBytes	() => Uint8Array<ArrayBufferLike>

⚙ equals

Checks equality of this hash with respect to another hash provided in parameter.

Method	Type
equals	(other: Hash) => boolean

🏭 IllegalUsageError

🏭 IllegalParameterError

🏭 IllegalStateError

🏭 CarmentisError

Static Methods

• isCarmentisError

⚙ isCarmentisError

Method	Type
isCarmentisError	(error: any) => error is CarmentisError

Methods

• getErrorCode

⚙ getErrorCode

Method	Type
getErrorCode	() => CarmentisErrorCode

🏭 EmptyBlockError

🏭 InternalError

🏭 TypeCheckingFailureError

🏭 NodeError

🏭 NodeConnectionRefusedError

🏭 NodeEndpointClosedWhileCatchingUpError

🏭 EconomicsError

🏭 InvalidTokenUnitError

🏭 BlockchainError

🏭 NotImplementedError

🏭 MicroBlockNotFoundInVirtualBlockchainAtHeightError

🏭 MicroBlockNotFoundError

🏭 MicroBlockNotFoundInBlockError

🏭 ActorAlreadyDefinedError

🏭 ChannelAlreadyDefinedError

🏭 ActorNotDefinedError

🏭 ChannelNotDefinedError

🏭 ProofVerificationFailedError

🏭 SectionError

🏭 SectionNotFoundError

🏭 AccountNotFoundForPublicKeyError

🏭 AccountNotFoundForAccountHashError

🏭 OrganizationNotFoundError

🏭 ApplicationNotFoundError

🏭 ApplicationLedgerNotFoundError

🏭 ValidatorNodeNotFoundError

🏭 AccountNotFoundForPublicKeyHashError

🏭 VirtualBlockchainNotFoundError

🏭 TypeManager

Static Methods

• getType
• isJsonType

⚙ getType

Method	Type
getType	(value: any) => 0 or 1 or 2 or 3 or 4 or 5 or 6 or 12

⚙ isJsonType

Method	Type
isJsonType	(type: any) => number

🏭 TypeChecker

Methods

• check
• isString
• isNumber
• isBoolean
• isInteger
• isUnsignedInteger
• isBinary
• isHashString
• checkSize

⚙ check

Tests whether this.value conforms to this.definition.

Method	Type
check	() => void

⚙ isString

Method	Type
isString	() => void

⚙ isNumber

Method	Type
isNumber	() => void

⚙ isBoolean

Method	Type
isBoolean	() => void

⚙ isInteger

Method	Type
isInteger	() => void

⚙ isUnsignedInteger

Method	Type
isUnsignedInteger	(nBits: any) => void

⚙ isBinary

Method	Type
isBinary	(size: any) => void

⚙ isHashString

Method	Type
isHashString	() => void

⚙ checkSize

Method	Type
checkSize	(actualSize: any, expectedSize: any) => void

Properties

• basicType
• definition
• value

⚙ basicType

Property	Type
basicType	any

⚙ definition

Property	Type
definition	any

⚙ value

Property	Type
value	any

🏭 WriteStream

Methods

• clear
• getByteStream
• writeJsonValue
• writeSchemaValue
• writeByte
• writeUnsigned
• writeUint8
• writeUint16
• writeUint24
• writeUint32
• writeUint48
• writeBinary
• writeHashString
• writeByteArray
• writeString
• writeVarUint
• writeBoolean
• writeNumber

⚙ clear

Method	Type
clear	() => void

⚙ getByteStream

Method	Type
getByteStream	() => Uint8Array<any>

⚙ writeJsonValue

Method	Type
writeJsonValue	(type: any, value: any) => void

⚙ writeSchemaValue

Method	Type
writeSchemaValue	(type: number, value: any, size: number or undefined) => void

⚙ writeByte

Method	Type
writeByte	(n: number) => void

⚙ writeUnsigned

Method	Type
writeUnsigned	(n: number, nByte: number) => void

⚙ writeUint8

Method	Type
writeUint8	(n: number) => void

⚙ writeUint16

Method	Type
writeUint16	(n: number) => void

⚙ writeUint24

Method	Type
writeUint24	(n: number) => void

⚙ writeUint32

Method	Type
writeUint32	(n: number) => void

⚙ writeUint48

Method	Type
writeUint48	(n: number) => void

⚙ writeBinary

Method	Type
writeBinary	(arr: any, size?: number) => void

⚙ writeHashString

Method	Type
writeHashString	(str: string) => void

⚙ writeByteArray

Method	Type
writeByteArray	(arr: any) => void

⚙ writeString

Method	Type
writeString	(str: string, size?: number) => void

⚙ writeVarUint

Method	Type
writeVarUint	(n: number) => void

⚙ writeBoolean

Method	Type
writeBoolean	(n: boolean) => void

⚙ writeNumber

Method	Type
writeNumber	(n: number) => void

Properties

• byteStream

⚙ byteStream

Property	Type
byteStream	any

🏭 ReadStream

Methods

• readJsonValue
• readSchemaValue
• getPointer
• extractFrom
• getLastField
• readByte
• readUnsigned
• readUint8
• readUint16
• readUint24
• readUint32
• readUint48
• readBinary
• readHashString
• readByteArray
• readString
• readVarUint
• readBoolean
• readNumber

⚙ readJsonValue

Method	Type
readJsonValue	(type: any) => string or number or boolean or null

⚙ readSchemaValue

Method	Type
readSchemaValue	(type: any, size: any) => any

⚙ getPointer

Method	Type
getPointer	() => any

⚙ extractFrom

Method	Type
extractFrom	(ptr: any) => any

⚙ getLastField

Method	Type
getLastField	() => any

⚙ readByte

Method	Type
readByte	() => any

⚙ readUnsigned

Method	Type
readUnsigned	(nByte: any) => number

⚙ readUint8

Method	Type
readUint8	() => number

⚙ readUint16

Method	Type
readUint16	() => number

⚙ readUint24

Method	Type
readUint24	() => number

⚙ readUint32

Method	Type
readUint32	() => number

⚙ readUint48

Method	Type
readUint48	() => number

⚙ readBinary

Method	Type
readBinary	(size?: number) => any

⚙ readHashString

Method	Type
readHashString	() => string

⚙ readByteArray

Method	Type
readByteArray	(size: number) => any

⚙ readString

Method	Type
readString	(size?: number) => string

⚙ readVarUint

Method	Type
readVarUint	() => number

⚙ readBoolean

Method	Type
readBoolean	() => boolean

⚙ readNumber

Method	Type
readNumber	() => number

Properties

• byteStream
• lastPointer
• pointer

⚙ byteStream

Property	Type
byteStream	any

⚙ lastPointer

Property	Type
lastPointer	any

⚙ pointer

Property	Type
pointer	any

🏭 SchemaSerializer

Constructors

public: Constructor

Parameters:

• schema

Methods

• serialize
• serializeItem

⚙ serialize

Serializes the given object.

Method	Type
serialize	(object: T) => Uint8Array<ArrayBufferLike>

⚙ serializeItem

Serializes an item.

Method	Type
serializeItem	(schemaItem: SchemaItem, value: any, fieldPath: any) => void

Properties

• schema
• stream

⚙ schema

Property	Type
schema	Schema

⚙ stream

Property	Type
stream	any

🏭 SchemaUnserializer

Constructors

public: Constructor

Parameters:

• schema: - Top-level schema

Methods

• unserialize
• unserializeItem

⚙ unserialize

Unserializes the given byte stream.

Method	Type
unserialize	(stream: Uint8Array<ArrayBufferLike>) => T

⚙ unserializeItem

Unserializes an item.

Method	Type
unserializeItem	(schemaItem: SchemaItem) => any

Properties

• schema
• stream

⚙ schema

Property	Type
schema	any

⚙ stream

Property	Type
stream	any

🏭 Microblock

Methods

• create
• updateTimestamp
• load
• getHeight
• getPreviousHash
• getTimestamp
• getGas
• setGas
• setHeight
• setGasPrice
• getGasPrice
• getFeesPayerAccount
• setTimestamp
• setFeesPayerAccount
• addSection
• storeSection
• getSection
• getSectionByType
• getNumberOfSections
• getSections
• getAllSections
• createSignature
• verifySignature
• getSignedData
• setGasData
• serialize
• computeGas
• computeRetentionPeriod

⚙ create

Creates a microblock at a given height. If the height is greater than 1, a 'previousHash' is expected.

Method	Type
create	(height: number, previousHash: Uint8Array<ArrayBufferLike> or null, expirationDay: number) => void

⚙ updateTimestamp

Updates the timestamp.

Method	Type
updateTimestamp	() => void

⚙ load

Loads a microblock from its header data and body data.

Method	Type
load	(headerData: any, bodyData: any) => void

⚙ getHeight

Retrieves the height of the header.

Method	Type
getHeight	() => number

⚙ getPreviousHash

Retrieves the hash value of the previous block in the blockchain.

Method	Type
getPreviousHash	() => Hash

⚙ getTimestamp

Method	Type
getTimestamp	() => number

⚙ getGas

Method	Type
getGas	() => number

⚙ setGas

Method	Type
setGas	(gas: number) => void

⚙ setHeight

Method	Type
setHeight	(number: number) => void

⚙ setGasPrice

Method	Type
setGasPrice	(gasPrice: number) => void

⚙ getGasPrice

Method	Type
getGasPrice	() => number

⚙ getFeesPayerAccount

Method	Type
getFeesPayerAccount	() => Uint8Array<ArrayBufferLike> or null

⚙ setTimestamp

Method	Type
setTimestamp	(timestamp: number) => void

⚙ setFeesPayerAccount

Method	Type
setFeesPayerAccount	(account: Uint8Array<ArrayBufferLike>) => void

⚙ addSection

Adds a section of a given type and defined by a given object.

Method	Type
addSection	(type: SectionType, object: any) => Section<any>

⚙ storeSection

Stores a section, including its serialized data, hash and index.

Method	Type
storeSection	(type: SectionType, object: any, data: any) => Section<any>

⚙ getSection

Returns the first section for which the given callback function returns true.

Method	Type
getSection	<T = any>(callback: (section: Section<any>) => boolean) => Section<T>

⚙ getSectionByType

Retrieves a section by its type.

Method	Type
getSectionByType	(type: number) => Section<any>

Parameters:

• type: - The type of the section to find.

⚙ getNumberOfSections

Retrieves the total number of sections.

Method	Type
getNumberOfSections	() => number

⚙ getSections

Returns all sections for which the given callback function returns true.

Method	Type
getSections	<T = any>(callback: (section: Section<any>) => boolean) => Section<T>[]

⚙ getAllSections

Retrieves all sections without applying any filter criteria.

Method	Type
getAllSections	<T = any>() => Section<T>[]

⚙ createSignature

Creates a digital signature using the provided private key and optionally includes gas-related data.

Method	Type
createSignature	(privateKey: PrivateSignatureKey, includeGas: boolean) => Uint8Array<ArrayBufferLike>

Parameters:

• privateKey: - The private key used to sign the data.
• includeGas: - A flag indicating whether gas-related data should be included in the signature.

⚙ verifySignature

Verifies the provided cryptographic signature using the specified algorithm.

Method	Type
verifySignature	(publicKey: any, signature: any, includeGas: boolean, sectionCount: number) => any

Parameters:

• publicKey: - The public key used to verify the signature.
• signature: - The signature to be verified.
• includeGas: - Indicates whether to include gas-related data in the signed payload.
• sectionCount: - The number of sections to include in the signed data.

⚙ getSignedData

Generates the data to be signed:

• the header with or without the gas data, and without the body hash
• the list of section hashes

Method	Type
getSignedData	(includeGas: boolean, sectionCount: number, extraBytes: number) => Uint8Array<ArrayBuffer>

⚙ setGasData

Sets the gas data to either 0 or to their actual values.

Method	Type
setGasData	(includeGas: boolean, extraBytes?: number) => void

⚙ serialize

Serializes the microblock and returns an object with the microblock hash, the header data, the body hash and the body data.

Method	Type
serialize	() => { microblockHash: Uint8Array<ArrayBufferLike>; headerData: Uint8Array<ArrayBufferLike>; bodyHash: Uint8Array<ArrayBufferLike>; bodyData: Uint8Array<...>; }

⚙ computeGas

Method	Type
computeGas	(extraBytes?: number) => number

⚙ computeRetentionPeriod

Method	Type
computeRetentionPeriod	(mbTimestamp: number, expirationDay: number) => void

Properties

• gasPrice
• hash
• header
• sections
• type
• feesPayerAccount

⚙ gasPrice

Property	Type
gasPrice	number

⚙ hash

Property	Type
hash	any

⚙ header

Property	Type
header	MicroblockHeader

⚙ sections

Property	Type
sections	Section<any>[]

⚙ type

Property	Type
type	number

⚙ feesPayerAccount

Property	Type
feesPayerAccount	Uint8Array<ArrayBufferLike> or null

🏭 VirtualBlockchainStateWrapper

Methods

• getHeight
• getVbId
• getLastMicroblockHash
• getType
• isAccountVirtualBlockchain
• isOrganizationVirtualBlockchain
• isApplicationVirtualBlockchain
• isApplicationLedgerVirtualBlockchain
• isNodeVirtualBlockchain

⚙ getHeight

Method	Type
getHeight	() => number

⚙ getVbId

Method	Type
getVbId	() => Hash

⚙ getLastMicroblockHash

Method	Type
getLastMicroblockHash	() => Hash

⚙ getType

Method	Type
getType	() => VirtualBlockchainType

⚙ isAccountVirtualBlockchain

Method	Type
isAccountVirtualBlockchain	() => boolean

⚙ isOrganizationVirtualBlockchain

Method	Type
isOrganizationVirtualBlockchain	() => boolean

⚙ isApplicationVirtualBlockchain

Method	Type
isApplicationVirtualBlockchain	() => boolean

⚙ isApplicationLedgerVirtualBlockchain

Method	Type
isApplicationLedgerVirtualBlockchain	() => boolean

⚙ isNodeVirtualBlockchain

Method	Type
isNodeVirtualBlockchain	() => boolean

🏭 CMTSToken

A class representing a specific amount of a token in a defined unit.

Static Methods

• create
• createCMTS
• createDeciToken
• createMicroToken
• createMillionToken
• createAtomic
• zero
• oneCMTS
• parse

⚙ create

Creates an instance of TokenAmount with the given amount and unit. Throws an error if the provided unit is not of type TokenUnit.TOKEN.

Method	Type
create	(amount: number, unit?: TokenUnit) => CMTSToken

Parameters:

• amount: - The numeric amount to be used for the TokenAmount instance.
• unit: - The unit type for the token, defaults to TokenUnit.TOKEN.

⚙ createCMTS

Method	Type
createCMTS	(amount: number) => CMTSToken

⚙ createDeciToken

Method	Type
createDeciToken	(amount: number) => CMTSToken

⚙ createMicroToken

Method	Type
createMicroToken	(amount: number) => CMTSToken

⚙ createMillionToken

Method	Type
createMillionToken	(amount: number) => CMTSToken

⚙ createAtomic

Method	Type
createAtomic	(amount: number) => CMTSToken

⚙ zero

Creates an instance of CMTSToken having zero-value.

Example:

const zero = CMTSToken.zero();

Method	Type
zero	() => CMTSToken

⚙ oneCMTS

Method	Type
oneCMTS	() => CMTSToken

⚙ parse

Parses a string representing a token amount and returns a TokenAmount instance.

Method	Type
parse	(value: string) => CMTSToken

Parameters:

• value: - The input string containing a numeric amount followed by a unit (e.g., "10.50 TOKEN").

Methods

• getAmount
• getAmountAsAtomic
• getAmountAsCMTS
• isPositive
• isPositiveStrict
• isNegative
• isZero
• equals
• isGreaterThan
• isLessThan
• toString

⚙ getAmount

Method	Type
getAmount	(unit?: TokenUnit) => number

⚙ getAmountAsAtomic

Retrieves the amount as an atomic unit. Converts and returns the amount in the smallest unit of the token.

Method	Type
getAmountAsAtomic	() => number

⚙ getAmountAsCMTS

Retrieves the amount formatted as CMTS (specific token unit). Utilizes the value formatted in the designated token

Method	Type
getAmountAsCMTS	() => number

⚙ isPositive

Determines if the amount is positive or zero.

Method	Type
isPositive	() => boolean

⚙ isPositiveStrict

Method	Type
isPositiveStrict	() => boolean

⚙ isNegative

Method	Type
isNegative	() => boolean

⚙ isZero

Method	Type
isZero	() => boolean

⚙ equals

Compares the current TokenAmount instance with another TokenAmount instance for equality.

Method	Type
equals	(other: CMTSToken) => boolean

Parameters:

• other: - The TokenAmount instance to compare with the current instance.

⚙ isGreaterThan

Compares the current TokenAmount with another TokenAmount to determine if it is greater.

Method	Type
isGreaterThan	(other: CMTSToken) => boolean

Parameters:

• other: The TokenAmount to compare with.

⚙ isLessThan

Compares the current TokenAmount instance with another TokenAmount instance to determine if it is less than the specified instance.

Method	Type
isLessThan	(other: CMTSToken) => boolean

Parameters:

• other: - The TokenAmount instance to compare against.

⚙ toString

Converts the object to a string representation combining the amount and its unit label. The returned string typically includes the numerical value and its corresponding unit.

Method	Type
toString	(unit?: TokenUnit) => string

🏭 AccountState

Static Methods

• createFromDTO

⚙ createFromDTO

Method	Type
createFromDTO	(dto: AccountStateDTO) => AccountState

Methods

• isEmpty
• getHeight
• getBalance
• getLastHistoryHash
• getLastPublicKeyDeclarationHeight

⚙ isEmpty

Method	Type
isEmpty	() => boolean

⚙ getHeight

Method	Type
getHeight	() => number

⚙ getBalance

Method	Type
getBalance	() => CMTSToken

⚙ getLastHistoryHash

Method	Type
getLastHistoryHash	() => Hash

⚙ getLastPublicKeyDeclarationHeight

Method	Type
getLastPublicKeyDeclarationHeight	() => number

🏭 Transaction

Methods

• getHeight
• getPreviousHistoryHash
• getTimestamp
• transferredAt
• getLinkedAccount
• getAmount
• getChainReference
• isPositive
• isNegative
• isEarnedFees
• isEarnedBlockFees
• isEarnedTxFees
• isPaidBlockFees
• isPaidTxFees
• isReceivedIssuance
• isSentIssuance
• isSale
• isSentPayment
• isPaidFees
• isPurchase
• isReceivedPayment

⚙ getHeight

Method	Type
getHeight	() => number

⚙ getPreviousHistoryHash

Method	Type
getPreviousHistoryHash	() => Hash

⚙ getTimestamp

Method	Type
getTimestamp	() => number

⚙ transferredAt

Method	Type
transferredAt	() => Date

⚙ getLinkedAccount

Retrieves the linked account associated with the transaction.

Method	Type
getLinkedAccount	() => Hash

⚙ getAmount

Method	Type
getAmount	() => CMTSToken

⚙ getChainReference

Method	Type
getChainReference	() => Hash

⚙ isPositive

Determines if the transaction is for a positive (or zero) amount.

Method	Type
isPositive	() => boolean

⚙ isNegative

Determines if the transaction is for a negative amount.

Method	Type
isNegative	() => boolean

⚙ isEarnedFees

Determines whether the transaction is categorized as earned fees.

Method	Type
isEarnedFees	() => boolean

⚙ isEarnedBlockFees

Method	Type
isEarnedBlockFees	() => boolean

⚙ isEarnedTxFees

Method	Type
isEarnedTxFees	() => boolean

⚙ isPaidBlockFees

Method	Type
isPaidBlockFees	() => boolean

⚙ isPaidTxFees

Method	Type
isPaidTxFees	() => boolean

⚙ isReceivedIssuance

Determines whether the transaction is categorized as issuance receiving.

Note: This method is only applicable to the genesis account receiving the initial issuance.

Method	Type
isReceivedIssuance	() => boolean

⚙ isSentIssuance

Method	Type
isSentIssuance	() => boolean

⚙ isSale

Determines whether the transaction is categorized as a sale.

Note: A transaction categorized as a sale is only applicable to the genesis account sending tokens to an account.

Method	Type
isSale	() => boolean

⚙ isSentPayment

Determines whether the transaction is categorized as a sent payment.

Payments occur between two accounts (distinct from the genesis account).

Method	Type
isSentPayment	() => boolean

⚙ isPaidFees

Method	Type
isPaidFees	() => boolean

⚙ isPurchase

Determines whether the transaction is categorized as a purchase.

Note: A transaction categorized as a purchase is only applicable to an account receiving tokens from the genesis account.

Method	Type
isPurchase	() => boolean

⚙ isReceivedPayment

Determines whether the transaction is categorized as a received payment.

Payments occur between two accounts (distinct from the genesis account).

Method	Type
isReceivedPayment	() => boolean

🏭 AccountHistoryView

Methods

• setTransactionAtHeight
• containsTransactions
• getTransactionHeights
• getAllTransactions
• getNumberOfTransactions
• containsTransactionAtHeight
• getTransactionAtHeight

⚙ setTransactionAtHeight

Method	Type
setTransactionAtHeight	(height: number, transaction: AccountTransactionInterface) => void

⚙ containsTransactions

Determines whether there are any transactions available.

Method	Type
containsTransactions	() => boolean

⚙ getTransactionHeights

Retrieves the heights of all transactions currently stored.

Method	Type
getTransactionHeights	() => number[]

⚙ getAllTransactions

Retrieves all the transactions stored in the view.

Method	Type
getAllTransactions	() => Transaction[]

⚙ getNumberOfTransactions

Retrieves the total number of transactions.

Method	Type
getNumberOfTransactions	() => number

⚙ containsTransactionAtHeight

Checks if there is a transaction at the specified block height.

Method	Type
containsTransactionAtHeight	(height: number) => boolean

Parameters:

• height: - The block height to check for a transaction.

⚙ getTransactionAtHeight

Method	Type
getTransactionAtHeight	(height: number) => Transaction

🏭 MicroBlockHeaderWrapper

Methods

• getMagicString
• getProtocolVersion
• getHeight
• getPreviousHash
• getGas
• getGasPrice
• getBodyHash

⚙ getMagicString

Method	Type
getMagicString	() => string

⚙ getProtocolVersion

Method	Type
getProtocolVersion	() => number

⚙ getHeight

Method	Type
getHeight	() => number

⚙ getPreviousHash

Method	Type
getPreviousHash	() => Hash

⚙ getGas

Method	Type
getGas	() => CMTSToken

⚙ getGasPrice

Method	Type
getGasPrice	() => CMTSToken

⚙ getBodyHash

Method	Type
getBodyHash	() => Hash

🏭 MicroBlockInformation

Methods

• getMicroBlockHeader
• getVirtualBlockchainState

⚙ getMicroBlockHeader

Method	Type
getMicroBlockHeader	() => MicroBlockHeaderWrapper

⚙ getVirtualBlockchainState

Method	Type
getVirtualBlockchainState	() => VirtualBlockchainStateWrapper

🏭 StructureChecker

Methods

• isFirstBlock
• expects
• group
• endsHere
• currentSection
• endOfList
• checkConstraint
• getTypeLabel

⚙ isFirstBlock

Method	Type
isFirstBlock	() => boolean

⚙ expects

Method	Type
expects	(constraint: any, type: any) => void

⚙ group

Method	Type
group	(groupConstraint: any, list: any) => void

⚙ endsHere

Method	Type
endsHere	() => void

⚙ currentSection

Method	Type
currentSection	() => any

⚙ endOfList

Method	Type
endOfList	() => boolean

⚙ checkConstraint

Method	Type
checkConstraint	(constraint: any, count: any) => boolean or undefined

⚙ getTypeLabel

Method	Type
getTypeLabel	(type: any) => string

Properties

• microblock
• pointer

⚙ microblock

Property	Type
microblock	any

⚙ pointer

Property	Type
pointer	any

🏭 OrganizationVb

Methods

• getDescriptionHeight
• checkStructure

⚙ getDescriptionHeight

Method	Type
getDescriptionHeight	() => number

⚙ checkStructure

Structure check

Method	Type
checkStructure	(microblock: any) => void

🏭 Organization

Methods

• setGasPrice
• getName

⚙ setGasPrice

Method	Type
setGasPrice	(gasPrice: CMTSToken) => void

⚙ getName

Method	Type
getName	() => string

Properties

• provider
• signatureAlgorithmId
• vb
• gasPrice

⚙ provider

Property	Type
provider	any

⚙ signatureAlgorithmId

Property	Type
signatureAlgorithmId	SignatureAlgorithmId or undefined

⚙ vb

Property	Type
vb	OrganizationVb

⚙ gasPrice

Property	Type
gasPrice	CMTSToken

🏭 ApplicationVb

Methods

• getDescriptionHeight
• getInitialState
• checkStructure

⚙ getDescriptionHeight

Method	Type
getDescriptionHeight	() => number

⚙ getInitialState

Method	Type
getInitialState	() => ApplicationVBState

⚙ checkStructure

Structure check

Method	Type
checkStructure	(microblock: any) => void

🏭 Application

Methods

• setGasPrice

⚙ setGasPrice

Method	Type
setGasPrice	(gasPrice: CMTSToken) => void

Properties

• provider
• signatureAlgorithmId
• vb
• gasPrice

⚙ provider

Property	Type
provider	any

⚙ signatureAlgorithmId

Property	Type
signatureAlgorithmId	any

⚙ vb

Property	Type
vb	ApplicationVb

⚙ gasPrice

Property	Type
gasPrice	CMTSToken

🏭 MerkleTree

Methods

• addLeaf
• setLeaf
• checkHash
• finalize
• getNumberOfLeaves
• getRootHash
• getWitnesses
• setWitnesses
• buildTreeStructure
• getWitnessPositions
• mergeHashes

⚙ addLeaf

Method	Type
addLeaf	(hash: any) => void

⚙ setLeaf

Method	Type
setLeaf	(index: any, hash: any) => void

⚙ checkHash

Method	Type
checkHash	(hash: any) => void

⚙ finalize

Method	Type
finalize	(nLeaves: any) => void

⚙ getNumberOfLeaves

Method	Type
getNumberOfLeaves	() => any

⚙ getRootHash

Method	Type
getRootHash	() => any

⚙ getWitnesses

Method	Type
getWitnesses	(unknownPositions: any) => never[]

⚙ setWitnesses

Method	Type
setWitnesses	(witnesses: any) => void

⚙ buildTreeStructure

Method	Type
buildTreeStructure	() => void

⚙ getWitnessPositions

Method	Type
getWitnessPositions	(unknownPositionSet: any) => never[]

⚙ mergeHashes

Method	Type
mergeHashes	(depth: any, left: any, right: any) => Uint8Array<ArrayBufferLike>

Properties

• leaves
• nLeaves
• tree

⚙ leaves

Property	Type
leaves	any

⚙ nLeaves

Property	Type
nLeaves	any

⚙ tree

Property	Type
tree	any

🏭 PepperMerklizer

Static Methods

• generatePepper

⚙ generatePepper

Method	Type
generatePepper	() => Uint8Array<ArrayBufferLike>

Methods

• addLeaf
• generateTree
• addRawItem
• addHashableItem
• addMaskableItem
• getSalt

⚙ addLeaf

Method	Type
addLeaf	(item: any, data: any) => void

⚙ generateTree

Method	Type
generateTree	() => { nLeaves: any; rootHash: string; pepper: string; }

⚙ addRawItem

Method	Type
addRawItem	(item: any, info: any) => void

⚙ addHashableItem

Method	Type
addHashableItem	(item: any, info: any) => void

⚙ addMaskableItem

Method	Type
addMaskableItem	(item: any, info: any) => void

⚙ getSalt

Method	Type
getSalt	() => any

Properties

• leaves
• pepper
• saltCounter
• sha512

⚙ leaves

Property	Type
leaves	any

⚙ pepper

Property	Type
pepper	any

⚙ saltCounter

Property	Type
saltCounter	any

⚙ sha512

Property	Type
sha512	any

🏭 SaltMerklizer

Methods

• addLeaf
• generateTree
• addRawItem
• addHashableItem
• addMaskableItem

⚙ addLeaf

Method	Type
addLeaf	(item: any, data: any) => void

⚙ generateTree

Method	Type
generateTree	() => { nLeaves: any; rootHash: string; }

⚙ addRawItem

Method	Type
addRawItem	(item: any, info: any) => void

⚙ addHashableItem

Method	Type
addHashableItem	(item: any, info: any) => void

⚙ addMaskableItem

Method	Type
addMaskableItem	(item: any, info: any) => void

Properties

• nLeaves
• witnesses

⚙ nLeaves

Property	Type
nLeaves	any

⚙ witnesses

Property	Type
witnesses	any

🏭 IntermediateRepresentation

Methods

• addPublicChannel
• addPrivateChannel
• buildFromJson
• exportToSectionFormat
• exportChannelToSectionFormat
• importFromSectionFormat
• importChannelFromSectionFormat
• exportToProof
• importFromProof
• createBranch
• getMerkleRootHash
• getMerklizer
• getIRObject
• dumpIRObject
• setChannel
• setAsMaskable
• setAsMaskableByRegex
• setAsHashable
• setAsRedacted
• setAsMasked
• setAsHashed
• processPath
• populateChannels
• buildDictionary
• serializeFields
• unserializeFields
• traverseIrObject
• exportToJson

⚙ addPublicChannel

Method	Type
addPublicChannel	(id: any) => void

⚙ addPrivateChannel

Method	Type
addPrivateChannel	(id: any) => void

⚙ buildFromJson

Initializes the IR object from a JSON-compatible object.

Method	Type
buildFromJson	(input: any) => void

⚙ exportToSectionFormat

Exports the IR object to the serialized section format used for on-chain storage.

Method	Type
exportToSectionFormat	() => never[]

⚙ exportChannelToSectionFormat

Exports a given channel to the serialized section format used for on-chain storage.

Method	Type
exportChannelToSectionFormat	(channelInfo: any) => Uint8Array<any>

⚙ importFromSectionFormat

Imports the IR object from the serialized section format.

Method	Type
importFromSectionFormat	(list: any) => void

⚙ importChannelFromSectionFormat

Imports a given channel from the serialized section format.

Method	Type
importChannelFromSectionFormat	(channelInfo: any, data: any) => void

⚙ exportToProof

Exports the IR object to a proof, as a JSON-compatible object.

Method	Type
exportToProof	() => any

⚙ importFromProof

Imports the IR object from a proof.

Method	Type
importFromProof	(proof: any) => never[]

Parameters:

• proof: - The proof object generated by the exportToProof() method.

⚙ createBranch

Internal method to create a branch in the object tree, including a primitive type and all its parents. Only a minimal set of properties is included for each node: 'type', 'name'/'index', 'properties'/'entries'.

Method	Type
createBranch	(itemList: any) => { type: any; } or undefined

Parameters:

• itemList: - An array containing the primitive item, preceded by all its parents.

⚙ getMerkleRootHash

Method	Type
getMerkleRootHash	(channelId: any) => any

⚙ getMerklizer

Internal method to create a merklizer for a given channel, using either the channel pepper or the salts.

Method	Type
getMerklizer	(channelId: any) => any

Parameters:

• channel: - The identifier of the channel.

⚙ getIRObject

Returns the IR object.

Method	Type
getIRObject	() => any

⚙ dumpIRObject

Returns a formatted dump of the IR object, with uint8 arrays turned into truncated hexadecimal strings for readability.

Method	Type
dumpIRObject	() => string

⚙ setChannel

Associates a set of fields to a channel.

Method	Type
setChannel	(pathStringList: any, channelId: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.
• channel: - The channel identifier.

⚙ setAsMaskable

Sets the 'maskable' attribute for a set of fields and define their visible and hidden parts using explicit positions, lengths and replacement strings.

Method	Type
setAsMaskable	(pathStringList: any, maskedParts: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.
• maskedParts: - An array describing the masked parts.

⚙ setAsMaskableByRegex

Sets the 'maskable' attribute for a set of fields and define their visible and hidden parts using a regular expression and a substitution string.

Method	Type
setAsMaskableByRegex	(pathStringList: any, regex: any, substitution: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.
• regex: - A regular expression whose capturing groups must cover the entire field value, e.g. /^(.)(.?)(@.)(.?)(..*)$/.
• substitution: - The substitution string, which should include references to capturing groups and placeholders for hidden parts, e.g. "$1***$3***$5".

⚙ setAsHashable

Sets the 'hashable' attribute for a set of fields.

Method	Type
setAsHashable	(pathStringList: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.

⚙ setAsRedacted

Marks a set of fields as 'redacted'.

Method	Type
setAsRedacted	(pathStringList: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.

⚙ setAsMasked

Marks a set of fields as 'masked'.

Method	Type
setAsMasked	(pathStringList: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.

⚙ setAsHashed

Marks a set of fields as 'hashed'.

Method	Type
setAsHashed	(pathStringList: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.

⚙ processPath

Internal method to apply a callback function to each field included in a set of fields.

Method	Type
processPath	(pathStringList: any, callback: any) => void

Parameters:

• pathStringList: - A string describing the set of fields.
• callback: - The callback function, which will receive the field item as argument.

⚙ populateChannels

Internal method to populate the channel identifiers from the primitive fields to their parents. Also loads the sorted list of all channels in the array this.usedChannels.

Method	Type
populateChannels	() => void

⚙ buildDictionary

Internal method to build a dictionary of field names for a given channel.

Method	Type
buildDictionary	(channelId: any) => unknown[]

Parameters:

• channel: - The channel identifier.

⚙ serializeFields

Internal method to serialize the primitive fields.

Method	Type
serializeFields	() => void

⚙ unserializeFields

Method	Type
unserializeFields	() => void

⚙ traverseIrObject

Internal method to traverse the IR object and calling optional callbacks on each node.

Method	Type
traverseIrObject	(options: any) => void

Parameters:

• options: - An object containing the traversal options.

⚙ exportToJson

Exports the IR object back to the core JSON-compatible object it describes.

Method	Type
exportToJson	() => any

Properties

• importedFromProof
• channelDefinitions
• irObject
• object
• usedChannels

⚙ importedFromProof

Property	Type
importedFromProof	boolean

⚙ channelDefinitions

Property	Type
channelDefinitions	any

⚙ irObject

Property	Type
irObject	any

⚙ object

Property	Type
object	any

⚙ usedChannels

Property	Type
usedChannels	any

🏭 ApplicationLedgerVb

Methods

• getIntermediateRepresentationInstance
• getChannelId
• getChannel
• getActorId
• getActor
• checkStructure
• getApplicationId
• getNumberOfChannels
• getChannelById
• getNumberOfActors

⚙ getIntermediateRepresentationInstance

Helper methods

Method	Type
getIntermediateRepresentationInstance	() => IntermediateRepresentation

⚙ getChannelId

Method	Type
getChannelId	(name: string) => number

⚙ getChannel

Method	Type
getChannel	(name: string) => ApplicationLedgeChannel

⚙ getActorId

Method	Type
getActorId	(name: string) => number

⚙ getActor

Method	Type
getActor	(name: string) => ApplicationLedgerActor

⚙ checkStructure

Structure check

Method	Type
checkStructure	(microblock: any) => void

⚙ getApplicationId

Retrieves the application ID from the current state.

Method	Type
getApplicationId	() => Uint8Array<ArrayBufferLike>

⚙ getNumberOfChannels

Retrieves the total number of channels currently available.

Method	Type
getNumberOfChannels	() => number

⚙ getChannelById

Retrieves a channel object by its unique identifier.

Method	Type
getChannelById	(channelId: number) => ApplicationLedgeChannel

Parameters:

• channelId: - The unique identifier of the channel

⚙ getNumberOfActors

Retrieves the total number of actors currently present in the state.

Method	Type
getNumberOfActors	() => number

🏭 SchemaValidator

Constructors

public: Constructor

Parameters:

• schema: - Top-level schema

Methods

• validate
• validateObject
• validateItem

⚙ validate

Checks whether the given object matches the schema.

Method	Type
validate	(object: any) => void

Parameters:

• object: - The object to be tested.

⚙ validateObject

Validates any sub-object of the full structure.

Method	Type
validateObject	(schemaDefinition: SchemaItem[], object: any, path?: string) => void

Parameters:

• schemaDefinition: - The (sub)schema of the object.
• object: - The object to be serialized.

⚙ validateItem

Validates an item.

Method	Type
validateItem	(schemaItem: SchemaItem, value: any, fieldPath: string) => void

Parameters:

• schemaItem: - The definition of the item.
• value: - The value of the item.

Properties

• schema

⚙ schema

Property	Type
schema	Schema

🏭 ApplicationLedger

Methods

• getVirtualBlockchainId
• getVirtualBlockchain
• actorIsSubscribed
• setGasPrice
• getMicroblockData
• getApplicationId
• getHeight

⚙ getVirtualBlockchainId

Method	Type
getVirtualBlockchainId	() => Hash

⚙ getVirtualBlockchain

Method	Type
getVirtualBlockchain	() => ApplicationLedgerVb

⚙ actorIsSubscribed

Method	Type
actorIsSubscribed	(name: string) => boolean

⚙ setGasPrice

Method	Type
setGasPrice	(gasPrice: CMTSToken) => void

⚙ getMicroblockData

Method	Type
getMicroblockData	() => Uint8Array<ArrayBuffer>

⚙ getApplicationId

Retrieves the application ID.

Method	Type
getApplicationId	() => Hash

⚙ getHeight

Method	Type
getHeight	() => number

Properties

• provider
• signatureAlgorithmId
• vb
• gasPrice

⚙ provider

Property	Type
provider	any

⚙ signatureAlgorithmId

Property	Type
signatureAlgorithmId	any

⚙ vb

Property	Type
vb	ApplicationLedgerVb

⚙ gasPrice

Property	Type
gasPrice	CMTSToken

🏭 ValidatorNodeVb

Methods

• getDescriptionHeight
• getRpcEndpointHeight
• getNetworkIntegrationHeight
• getInitialState
• checkStructure

⚙ getDescriptionHeight

Method	Type
getDescriptionHeight	() => number

⚙ getRpcEndpointHeight

Method	Type
getRpcEndpointHeight	() => number

⚙ getNetworkIntegrationHeight

Method	Type
getNetworkIntegrationHeight	() => number

⚙ getInitialState

Method	Type
getInitialState	() => ValidatorNodeVBState

⚙ checkStructure

Structure check

Method	Type
checkStructure	(microblock: any) => void

🏭 ValidatorNode

Methods

• setGasPrice

⚙ setGasPrice

Method	Type
setGasPrice	(gasPrice: CMTSToken) => void

Properties

• provider
• signatureAlgorithmId
• vb
• gasPrice

⚙ provider

Property	Type
provider	any

⚙ signatureAlgorithmId

Property	Type
signatureAlgorithmId	any

⚙ vb

Property	Type
vb	ValidatorNodeVb

⚙ gasPrice

Property	Type
gasPrice	CMTSToken

🏭 Optional

Static Methods

• of
• some
• none

⚙ of

Method	Type
of	<T>(value: T or null) => Optional<T>

⚙ some

Method	Type
some	<T>(value: T) => Optional<T>

⚙ none

Method	Type
none	<T>() => Optional<T>

Methods

• map
• unwrap
• unwrapOrThrow
• unwrapOr
• isSome
• isNone

⚙ map

Method	Type
map	<U>(fn: (value: T) => U) => Optional<U>

⚙ unwrap

Method	Type
unwrap	() => T

⚙ unwrapOrThrow

Method	Type
unwrapOrThrow	(error: Error) => T and ({} or undefined)

⚙ unwrapOr

Method	Type
unwrapOr	(defaultValue: T) => T

⚙ isSome

Method	Type
isSome	() => boolean

⚙ isNone

Method	Type
isNone	() => boolean

🏭 MicroblockImporter

Methods

• containsError
• getError
• getVirtualBlockchainObject
• getMicroBlock

⚙ containsError

Method	Type
containsError	() => boolean

⚙ getError

Method	Type
getError	() => Error

⚙ getVirtualBlockchainObject

Method	Type
getVirtualBlockchainObject	<VB>() => VB

⚙ getMicroBlock

Method	Type
getMicroBlock	() => Microblock

Properties

• bodyData
• _error
• hash
• header
• headerData
• provider
• vb
• object

⚙ bodyData

Property	Type
bodyData	any

⚙ _error

Property	Type
_error	Optional<Error>

⚙ hash

Property	Type
hash	any

⚙ header

Property	Type
header	any

⚙ headerData

Property	Type
headerData	any

⚙ provider

Property	Type
provider	Provider

⚙ vb

Property	Type
vb	VirtualBlockchain<any>

⚙ object

Property	Type
object	any

🏭 ProofVerificationResult

Represents the result of a proof verification process, encapsulating the verified data and providing methods to check the validity of various elements of the proof.

Static Methods

• createSuccessfulProofVerificationResult
• createFailedProofVerificationResult

⚙ createSuccessfulProofVerificationResult

Method	Type
createSuccessfulProofVerificationResult	(appLedger: ApplicationLedger, data: ImportedProof[]) => ProofVerificationResult

⚙ createFailedProofVerificationResult

Method	Type
createFailedProofVerificationResult	(appLedger: ApplicationLedger) => ProofVerificationResult

Methods

• isVerified
• getInvolvedBlockHeights
• getApplicationLedgerId

⚙ isVerified

Checks if the current state is verified.

Method	Type
isVerified	() => boolean

⚙ getInvolvedBlockHeights

Retrieves the heights of the involved blocks based on the imported proofs.

If there are imported proofs, the method returns an array of block heights extracted from the proofs. If there are no imported proofs, it returns an empty array.

Method	Type
getInvolvedBlockHeights	() => number[]

⚙ getApplicationLedgerId

Retrieves the ledger ID of the application as a hash.

Method	Type
getApplicationLedgerId	() => Hash

🏭 ChainInformationWrapper

Static Methods

• createFromDTO

⚙ createFromDTO

Method	Type
createFromDTO	(chainInformation: ChainInformationDTO) => ChainInformationWrapper

Methods

• getHeight
• getLatestPublicationTime

⚙ getHeight

Method	Type
getHeight	() => number

⚙ getLatestPublicationTime

Method	Type
getLatestPublicationTime	() => Date

🏭 VirtualBlockchainWrapper

Methods

• getVirtualBlockchainState
• getMicroBlockHashes

⚙ getVirtualBlockchainState

Method	Type
getVirtualBlockchainState	() => VirtualBlockchainStateWrapper

⚙ getMicroBlockHashes

Method	Type
getMicroBlockHashes	() => Hash[]

🏭 MemoryProvider

Static Methods

• getInstance

⚙ getInstance

Method	Type
getInstance	() => MemoryProvider

Methods

• clear

⚙ clear

Method	Type
clear	() => void

Properties

• microblockHeaderStore
• microblockBodyStore
• microblockVbInformationStore
• virtualBlockchainStateStore

⚙ microblockHeaderStore

Property	Type
microblockHeaderStore	any

⚙ microblockBodyStore

Property	Type
microblockBodyStore	any

⚙ microblockVbInformationStore

Property	Type
microblockVbInformationStore	any

⚙ virtualBlockchainStateStore

Property	Type
virtualBlockchainStateStore	any

🏭 MessageSerializer

Constructors

public: Constructor

Parameters:

• collection: - Message collection

Methods

• serialize

⚙ serialize

Serializes the given message.

Method	Type
serialize	(type: number, object: T) => Uint8Array<ArrayBuffer>

Parameters:

• type: - Message type
• object: - The message object to be serialized

Properties

• collection

⚙ collection

Property	Type
collection	any

🏭 MessageUnserializer

Constructors

public: Constructor

Parameters:

• collection: - Message collection

Methods

• unserialize

⚙ unserialize

Unserializes the given message byte stream.

Method	Type
unserialize	(stream: Uint8Array<ArrayBufferLike>) => { type: number; object: T; }

Parameters:

• stream: - The serialized byte stream

Properties

• collection

⚙ collection

Property	Type
collection	any

🏭 NetworkProvider

Properties

• nodeUrl

⚙ nodeUrl

Property	Type
nodeUrl	any

🏭 KeyedProvider

Methods

• isKeyed
• getPrivateSignatureKey
• getPublicSignatureKey

⚙ isKeyed

Method	Type
isKeyed	() => this is KeyedProvider

⚙ getPrivateSignatureKey

Method	Type
getPrivateSignatureKey	() => PrivateSignatureKey

⚙ getPublicSignatureKey

Method	Type
getPublicSignatureKey	() => PublicSignatureKey

🏭 Provider

Represents a provider class that interacts with both internal and external providers for managing blockchain states and microblocks.

Methods

• isKeyed

⚙ isKeyed

Method	Type
isKeyed	() => this is KeyedProvider

Properties

• externalProvider
• internalProvider

⚙ externalProvider

Property	Type
externalProvider	NetworkProvider

⚙ internalProvider

Property	Type
internalProvider	MemoryProvider

🏭 VirtualBlockchain

Methods

• setExpirationDay
• getHeight
• getId
• isVirtualBlockchainIdDefined
• registerSectionCallback
• getIdentifier
• createSignature
• setGasPrice
• getMicroblockData

⚙ setExpirationDay

Method	Type
setExpirationDay	(day: number) => void

⚙ getHeight

Method	Type
getHeight	() => number

⚙ getId

Method	Type
getId	() => Uint8Array<ArrayBufferLike>

⚙ isVirtualBlockchainIdDefined

Method	Type
isVirtualBlockchainIdDefined	() => boolean

⚙ registerSectionCallback

Registers a callback for a given section type.

Method	Type
registerSectionCallback	(sectionType: any, callback: any) => void

⚙ getIdentifier

Method	Type
getIdentifier	() => Hash

⚙ createSignature

Creates a cryptographic signature for a microblock.

Method	Type
createSignature	(privateKey: PrivateSignatureKey, withGas?: boolean) => { signature: Uint8Array<ArrayBufferLike>; }

Parameters:

• privateKey: - The private key used to generate the signature.
• withGas: - Specifies whether the signature should include gas information.

⚙ setGasPrice

Set the gas price for the current microblock.

Method	Type
setGasPrice	(gasPrice: CMTSToken) => void

⚙ getMicroblockData

Returns the raw data of the current microblock.

Method	Type
getMicroblockData	() => Uint8Array<ArrayBuffer>

Properties

• currentMicroblock
• height
• identifier
• microblockHashes
• provider
• sectionCallbacks
• state
• type
• expirationDay

⚙ currentMicroblock

Property	Type
currentMicroblock	Microblock or null

⚙ height

Property	Type
height	number

⚙ identifier

Property	Type
identifier	any

⚙ microblockHashes

Property	Type
microblockHashes	any

⚙ provider

Property	Type
provider	Provider

⚙ sectionCallbacks

Property	Type
sectionCallbacks	any

⚙ state

Property	Type
state	CustomState or undefined

⚙ type

Property	Type
type	number

⚙ expirationDay

Property	Type
expirationDay	number

🏭 AccountVb

Methods

• checkStructure
• getInitialState

⚙ checkStructure

Structure check

Method	Type
checkStructure	(microblock: any) => void

⚙ getInitialState

Method	Type
getInitialState	() => AccountVBState

🏭 Account

Represents an Account that interacts with a provider for managing cryptographic operations and interacting with a virtual blockchain (vb) context. Provides methods for creating, loading, transferring, and publishing updates.

Methods

• setGasPrice
• getVirtualBlockchainId

⚙ setGasPrice

Method	Type
setGasPrice	(gasPrice: CMTSToken) => void

⚙ getVirtualBlockchainId

Method	Type
getVirtualBlockchainId	() => Hash

Properties

• vb
• provider
• gasPrice

⚙ vb

Property	Type
vb	AccountVb

⚙ provider

Property	Type
provider	Provider

⚙ gasPrice

Property	Type
gasPrice	CMTSToken

🏭 Explorer

Static Methods

• createFromProvider

⚙ createFromProvider

Method	Type
createFromProvider	(provider: Provider) => Explorer

Properties

• provider

⚙ provider

Property	Type
provider	Provider

🏭 Blockchain

Static Methods

• createFromProvider

⚙ createFromProvider

Method	Type
createFromProvider	(provider: Provider) => Blockchain

Methods

• getExplorer
• getMicroblockImporter
• isKeyed

⚙ getExplorer

Method	Type
getExplorer	() => Explorer

⚙ getMicroblockImporter

Method	Type
getMicroblockImporter	(data: any) => MicroblockImporter

⚙ isKeyed

Method	Type
isKeyed	() => boolean

Properties

• provider

⚙ provider

Property	Type
provider	Provider

🏭 CometBFTPublicKey

Static Methods

• createFromEd25519PublicKey

⚙ createFromEd25519PublicKey

Method	Type
createFromEd25519PublicKey	(publicKey: string) => CometBFTPublicKey

Methods

• getType
• getPublicKey

⚙ getType

Method	Type
getType	() => string

⚙ getPublicKey

Method	Type
getPublicKey	() => string

🏭 HCVPkeEncoder

Static Methods

• createHexHCVPkeEncoder
• createBase64HCVPkeEncoder

⚙ createHexHCVPkeEncoder

Method	Type
createHexHCVPkeEncoder	() => HCVPkeEncoder

⚙ createBase64HCVPkeEncoder

Method	Type
createBase64HCVPkeEncoder	() => HCVPkeEncoder

Methods

• decodePrivateDecryptionKey
• decodePublicEncryptionKey
• encodePrivateDecryptionKey
• encodePublicEncryptionKey

⚙ decodePrivateDecryptionKey

Method	Type
decodePrivateDecryptionKey	(privateKey: string) => AbstractPrivateDecryptionKey

⚙ decodePublicEncryptionKey

Method	Type
decodePublicEncryptionKey	(publicKey: string) => AbstractPublicEncryptionKey

⚙ encodePrivateDecryptionKey

Method	Type
encodePrivateDecryptionKey	(privateKey: AbstractPrivateDecryptionKey) => string

⚙ encodePublicEncryptionKey

Method	Type
encodePublicEncryptionKey	(key: AbstractPublicEncryptionKey) => string

🏭 GenericSymmetricKeyEncoder

A class responsible for encoding and decoding symmetric encryption keys. It provides functionalities to serialize and deserialize symmetric encryption keys to and from a Uint8Array.

Methods

• encodeAsUint8Array
• decodeFromUint8Array

⚙ encodeAsUint8Array

Encodes a given symmetric encryption key as a Uint8Array.

Method	Type
encodeAsUint8Array	(key: SymmetricEncryptionKey) => Uint8Array<ArrayBufferLike>

Parameters:

• key: - The symmetric encryption key to encode. It must provide methods to retrieve the encryption scheme ID and the raw secret key as a hexadecimal string.

⚙ decodeFromUint8Array

Decodes a Uint8Array into a SymmetricEncryptionKey object.

Method	Type
decodeFromUint8Array	(key: Uint8Array<ArrayBufferLike>) => SymmetricEncryptionKey

Parameters:

• key: - The Uint8Array containing the encoded symmetric encryption key.

🏭 SignatureCacheEntry

Methods

• getKey

⚙ getKey

Method	Type
getKey	() => string

🏭 SignatureCacheDisabled

🏭 SignatureCacheMonothread

🏭 Euros

Static Methods

• create

⚙ create

Method	Type
create	(amount: number) => Euros

Methods

• getAmount
• toString

⚙ getAmount

Method	Type
getAmount	() => number

⚙ toString

Method	Type
toString	() => string

🏭 CurrencyConverterFactory

A factory class for creating currency converter instances.

Static Methods

• defaultEurosToCMTSTokenConverter

⚙ defaultEurosToCMTSTokenConverter

Method	Type
defaultEurosToCMTSTokenConverter	() => CurrencyConverter<Euros, CMTSToken>

🏭 EurosToCMTSConverter

A converter class that facilitates the conversion between Euros and CMTS Tokens. Implements the CurrencyConverter interface to provide methods for converting from Euros to CMTS Tokens and vice versa.

It uses a static conversion rate TOKENS_FOR_ONE_EUROS to determine the equivalent amount of CMTS Tokens for a given amount of Euros and inversely the equivalent amount of Euros for a given amount of CMTS Tokens.

Methods:

• convert(from: Euros): CMTSToken: Accepts an amount in Euros and converts it to CMTS Tokens.
• invert(to: CMTSToken): Euros: Converts an amount in CMTS Tokens back to Euros.

This class ensures the consistency of conversions through the use of a fixed conversion rate.

Methods

• convert
• invert

⚙ convert

Converts an amount from one currency to another.

Method	Type
convert	(from: Euros) => CMTSToken

⚙ invert

Inverts the given currency exchange rate by converting from the target currency back to the original currency.

Method	Type
invert	(to: CMTSToken) => Euros

🏭 ProofBuilder

Static Methods

• createProofBuilder

⚙ createProofBuilder

Method	Type
createProofBuilder	(virtualBlockchainId: Hash, appLedger: ApplicationLedger) => ProofBuilder

Methods

• exportProofForEntireVirtualBlockchain

⚙ exportProofForEntireVirtualBlockchain

Method	Type
exportProofForEntireVirtualBlockchain	(proofAuthor: string) => Promise<Proof>

🏭 ValidatorNodeWrapper

Methods

• getOrganizationId
• getVotingPower
• getRpcEndpoint
• getCometPublicKeyType
• getCometPublicKey
• getPublicKey

⚙ getOrganizationId

Retrieves the id of the organization managing the validator node.

Method	Type
getOrganizationId	() => Hash

⚙ getVotingPower

Retrieves the voting power of the validator node

Method	Type
getVotingPower	() => number

⚙ getRpcEndpoint

Retrieves the RPC endpoint of the validator node

Method	Type
getRpcEndpoint	() => string

⚙ getCometPublicKeyType

Retrieves the Comet public key type of the validator node.

Method	Type
getCometPublicKeyType	() => string

⚙ getCometPublicKey

Retrieves the Comet public key of the validator node.

Method	Type
getCometPublicKey	() => string

⚙ getPublicKey

Retrieves the public key associated with the CometBFT instance.

Method	Type
getPublicKey	() => CometBFTPublicKey

🏭 BlockInformationWrapper

Methods

• getBlockHeight
• getBlockHash
• anchoredAt
• getProposerNode

⚙ getBlockHeight

Method	Type
getBlockHeight	() => number

⚙ getBlockHash

Method	Type
getBlockHash	() => Hash

⚙ anchoredAt

Method	Type
anchoredAt	() => Date

⚙ getProposerNode

Method	Type
getProposerNode	() => Hash

🏭 BlockContentWrapper

Static Methods

• createFromDTO

⚙ createFromDTO

Method	Type
createFromDTO	(blockContentDTO: BlockContentDTO) => BlockContentWrapper

Methods

• getContainedMicroBlockHashes
• getContainedMicroBlockHeight
• numberOfContainedMicroBlocks
• getMicroBlockAtHeight
• getMicroBlocksByVirtualBlockchainId

⚙ getContainedMicroBlockHashes

Method	Type
getContainedMicroBlockHashes	() => Hash[]

⚙ getContainedMicroBlockHeight

Method	Type
getContainedMicroBlockHeight	() => number[]

⚙ numberOfContainedMicroBlocks

Method	Type
numberOfContainedMicroBlocks	() => number

⚙ getMicroBlockAtHeight

Method	Type
getMicroBlockAtHeight	(height: number) => MicroBlockInBlockContentWrapper

⚙ getMicroBlocksByVirtualBlockchainId

Method	Type
getMicroBlocksByVirtualBlockchainId	(virtualBlockchainId: Hash) => MicroBlockInBlockContentWrapper[]

🏭 ABCINodeBlockchainReader

Static Methods

• createFromNodeURL

⚙ createFromNodeURL

Creates an instance of ABCINodeBlockchainReader from the provided node URL.

Method	Type
createFromNodeURL	(nodeUrl: string) => ABCINodeBlockchainReader

Parameters:

• nodeUrl: - The URL of the node to connect to.

🏭 NullNetworkProvider

This is the dummy external provider for nodes.

🏭 ProviderFactory

Factory class for creating instances of the Provider class with various configurations.

Static Methods

• createInMemoryProvider
• createInMemoryProviderWithExternalProvider
• createKeyedProviderExternalProvider

⚙ createInMemoryProvider

Creates and returns an in-memory provider instance. This provider utilizes a memory storage backend without network provider.

Method	Type
createInMemoryProvider	() => Provider

⚙ createInMemoryProviderWithExternalProvider

Creates an in-memory provider that works in conjunction with an external network provider.

Method	Type
createInMemoryProviderWithExternalProvider	(nodeUrl: string) => Provider

⚙ createKeyedProviderExternalProvider

Creates a keyed provider using an external network provider. The provider contains a built-in in-memory provider to handle cache.

Method	Type
createKeyedProviderExternalProvider	(privateKey: PrivateSignatureKey, nodeUrl: string) => Provider

Parameters:

• privateKey: - The private signature key used for signing or authentication.
• nodeUrl: - The URL of the external network node provider.

🏭 ABCINodeBlockchainWriter

Static Methods

• createWriter

⚙ createWriter

Method	Type
createWriter	(reader: BlockchainReader, nodeUrl: string, privateKey: PrivateSignatureKey) => ABCINodeBlockchainWriter

🏭 PublicationExecutionContext

Methods

• getGasPrice
• getExpirationDay
• withGasPrice
• withExpirationOn
• withExpirationIn

⚙ getGasPrice

Method	Type
getGasPrice	() => CMTSToken

⚙ getExpirationDay

Method	Type
getExpirationDay	() => number

⚙ withGasPrice

Method	Type
withGasPrice	(gasPrice: CMTSToken) => this

⚙ withExpirationOn

Method	Type
withExpirationOn	(year: number, month: number, day: number) => this

⚙ withExpirationIn

Method	Type
withExpirationIn	(days: number) => this

🏭 OrganizationPublicationExecutionContext

Represents the execution context specific to an organization's publication process. This class extends the base functionality provided by the PublicationExecutionContext to introduce organization-related context and processing behaviors.

The OrganizationPublicationExecutionContext class is designed to handle execution logic relating to publications scoped to an organization. It may include additional information, configurations, or methods tailored for handling publication requirements and behaviors within an organizational structure or context.

This class may interact with organizational data, apply rules, or influence the execution environment in a way that aligns with organizational publication processes.

Extends:

• PublicationExecutionContext: This class extends the base functionality provided by the PublicationExecutionContext. It inherits all the core functionalities while allowing additional organization-specific modifications or extensions.

Methods

• withExistingOrganizationId
• withName
• withCity
• withCountryCode
• withWebsite
• build

⚙ withExistingOrganizationId

Specifies that publication is being performed on an existing organization.

If the organization is not found, publication will fail.

Method	Type
withExistingOrganizationId	(organizationId: Hash) => OrganizationPublicationExecutionContext

⚙ withName

Method	Type
withName	(name: string) => OrganizationPublicationExecutionContext

⚙ withCity

Method	Type
withCity	(city: string) => OrganizationPublicationExecutionContext

⚙ withCountryCode

Method	Type
withCountryCode	(countryCode: string) => OrganizationPublicationExecutionContext

⚙ withWebsite

Method	Type
withWebsite	(website: string) => OrganizationPublicationExecutionContext

⚙ build

Method	Type
build	() => { existingOrganizationId: Optional<Hash>; name: string; city: string; countryCode: string; website: string; }

🏭 AccountPublicationExecutionContext

Represents the execution context tailored for account publication-related operations. Extends the functionality of PublicationExecutionContext.

This class is designed to provide specific mechanisms and configurations required during the account publication execution process.

It inherits common behaviors and properties from the PublicationExecutionContext class, while potentially adding additional context or logic specific to account publications.

Intended to encapsulate context details, including metadata and operational configurations, that are necessary for managing account-specific publication workflows.

Methods

• getSellerAccount
• getBuyerPublicKey
• getInitialBuyerAccountAmount
• withSellerAccount
• withBuyerPublicKey
• withInitialBuyerAccountAmount

⚙ getSellerAccount

Method	Type
getSellerAccount	() => Hash

⚙ getBuyerPublicKey

Method	Type
getBuyerPublicKey	() => PublicSignatureKey

⚙ getInitialBuyerAccountAmount

Method	Type
getInitialBuyerAccountAmount	() => CMTSToken

⚙ withSellerAccount

Method	Type
withSellerAccount	(sellerAccount: Hash) => AccountPublicationExecutionContext

⚙ withBuyerPublicKey

Method	Type
withBuyerPublicKey	(buyerPublicKey: PublicSignatureKey) => AccountPublicationExecutionContext

⚙ withInitialBuyerAccountAmount

Method	Type
withInitialBuyerAccountAmount	(initialBuyerAccountAmount: CMTSToken) => AccountPublicationExecutionContext

🏭 ValidatorNodePublicationExecutionContext

Methods

• withCometPublicKeyType
• withCometPublicKey
• withOrganizationId
• withRpcEndpoint
• build

⚙ withCometPublicKeyType

Method	Type
withCometPublicKeyType	(cometPublicKeyType: string) => ValidatorNodePublicationExecutionContext

⚙ withCometPublicKey

Method	Type
withCometPublicKey	(cometPublicKey: string) => ValidatorNodePublicationExecutionContext

⚙ withOrganizationId

Method	Type
withOrganizationId	(organizationId: Hash) => this

⚙ withRpcEndpoint

Method	Type
withRpcEndpoint	(rpcEndpoint: string) => this

⚙ build

Method	Type
build	() => { organizationId: Optional<Hash>; validatorNodeId: Optional<Hash>; rpcEndpoint: string; cometPublicKeyType: string; cometPublicKey: string; }

🏭 ValidatorNodeNetworkIntegrationPublicationExecutionContext

Methods

• withExistingValidatorNodeId
• withVotingPower
• build

⚙ withExistingValidatorNodeId

Method	Type
withExistingValidatorNodeId	(validatorNodeId: Hash) => ValidatorNodeNetworkIntegrationPublicationExecutionContext

⚙ withVotingPower

Method	Type
withVotingPower	(votingPower: number) => ValidatorNodeNetworkIntegrationPublicationExecutionContext

⚙ build

Method	Type
build	() => { validatorNodeId: Optional<Hash>; votingPower: number; }

🏭 ApplicationPublicationExecutionContext

Methods

• withExistingApplicationId
• withOrganizationId
• withApplicationName
• withWebsite
• withApplicationDescription
• build

⚙ withExistingApplicationId

Method	Type
withExistingApplicationId	(applicationId: Hash) => ApplicationPublicationExecutionContext

⚙ withOrganizationId

Method	Type
withOrganizationId	(organizationId: Hash) => ApplicationPublicationExecutionContext

⚙ withApplicationName

Method	Type
withApplicationName	(applicationName: string) => ApplicationPublicationExecutionContext

⚙ withWebsite

Method	Type
withWebsite	(website: string) => ApplicationPublicationExecutionContext

⚙ withApplicationDescription

Method	Type
withApplicationDescription	(applicationDescription: string) => ApplicationPublicationExecutionContext

⚙ build

Method	Type
build	() => { applicationId: Optional<Hash>; organizationId: Optional<Hash>; applicationName: string; applicationDescription: string; logoUrl: string; homepageUrl: string; }

🏭 ExpirationDate

Static Methods

• endless
• of

⚙ endless

Method	Type
endless	() => ExpirationDate

⚙ of

Method	Type
of	(expirationDate: Date) => ExpirationDate

Methods

• isEndless
• getExpirationDate

⚙ isEndless

Method	Type
isEndless	() => boolean

⚙ getExpirationDate

Method	Type
getExpirationDate	() => Date

🏭 RecordPublicationExecutionContext

Methods

• withRecord
• widthExpirationDate
• getExpirationDate
• build

⚙ withRecord

Method	Type
withRecord	(record: RecordDescription<T>) => RecordPublicationExecutionContext<T>

⚙ widthExpirationDate

Set the expiration date of the virtual blockchain.

Note: An expiration date can only be specified during the creation of the virtual blockchain.

Method	Type
widthExpirationDate	(expirationDate: ExpirationDate) => RecordPublicationExecutionContext<T>

⚙ getExpirationDate

Method	Type
getExpirationDate	() => ExpirationDate

⚙ build

Method	Type
build	() => RecordDescription<T>

🏭 AccountTransferPublicationExecutionContext

Methods

• getBuyerAccount
• getAmount
• getPublicReference
• getPrivateReference
• withTransferToAccountHash
• withTransferToPublicKey
• withAmount
• withPublicReference
• withPrivateReference
• build

⚙ getBuyerAccount

Method	Type
getBuyerAccount	() => Hash

⚙ getAmount

Method	Type
getAmount	() => CMTSToken

⚙ getPublicReference

Method	Type
getPublicReference	() => string

⚙ getPrivateReference

Method	Type
getPrivateReference	() => string

⚙ withTransferToAccountHash

Method	Type
withTransferToAccountHash	(sellerPrivateKey: PrivateSignatureKey, buyerAccount: Hash) => AccountTransferPublicationExecutionContext

⚙ withTransferToPublicKey

Method	Type
withTransferToPublicKey	(sellerPrivateKey: PrivateSignatureKey, buyerPublicKey: PublicSignatureKey) => AccountTransferPublicationExecutionContext

⚙ withAmount

Method	Type
withAmount	(amount: CMTSToken) => AccountTransferPublicationExecutionContext

⚙ withPublicReference

Method	Type
withPublicReference	(publicReference: string) => AccountTransferPublicationExecutionContext

⚙ withPrivateReference

Method	Type
withPrivateReference	(privateReference: string) => AccountTransferPublicationExecutionContext

⚙ build

Method	Type
build	() => { buyerAccount: PublicSignatureKey or Hash; sellerPrivateKey: PrivateSignatureKey; amount: CMTSToken; publicReference: string; privateReference: string; }

🏭 OrganizationWrapper

Methods

• getCity
• getCountryCode
• getWebsite
• getName
• getPublicKey

⚙ getCity

Method	Type
getCity	() => string

⚙ getCountryCode

Method	Type
getCountryCode	() => string

⚙ getWebsite

Method	Type
getWebsite	() => string

⚙ getName

Method	Type
getName	() => string

⚙ getPublicKey

Method	Type
getPublicKey	() => PublicSignatureKey

🏭 ApplicationWrapper

Methods

• getOrganizationId
• getWebsite
• getName
• getDescription
• getLogoUrl

⚙ getOrganizationId

Retrieves the id of the organization managing the application.

Method	Type
getOrganizationId	() => Hash

⚙ getWebsite

Retrieves the homepage URL of the application.

Method	Type
getWebsite	() => string

⚙ getName

Retrieves the name of the application.

Method	Type
getName	() => string

⚙ getDescription

Retrieves the description of the application.

Method	Type
getDescription	() => string

⚙ getLogoUrl

Retrieves the logo URL from the description property.

Method	Type
getLogoUrl	() => string

🏭 ApplicationLedgerWrapper

Methods

• getId
• isActorSubscribed
• getApplicationId

⚙ getId

Method	Type
getId	() => Hash

⚙ isActorSubscribed

Method	Type
isActorSubscribed	(actorName: string) => boolean

⚙ getApplicationId

Method	Type
getApplicationId	() => Hash

🏭 AccountWrapper

Methods

• getId
• getPublicKey

⚙ getId

Method	Type
getId	() => Hash

⚙ getPublicKey

Method	Type
getPublicKey	() => PublicSignatureKey

🏭 RPCNodeWebSocketClient

Static Methods

• new

⚙ new

Method	Type
new	(webSocketURl: string) => RPCNodeWebSocketClient

Methods

• addCallback

⚙ addCallback

Method	Type
addCallback	(callback: RPCNodeWebSocketCallback) => void

🏭 NodeStatusWrapper

Static Methods

• fromStatus

⚙ fromStatus

Method	Type
fromStatus	(status: { jsonrpc: "2.0"; id: number; result: { node_info: { id: string; protocol_version: { p2p: string; block: string; app: string; }; listen_addr: string; network: string; version: string; channels: string; moniker: string; other: { ...; }; }; sync_info: { ...; }; validator_info: { ...; }; }; }) => NodeStatusWra...

Methods

• getChainId
• getNodeName
• isCatchingUp
• getPublicKey
• getCometBFTVersion
• isValidator
• getCometBFTNodePublicKey
• getRpcAddress
• getCometBFTNodePublicKeyType

⚙ getChainId

Method	Type
getChainId	() => string

⚙ getNodeName

Method	Type
getNodeName	() => string

⚙ isCatchingUp

Method	Type
isCatchingUp	() => boolean

⚙ getPublicKey

Method	Type
getPublicKey	() => CometBFTPublicKey

⚙ getCometBFTVersion

Method	Type
getCometBFTVersion	() => string

⚙ isValidator

Method	Type
isValidator	() => boolean

⚙ getCometBFTNodePublicKey

Method	Type
getCometBFTNodePublicKey	() => string

⚙ getRpcAddress

Method	Type
getRpcAddress	() => string

⚙ getCometBFTNodePublicKeyType

Method	Type
getCometBFTNodePublicKeyType	() => string

🏭 MicroBlockWrapper

Static Methods

• createFromMicroBlock

⚙ createFromMicroBlock

Method	Type
createFromMicroBlock	(info: MicroBlockInformation, mb: Microblock) => MicroBlockWrapper

Methods

• getAllSections
• getFeesPayerAccount
• getPreviousHash
• getNumberOfSections
• getGas
• getGasPrice
• getTimestamp
• getMicroBlockHash
• getVirtualBlockchainId
• getHeight

⚙ getAllSections

Method	Type
getAllSections	() => Section<any>[]

⚙ getFeesPayerAccount

Method	Type
getFeesPayerAccount	() => Optional<Hash>

⚙ getPreviousHash

Method	Type
getPreviousHash	() => Hash

⚙ getNumberOfSections

Method	Type
getNumberOfSections	() => number

⚙ getGas

Method	Type
getGas	() => CMTSToken

⚙ getGasPrice

Method	Type
getGasPrice	() => CMTSToken

⚙ getTimestamp

Method	Type
getTimestamp	() => Date

⚙ getMicroBlockHash

Method	Type
getMicroBlockHash	() => Hash

⚙ getVirtualBlockchainId

Method	Type
getVirtualBlockchainId	() => Hash

⚙ getHeight

Method	Type
getHeight	() => number

🏭 BlockchainFacade

The BlockchainFacade class provides a high-level interface for interacting with a blockchain. It encapsulates several functionalities such as retrieving application and organization descriptions, managing accounts, and handling keys.

Implements the BlockchainFacadeInterface.

Static Methods

• createFromNodeUrl
• createWebSocketForNode
• createFromNodeUrlAndPrivateKey

⚙ createFromNodeUrl

Creates an instance of BlockchainFacade using the provided node URL.

Method	Type
createFromNodeUrl	(nodeUrl: string) => BlockchainFacade

Parameters:

• nodeUrl: - The URL of the blockchain node to connect to.

⚙ createWebSocketForNode

Creates and initializes a WebSocket client for a specified node URL.

Method	Type
createWebSocketForNode	(wsNodeUrl: string) => RPCNodeWebSocketClient

Parameters:

• wsNodeUrl: - The WebSocket URL of the node to connect to.

⚙ createFromNodeUrlAndPrivateKey

Creates an instance of BlockchainFacade using the provided node URL and private signature key.

Method	Type
createFromNodeUrlAndPrivateKey	(nodeUrl: string, privateKey: PrivateSignatureKey) => BlockchainFacade

Parameters:

• nodeUrl: - The URL of the blockchain node to connect to.
• privateKey: - The private signature key for authentication and signing transactions.

Methods

• getAccountBalance
• getAccountHistory
• getPublicKeyOfIssuer

⚙ getAccountBalance

Method	Type
getAccountBalance	(accountHash: Hash) => Promise<CMTSToken>

⚙ getAccountHistory

Method	Type
getAccountHistory	(accountHash: Hash) => Promise<AccountHistoryView>

⚙ getPublicKeyOfIssuer

Retrieves the public signature key of the issuer.

Method	Type
getPublicKeyOfIssuer	() => Promise<PublicSignatureKey>

🏭 ServerNetworkProvider

🏭 MessageManager

🏭 Wallet

The Wallet class is responsible for generating and managing cryptographic keys based on a provided wallet seed. It provides methods to retrieve private signature keys, decapsulation keys, and keys specific to virtual blockchains.

Static Methods

• generateWallet
• fromSeed

⚙ generateWallet

Generates a new Wallet instance using a randomly generated seed.

Method	Type
generateWallet	() => Wallet

⚙ fromSeed

Method	Type
fromSeed	(seed: Uint8Array<ArrayBufferLike>) => Wallet

Methods

• getDecapsulationKey
• getAccountPrivateSignatureKey
• getActorPrivateSignatureKey
• getVirtualBlockchainDecapsulationKey

⚙ getDecapsulationKey

Retrieves the decapsulation key for a given cryptographic scheme ID.

Method	Type
getDecapsulationKey	(schemeId: number) => DecapsulationKey

Parameters:

• schemeId: - The identifier of the cryptographic scheme for which the decapsulation key is needed.

⚙ getAccountPrivateSignatureKey

Method	Type
getAccountPrivateSignatureKey	(schemeId: SignatureAlgorithmId, nonce: number) => PrivateSignatureKey

⚙ getActorPrivateSignatureKey

Method	Type
getActorPrivateSignatureKey	(schemeId: number, vbSeed: Uint8Array<ArrayBufferLike>, nonce: number) => PrivateSignatureKey

⚙ getVirtualBlockchainDecapsulationKey

Retrieves the virtual blockchain decapsulation key using the specified scheme ID and virtual blockchain seed.

Method	Type
getVirtualBlockchainDecapsulationKey	(schemeId: number, vbSeed: Uint8Array<ArrayBufferLike>) => DecapsulationKey

Parameters:

• schemeId: - The identifier of the cryptographic scheme to be used for generating the key.
• vbSeed: - The virtual blockchain seed

🏭 SectionWrapper

Static Methods

• wrap

⚙ wrap

Method	Type
wrap	(section: Section<any>) => SectionWrapper

Methods

• getSizeInBytes
• getSectionId
• getSectionHash

⚙ getSizeInBytes

Method	Type
getSizeInBytes	() => number

⚙ getSectionId

Method	Type
getSectionId	() => number

⚙ getSectionHash

Method	Type
getSectionHash	() => Hash

🔩 Enum

• SectionType
• SignatureAlgorithmId
• SymmetricEncryptionAlgorithmId
• KeyExchangeAlgorithmId
• CryptographicHashAlgorithmId
• PasswordBasedKeyDerivationFunctionAlgorithmId
• KeyDerivationFunctionAlgorithmId
• PublicKeyEncryptionAlgorithmId
• CarmentisErrorCode
• VirtualBlockchainType
• TokenUnit
• TokenUnitLabel
• CometBFTErrorCode

⚙ SectionType

Property	Type	Description
ACCOUNT_SIG_ALGORITHM	0
ACCOUNT_PUBLIC_KEY	1
ACCOUNT_TOKEN_ISSUANCE	2
ACCOUNT_CREATION	3
ACCOUNT_TRANSFER	4
ACCOUNT_SIGNATURE	5
ORG_SIG_ALGORITHM	10
ORG_PUBLIC_KEY	11
ORG_DESCRIPTION	12
ORG_SERVER	13
ORG_SIGNATURE	14
APP_SIG_ALGORITHM	20
APP_DECLARATION	21
APP_DESCRIPTION	22
APP_SIGNATURE	23
APP_LEDGER_SIG_ALGORITHM	30
APP_LEDGER_PKE_ALGORITHM	31
APP_LEDGER_DECLARATION	32
APP_LEDGER_ACTOR_CREATION	33
APP_LEDGER_CHANNEL_CREATION	34
APP_LEDGER_SHARED_SECRET	35
APP_LEDGER_CHANNEL_INVITATION	36
APP_LEDGER_ACTOR_SUBSCRIPTION	37
APP_LEDGER_PUBLIC_CHANNEL_DATA	38
APP_LEDGER_PRIVATE_CHANNEL_DATA	39
APP_LEDGER_AUTHOR	40
APP_LEDGER_ENDORSER	41
APP_LEDGER_ENDORSER_SIGNATURE	42
APP_LEDGER_AUTHOR_SIGNATURE	43

⚙ SignatureAlgorithmId

An enumeration representing the identifiers for different signature algorithms. This enum is used to indicate the type of cryptographic signature algorithm being utilized.

Enum members:

• SECP256K1: Indicates the SECP256K1 signature algorithm, typically associated with elliptic-curve cryptography.
• ML_DSA_65: Represents the ML-DSA-65 signature algorithm.

Property	Type	Description
SECP256K1	0
ML_DSA_65	1

⚙ SymmetricEncryptionAlgorithmId

Enumeration representing identifiers for symmetric encryption algorithms.

This enum is used to specify the symmetric encryption algorithm to be utilized, enabling cryptographic operations such as encryption and decryption with specific algorithmic requirements. It currently supports the following algorithm:

• AES-256-GCM: Advanced Encryption Standard with a 256-bit key in Galois/Counter Mode.

The identifiers in this enum can be utilized to indicate the intended algorithm within encryption workflows or cryptographic libraries requiring algorithm specification.

Property	Type	Description
AES_256_GCM	``

⚙ KeyExchangeAlgorithmId

Property	Type	Description
ML_KEM	``

⚙ CryptographicHashAlgorithmId

Property	Type	Description
SHA256	``

⚙ PasswordBasedKeyDerivationFunctionAlgorithmId

Property	Type	Description
PBKDF2	``

⚙ KeyDerivationFunctionAlgorithmId

Property	Type	Description
HKDF	``

⚙ PublicKeyEncryptionAlgorithmId

Property	Type	Description
ML_KEM_768_AES_256_GCM	``

⚙ CarmentisErrorCode

Property	Type	Description
CARMENTIS_ERROR	0
NODE_ERROR	1
NODE_NOT_AVAILABLE_DURING_SYNCHRONISATION_ERROR	2
INTERNAL_ERROR	500
TYPE_CHECKING_FAILURE_ERROR	501
PROOF_VERIFICATION_FAILURE	300
BLOCKCHAIN_ERROR	100
ACCOUNT_NOT_FOUND	``
ACCOUNT_ALREADY_EXISTS	``
ACCOUNT_NOT_FOUND_FOR_PUBLIC_KEY	``
ACCOUNT_NOT_FOUND_FOR_PUBLIC_KEY_HASH	``
ACCOUNT_ALREADY_EXISTS_FOR_PUBLIC_KEY	``
ACCOUNT_NOT_FOUND_FOR_ADDRESS	``
ORGANIZATION_NOT_FOUND	``
APPLICATION_NOT_FOUND	``
APPLICATION_LEDGER_NOT_FOUND	``
VALIDATOR_NODE_NOT_FOUND	``
VIRTUAL_BLOCKCHAIN_NOT_FOUND	``
VIRTUAL_BLOCKCHAIN_ALREADY_EXISTS	``
ECONOMICS_ERROR	200
INVALID_TOKEN_UNIT	``

⚙ VirtualBlockchainType

Property	Type	Description
ACCOUNT_VIRTUAL_BLOCKCHAIN	VB_ACCOUNT
NODE_VIRTUAL_BLOCKCHAIN	VB_VALIDATOR_NODE
APPLICATION_VIRTUAL_BLOCKCHAIN	VB_APPLICATION
ORGANIZATION_VIRTUAL_BLOCKCHAIN	VB_ORGANIZATION
APP_LEDGER_VIRTUAL_BLOCKCHAIN	VB_APP_LEDGER

⚙ TokenUnit

Enum representing the units of a tokenized system.

TokenUnit defines multiple denominations of a token, where each denomination is represented by a numeric value that corresponds to the fractional relationship with the base unit.

Properties:

• TOKEN: The base unit of the system. Equals 1.
• CENTI_TOKEN: Represents one-hundredth (1/100) of the base unit. Equals 100.
• MILLI_TOKEN: Represents one-thousandth (1/1000) of the base unit. Equals 1000.

This enum can be used for token denomination conversions and comparisons.

Property	Type	Description
TOKEN	100_000
DECI_TOKEN	10_000
CENTI_TOKEN	1_000
MILLI_TOKEN	100
MICRO_TOKEN	10
ATOMIC	1

⚙ TokenUnitLabel

Enum representing token unit labels.

This enum is used to define a label for tokens, where each key represents the name of the label and its associated value represents the specific token unit.

The TokenUnitLabel provides a standardized way to represent token-related labels in the application.

Enum Members:

• TOKEN: Represents the token unit labeled as 'CMTS'.

Typically used in contexts where token structure or labeling standardization is required.

Property	Type	Description
TOKEN	'CMTS'
DECI_TOKEN	'dCMTS'
CENTI_TOKEN	'cCMTS'
MILLI_TOKEN	'mCMTS'
MICRO_TOKEN	'μCMTS'
ATOMIC	'aCMTS'

⚙ CometBFTErrorCode

Property	Type	Description
PARSE_ERROR	-32700
INVALID_REQUEST	-32600
METHOD_NOT_FOUND	-32601
INVALID_PARAMS	-32602
INTERNAL_ERROR	-32603
ENDPOINT_CLOSED_WHILE_NODE_IS_CATCHING_UP	-32603
TX_ALREADY_EXISTS	-32003
TX_OUT_OF_GAS	-32002
TX_CHECK_FAILED	-32001
TX_DELIVER_FAILED	-32000

🍹 Interfaces

• SchemaItem
• Schema
• EncoderInterface
• SignatureScheme
• PrivateSignatureKey
• PublicSignatureKey
• SymmetricEncryptionKeyScheme
• SymmetricEncryptionKey
• DecapsulationKey
• EncapsulationKey
• EncapsulationKeyEncoder
• CryptographicHash
• SignatureEncoderInterface
• ImportedProof
• RecordEntry
• Property
• MerkleProof
• AccountVBState
• ApplicationDescription
• ApplicationDeclaration
• OrganizationDescription
• ValidatorNodeDescription
• ValidatorNodeRpcEndpoint
• ValidatorNodeNetworkIntegration
• ValidatorNodeDeclaration
• OrganizationVBState
• ValidatorNodeVBState
• ApplicationVBState
• ApplicationLedgeChannel
• ApplicationLedgerActor
• ApplicationLedgerVBState
• GenesisSnapshotDTO
• ChainInformationDTO
• BlockInformationDTO
• BlockContentDTO
• ValidatorNodeDTO
• MicroblockHeader
• MicroblockSection
• MicroblockBody
• MicroblockInformationSchema
• MicroBlockBody
• MicroBlockBodys
• VirtualBlockchainUpdateInterface
• VirtualBlockchainStateDTO
• VirtualBlockchainStateInterface
• MicroBlockHeader
• MsgVirtualBlockchainState
• AccountStateDTO
• AccountHash
• AccountTransactionInterface
• AccountHistoryInterface
• AccountTokenIssuance
• AccountCreation
• AccountTransfer
• ObjectList
• Proof
• Section
• MicroBlockHeaderDto
• Currency
• RecordActor
• RecordChannel
• RecordChannelAssignation
• RecordActorAssignation
• RecordMaskedPart
• RecordMaskableField
• RecordHashableField
• RecordDescription
• BlockchainReader
• PublicEncryptionKeyEncoderInterface
• PrivateDecryptionKeyEncoderInterface
• PkeEncoderInterface
• SignatureCacheInterface
• CurrencyConverter
• BlockchainWriter

⚙ SchemaItem

Property	Type	Description
name	string
type	number
size	number or undefined
schema	Schema or undefined
definition	SchemaItem[] or undefined
optional	boolean or undefined
unspecifiedSchema	boolean or undefined

⚙ Schema

Property	Type	Description
label	string
definition	SchemaItem[]

⚙ EncoderInterface

Interface representing a generic encoder capable of encoding and decoding data.

Property	Type	Description

⚙ SignatureScheme

Represents a cryptographic signature scheme with methods to retrieve identifying information and utilities for encoding public keys.

Property	Type	Description

⚙ PrivateSignatureKey

Represents a private signature key utilized in cryptographic operations.

This interface extends the SignatureScheme and provides functionality to generate a corresponding public key and to sign data.

Property	Type	Description

⚙ PublicSignatureKey

Represents a public signature key adhering to a specific signature scheme. This interface provides methods to verify digital signatures and fetch the raw public key.

Property	Type	Description

Returns:

• Returns true if the signature is valid for the data, false otherwise. - The raw bytes of the public key.

⚙ SymmetricEncryptionKeyScheme

Property	Type	Description

⚙ SymmetricEncryptionKey

Represents a symmetric encryption key capable of performing encryption and decryption operations, as well as providing the associated encryption algorithm identifier and raw key.

Property	Type	Description

⚙ DecapsulationKey

Property	Type	Description

⚙ EncapsulationKey

Property	Type	Description

⚙ EncapsulationKeyEncoder

Property	Type	Description

⚙ CryptographicHash

Property	Type	Description

⚙ SignatureEncoderInterface

An interface for encoding and decoding cryptographic signature keys and signatures.

Provides methods to encode and decode public keys, private keys, and signatures into or from a specified format T.

Property	Type	Description

⚙ ImportedProof

Property	Type	Description
height	number
data	{ recordData: RecordEntry[]; merkleData: MerkleProof[]; }

⚙ RecordEntry

Property	Type	Description
type	number
name	string
properties	Property[]
channels	Record<string, unknown>

⚙ Property

Property	Type	Description
type	number
name	string
attributes	number or undefined
channelId	number or undefined
leafIndex	number or undefined
salt	string or undefined
value	string or undefined
valueBinary	{ [key: string]: number; } or undefined
entries	Property[] or undefined
properties	Property[] or undefined
channels	Record<string, unknown>
index	number or undefined

⚙ MerkleProof

Property	Type	Description
channelId	number
nLeaves	number
witnesses	string

⚙ AccountVBState

Property	Type	Description
signatureAlgorithmId	number
publicKeyHeight	number

⚙ ApplicationDescription

Property	Type	Description
name	string
logoUrl	string
homepageUrl	string
description	string

⚙ ApplicationDeclaration

Property	Type	Description
organizationId	Uint8Array<ArrayBufferLike>

⚙ OrganizationDescription

Property	Type	Description
name	string
city	string
countryCode	string
website	string

⚙ ValidatorNodeDescription

Property	Type	Description
cometPublicKeyType	string
cometPublicKey	string

⚙ ValidatorNodeRpcEndpoint

Property	Type	Description
rpcEndpoint	string

⚙ ValidatorNodeNetworkIntegration

Property	Type	Description
votingPower	number

⚙ ValidatorNodeDeclaration

Property	Type	Description
organizationId	Uint8Array<ArrayBufferLike>

⚙ OrganizationVBState

Property	Type	Description
signatureAlgorithmId	number
publicKeyHeight	number
descriptionHeight	number

⚙ ValidatorNodeVBState

Property	Type	Description
signatureAlgorithmId	number
organizationId	Uint8Array<ArrayBufferLike>
descriptionHeight	number
rpcEndpointHeight	number
networkIntegrationHeight	number

⚙ ApplicationVBState

Property	Type	Description
signatureAlgorithmId	number
organizationId	Uint8Array<ArrayBufferLike>
descriptionHeight	number

⚙ ApplicationLedgeChannel

Property	Type	Description
name	string
isPrivate	boolean
creatorId	number

⚙ ApplicationLedgerActor

Property	Type	Description
name	string
subscribed	boolean
invitations	{ channelId: number; height: number; }[]

⚙ ApplicationLedgerVBState

Property	Type	Description
signatureAlgorithmId	number
applicationId	Uint8Array<ArrayBufferLike>
channels	ApplicationLedgeChannel[]
actors	ApplicationLedgerActor[]

⚙ GenesisSnapshotDTO

Describes the genesis snapshot which contains base64-encoded chunks.

Property	Type	Description
base64EncodedChunks	string[]

⚙ ChainInformationDTO

Provides information on the chain.

Property	Type	Description
height	number
lastBlockTimestamp	number
microblockCount	number
objectCounts	number[]

⚙ BlockInformationDTO

Property	Type	Description
hash	Uint8Array<ArrayBufferLike>
timestamp	number
proposerAddress	Uint8Array<ArrayBufferLike>
size	number
microblockCount	number

⚙ BlockContentDTO

Property	Type	Description
microblocks	{ hash: Uint8Array<ArrayBufferLike>; vbIdentifier: Uint8Array<ArrayBufferLike>; vbType: number; height: number; size: number; sectionCount: number; }[]

⚙ ValidatorNodeDTO

Property	Type	Description
validatorNodeHash	Uint8Array<ArrayBufferLike>

⚙ MicroblockHeader

Property	Type	Description
magicString	string
protocolVersion	number
height	number
previousHash	Uint8Array<ArrayBufferLike>
timestamp	number
gas	number
gasPrice	number
bodyHash	Uint8Array<ArrayBufferLike>

⚙ MicroblockSection

Property	Type	Description
type	number
data	Uint8Array<ArrayBufferLike>

⚙ MicroblockBody

Property	Type	Description
body	MicroblockSection[]

⚙ MicroblockInformationSchema

Property	Type	Description
virtualBlockchainId	Uint8Array<ArrayBufferLike>
virtualBlockchainType	number
header	Uint8Array<ArrayBufferLike>

⚙ MicroBlockBody

Property	Type	Description
hash	Uint8Array<ArrayBufferLike>
body	Uint8Array<ArrayBufferLike>

⚙ MicroBlockBodys

Property	Type	Description
list	MicroBlockBody[]

⚙ VirtualBlockchainUpdateInterface

Property	Type	Description
exists	boolean
changed	boolean
stateData	Uint8Array<ArrayBufferLike>
headers	Uint8Array<ArrayBufferLike>[]

⚙ VirtualBlockchainStateDTO

Property	Type	Description
type	number
height	number
lastMicroblockHash	Uint8Array<ArrayBufferLike>
customState	CustomState

⚙ VirtualBlockchainStateInterface

Property	Type	Description
type	number
height	number
expirationDay	number
lastMicroblockHash	Uint8Array<ArrayBufferLike>
customState	CustomState

⚙ MicroBlockHeader

Property	Type	Description
magicString	string
protocolVersion	number
height	number
previousHash	Uint8Array<ArrayBufferLike>
timestamp	number
gas	number
gasPrice	number
bodyHash	Uint8Array<ArrayBufferLike>

⚙ MsgVirtualBlockchainState

Property	Type	Description
stateData	Uint8Array<ArrayBufferLike>

⚙ AccountStateDTO

Property	Type	Description
height	number
balance	number
lastHistoryHash	Uint8Array<ArrayBufferLike>

⚙ AccountHash

Property	Type	Description
accountHash	Uint8Array<ArrayBufferLike>

⚙ AccountTransactionInterface

Property	Type	Description
height	number
previousHistoryHash	Uint8Array<ArrayBufferLike>
type	number
timestamp	number
linkedAccount	Uint8Array<ArrayBufferLike>
amount	number
chainReference	Uint8Array<ArrayBufferLike>

⚙ AccountHistoryInterface

Property	Type	Description
list	AccountTransactionInterface[]

⚙ AccountTokenIssuance

Property	Type	Description
amount	number

⚙ AccountCreation

Property	Type	Description
sellerAccount	Uint8Array<ArrayBufferLike>
amount	number

⚙ AccountTransfer

Property	Type	Description
account	Uint8Array<ArrayBufferLike>
amount	number
publicReference	string
privateReference	string

⚙ ObjectList

Property	Type	Description
list	Uint8Array<ArrayBufferLike>[]

⚙ Proof

Property	Type	Description
info	{ title: string; date: string; author: string; virtualBlockchainIdentifier: string; }
proofs	{ height: number; data: any; }[]

⚙ Section

Property	Type	Description
type	number
object	T
data	Uint8Array<ArrayBufferLike>
hash	Uint8Array<ArrayBufferLike>
index	number

⚙ MicroBlockHeaderDto

Property	Type	Description
magicString	string
protocolVersion	number
height	number
previousHash	Uint8Array<ArrayBufferLike>
timestamp	number
gas	number
gasPrice	number
bodyHash	Uint8Array<ArrayBufferLike>

⚙ Currency

Property	Type	Description

⚙ RecordActor

Property	Type	Description
name	string

⚙ RecordChannel

Property	Type	Description
name	string
public	boolean

⚙ RecordChannelAssignation

Property	Type	Description
fieldPath	string
channelName	string

⚙ RecordActorAssignation

Property	Type	Description
actorName	string
channelName	string

⚙ RecordMaskedPart

Property	Type	Description
position	number
length	number
replacementString	string

⚙ RecordMaskableField

Property	Type	Description
fieldPath	string
maskedParts	RecordMaskedPart[]

⚙ RecordHashableField

Property	Type	Description
fieldPath	string

⚙ RecordDescription

Property	Type	Description
applicationId	string	Links the record to an application.
virtualBlockchainId	string or undefined	Links the record to an existing transactional flow. When omitted, the record is put in a new virtual blockchain.
data	DataType
actors	RecordActor[] or undefined
channels	RecordChannel[] or undefined
channelAssignations	RecordChannelAssignation[] or undefined
actorAssignations	RecordActorAssignation[] or undefined
hashableFields	RecordHashableField[] or undefined
maskableFields	RecordMaskableField[] or undefined
author	string
endorser	string or undefined

⚙ BlockchainReader

Property	Type	Description

⚙ PublicEncryptionKeyEncoderInterface

Property	Type	Description

⚙ PrivateDecryptionKeyEncoderInterface

Property	Type	Description

⚙ PkeEncoderInterface

Property	Type	Description

⚙ SignatureCacheInterface

Property	Type	Description

⚙ CurrencyConverter

Represents a generic interface for converting currency values from one type to another.

Property	Type	Description

⚙ BlockchainWriter

Property	Type	Description

🍸 Types

• Height
• RPCNodeStatusResponseType
• OperatorAnchorRequest
• NewBlockEventType
• RPCNodeWebSocketCallback

⚙ Height

Defines the height in a (virtual) blockchain.

Both the height of a block in the blockchain and a micro-block in a virtual blockchain is a strictly positive integer starting at 1 for the first block.

Type	Type
Height	PositiveInt

⚙ RPCNodeStatusResponseType

Type	Type
RPCNodeStatusResponseType	z.infer<typeof RPCNodeStatusResponseSchema>

⚙ OperatorAnchorRequest

Type	Type
OperatorAnchorRequest	Omit<RecordDescription, 'applicationId'> and { approvalMessage: string }

⚙ NewBlockEventType

Type	Type
NewBlockEventType	z.infer<typeof NewBlockEventSchema>

⚙ RPCNodeWebSocketCallback

Type	Type
RPCNodeWebSocketCallback	{ onNewBlock?: (event: NewBlockEventType) => void }