Module abi
Module abi
Provides message encoding and decoding according to the ABI specification.
Functions
encode_message_body – Encodes message body according to ABI function call.
attach_signature_to_message_body
encode_message – Encodes an ABI-compatible message
encode_internal_message – Encodes an internal ABI-compatible message
attach_signature – Combines hex
-encoded signature
with base64
-encoded unsigned_message
. Returns signed message encoded in base64
.
decode_message – Decodes message body using provided message BOC and ABI.
decode_message_body – Decodes message body using provided body BOC and ABI.
encode_account – Creates account state BOC
decode_account_data – Decodes account data using provided data BOC and ABI.
update_initial_data – Updates initial account data with initial values for the contract's static variables and owner's public key. This operation is applicable only for initial account data (before deploy). If the contract is already deployed, its data doesn't contain this data section any more.
encode_initial_data – Encodes initial account data with initial values for the contract's static variables and owner's public key into a data BOC that can be passed to encode_tvc
function afterwards.
decode_initial_data – Decodes initial values of a contract's static variables and owner's public key from account initial data This operation is applicable only for initial account data (before deploy). If the contract is already deployed, its data doesn't contain this data section any more.
decode_boc – Decodes BOC into JSON as a set of provided parameters.
encode_boc – Encodes given parameters in JSON into a BOC using param types from ABI.
calc_function_id – Calculates contract function ID by contract ABI
get_signature_data – Extracts signature from message body and calculates hash to verify the signature
Types
FunctionHeader – The ABI function header.
SignerNoneVariant – No keys are provided.
SignerExternalVariant – Only public key is provided in unprefixed hex string format to generate unsigned message and data_to_sign
which can be signed later.
SignerKeysVariant – Key pair is provided for signing
SignerSigningBoxVariant – Signing Box interface is provided for signing, allows Dapps to sign messages using external APIs, such as HSM, cold wallet, etc.
ParamsOfAttachSignatureToMessageBody
ResultOfAttachSignatureToMessageBody
Functions
encode_message_body
Encodes message body according to ABI function call.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABI.call_set
: CallSet – Function call parameters. Must be specified in non deploy message. In case of deploy message contains parameters of constructor.is_internal
: boolean – True if internal message body must be encoded.signer
: Signer – Signing parameters.processing_try_index
?: number – Processing try index. Used in message processing with retries. Encoder uses the provided try index to calculate message expiration time. Expiration timeouts will grow with every retry. Default value is 0.address
?: string – Destination address of the message Since ABI version 2.3 destination address of external inbound message is used in message body signature calculation. Should be provided when signed external inbound message body is created. Otherwise can be omitted.signature_id
?: number – Signature ID to be used in data to sign preparing when CapSignatureWithId capability is enabled
Result
body
: string – Message body BOC encoded withbase64
.data_to_sign
?: string – Optional data to sign. Encoded withbase64
. Presents whenmessage
is unsigned. Can be used for external message signing. Is this case you need to sing this data and produce signed message usingabi.attach_signature
.
attach_signature_to_message_body
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABIpublic_key
: string – Public key. Must be encoded withhex
.message
: string – Unsigned message body BOC. Must be encoded withbase64
.signature
: string – Signature. Must be encoded withhex
.
Result
body
: string
encode_message
Encodes an ABI-compatible message
Allows to encode deploy and function call messages, both signed and unsigned.
Use cases include messages of any possible type:
deploy with initial function call (i.e.
constructor
or any other function that is used for some kind of initialization);deploy without initial function call;
signed/unsigned + data for signing.
Signer
defines how the message should or shouldn't be signed:
Signer::None
creates an unsigned message. This may be needed in case of some public methods, that do not require authorization by pubkey.
Signer::External
takes public key and returns data_to_sign
for later signing. Use attach_signature
method with the result signature to get the signed message.
Signer::Keys
creates a signed message with provided key pair.
[SOON] Signer::SigningBox
Allows using a special interface to implement signing without private key disclosure to SDK. For instance, in case of using a cold wallet or HSM, when application calls some API to sign data.
There is an optional public key can be provided in deploy set in order to substitute one in TVM file.
Public key resolving priority:
Public key from deploy set.
Public key, specified in TVM file.
Public key, provided by signer.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABI.address
?: string – Target address the message will be sent to. Must be specified in case of non-deploy message.deploy_set
?: DeploySet – Deploy parameters. Must be specified in case of deploy message.call_set
?: CallSet – Function call parameters. Must be specified in case of non-deploy message. In case of deploy message it is optional and contains parameters of the functions that will to be called upon deploy transaction.signer
: Signer – Signing parameters.processing_try_index
?: number – Processing try index. Used in message processing with retries (if contract's ABI includes "expire" header). Encoder uses the provided try index to calculate message expiration time. The 1st message expiration time is specified in Client config. Expiration timeouts will grow with every retry. Retry grow factor is set in Client config: <.....add config parameter with default value here> Default value is 0.signature_id
?: number – Signature ID to be used in data to sign preparing when CapSignatureWithId capability is enabled
Result
message
: string – Message BOC encoded withbase64
.data_to_sign
?: string – Optional data to be signed encoded inbase64
. Returned in case ofSigner::External
. Can be used for external message signing. Is this case you need to use this data to create signature and then produce signed message usingabi.attach_signature
.address
: string – Destination address.message_id
: string – Message id.
encode_internal_message
Encodes an internal ABI-compatible message
Allows to encode deploy and function call messages.
Use cases include messages of any possible type:
deploy with initial function call (i.e.
constructor
or any other function that is used for some kind of initialization);deploy without initial function call;
simple function call
There is an optional public key can be provided in deploy set in order to substitute one in TVM file.
Public key resolving priority:
Public key from deploy set.
Public key, specified in TVM file.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
?: Abi – Contract ABI. Can be None if both deploy_set and call_set are None.address
?: string – Target address the message will be sent to. Must be specified in case of non-deploy message.src_address
?: string – Source address of the message.deploy_set
?: DeploySet – Deploy parameters. Must be specified in case of deploy message.call_set
?: CallSet – Function call parameters. Must be specified in case of non-deploy message. In case of deploy message it is optional and contains parameters of the functions that will to be called upon deploy transaction.value
: string – Value in nanotokens to be sent with message.bounce
?: boolean – Flag of bounceable message. Default is true.enable_ihr
?: boolean – Enable Instant Hypercube Routing for the message. Default is false.
Result
message
: string – Message BOC encoded withbase64
.address
: string – Destination address.message_id
: string – Message id.
attach_signature
Combines hex
-encoded signature
with base64
-encoded unsigned_message
. Returns signed message encoded in base64
.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABIpublic_key
: string – Public key encoded inhex
.message
: string – Unsigned message BOC encoded inbase64
.signature
: string – Signature encoded inhex
.
Result
message
: string – Signed message BOCmessage_id
: string – Message ID
decode_message
Decodes message body using provided message BOC and ABI.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – contract ABImessage
: string – Message BOCallow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)function_name
?: string – Function name or function id if is known in advancedata_layout
?: DataLayout
Result
body_type
: MessageBodyType – Type of the message body content.name
: string – Function or event name.value
?: any – Parameters or result value.header
?: FunctionHeader – Function header.
decode_message_body
Decodes message body using provided body BOC and ABI.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABI used to decode.body
: string – Message body BOC encoded inbase64
.is_internal
: boolean – True if the body belongs to the internal message.allow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)function_name
?: string – Function name or function id if is known in advancedata_layout
?: DataLayout
Result
body_type
: MessageBodyType – Type of the message body content.name
: string – Function or event name.value
?: any – Parameters or result value.header
?: FunctionHeader – Function header.
encode_account
Creates account state BOC
NOTE: Sync version is available only for lib-node
binding.
Parameters
state_init
: string – Account state init.balance
?: bigint – Initial balance.last_trans_lt
?: bigint – Initial value for thelast_trans_lt
.last_paid
?: number – Initial value for thelast_paid
.boc_cache
?: BocCacheType – Cache type to put the result. The BOC itself returned if no cache type provided
Result
account
: string – Account BOC encoded inbase64
.id
: string – Account ID encoded inhex
.
decode_account_data
Decodes account data using provided data BOC and ABI.
Note: this feature requires ABI 2.1 or higher.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABIdata
: string – Data BOC or BOC handleallow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)
Result
data
: any – Decoded data as a JSON structure.
update_initial_data
Updates initial account data with initial values for the contract's static variables and owner's public key. This operation is applicable only for initial account data (before deploy). If the contract is already deployed, its data doesn't contain this data section any more.
Doesn't support ABI version >= 2.4. Use encode_initial_data
instead
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABIdata
: string – Data BOC or BOC handleinitial_data
?: any – List of initial values for contract's static variables.abi
parameter should be provided to set initial datainitial_pubkey
?: string – Initial account owner's public key to set into account databoc_cache
?: BocCacheType – Cache type to put the result. The BOC itself returned if no cache type provided.
Result
data
: string – Updated data BOC or BOC handle
encode_initial_data
Encodes initial account data with initial values for the contract's static variables and owner's public key into a data BOC that can be passed to encode_tvc
function afterwards.
This function is analogue of tvm.buildDataInit
function in Solidity.
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABIinitial_data
?: any – List of initial values for contract's static variables.abi
parameter should be provided to set initial datainitial_pubkey
?: string – Initial account owner's public key to set into account databoc_cache
?: BocCacheType – Cache type to put the result. The BOC itself returned if no cache type provided.
Result
data
: string – Updated data BOC or BOC handle
decode_initial_data
Decodes initial values of a contract's static variables and owner's public key from account initial data This operation is applicable only for initial account data (before deploy). If the contract is already deployed, its data doesn't contain this data section any more.
Doesn't support ABI version >= 2.4. Use decode_account_data
instead
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABI. Initial data is decoded if this parameter is provideddata
: string – Data BOC or BOC handleallow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)
Result
initial_data
: any – List of initial values of contract's public variables. Initial data is decoded ifabi
input parameter is providedinitial_pubkey
: string – Initial account owner's public key
decode_boc
Decodes BOC into JSON as a set of provided parameters.
Solidity functions use ABI types for builder encoding. The simplest way to decode such a BOC is to use ABI decoding. ABI has it own rules for fields layout in cells so manually encoded BOC can not be described in terms of ABI rules.
To solve this problem we introduce a new ABI type Ref(<ParamType>)
which allows to store ParamType
ABI parameter in cell reference and, thus, decode manually encoded BOCs. This type is available only in decode_boc
function and will not be available in ABI messages encoding until it is included into some ABI revision.
Such BOC descriptions covers most users needs. If someone wants to decode some BOC which can not be described by these rules (i.e. BOC with TLB containing constructors of flags defining some parsing conditions) then they can decode the fields up to fork condition, check the parsed data manually, expand the parsing schema and then decode the whole BOC with the full schema.
NOTE: Sync version is available only for lib-node
binding.
Parameters
params
: AbiParam[] – Parameters to decode from BOCboc
: string – Data BOC or BOC handleallow_partial
: boolean
Result
data
: any – Decoded data as a JSON structure.
encode_boc
Encodes given parameters in JSON into a BOC using param types from ABI.
NOTE: Sync version is available only for lib-node
binding.
Parameters
params
: AbiParam[] – Parameters to encode into BOCdata
: any – Parameters and values as a JSON structureboc_cache
?: BocCacheType – Cache type to put the result. The BOC itself returned if no cache type provided
Result
boc
: string – BOC encoded as base64
calc_function_id
Calculates contract function ID by contract ABI
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABI.function_name
: string – Contract function nameoutput
?: boolean – If set totrue
output function ID will be returned which is used in contract response. Default isfalse
Result
function_id
: number – Contract function ID
get_signature_data
Extracts signature from message body and calculates hash to verify the signature
NOTE: Sync version is available only for lib-node
binding.
Parameters
abi
: Abi – Contract ABI used to decode.message
: string – Message BOC encoded inbase64
.signature_id
?: number – Signature ID to be used in unsigned data preparing when CapSignatureWithId capability is enabled
Result
signature
: string – Signature from the message inhex
.unsigned
: string – Data to verify the signature inbase64
.
Types
AbiErrorCode
One of the following value:
RequiredAddressMissingForEncodeMessage = 301
RequiredCallSetMissingForEncodeMessage = 302
InvalidJson = 303
InvalidMessage = 304
EncodeDeployMessageFailed = 305
EncodeRunMessageFailed = 306
AttachSignatureFailed = 307
InvalidTvcImage = 308
RequiredPublicKeyMissingForFunctionHeader = 309
InvalidSigner = 310
InvalidAbi = 311
InvalidFunctionId = 312
InvalidData = 313
EncodeInitialDataFailed = 314
InvalidFunctionName = 315
PubKeyNotSupported = 316
AbiContractVariant
value
: AbiContract
AbiJsonVariant
value
: string
AbiHandleVariant
value
: AbiHandle
AbiSerializedVariant
value
: AbiContract
Abi
Depends on value of the type
field.
When type is 'Contract'
value
: AbiContract
When type is 'Json'
value
: string
When type is 'Handle'
value
: AbiHandle
When type is 'Serialized'
value
: AbiContract
Variant constructors:
AbiHandle
FunctionHeader
The ABI function header.
Includes several hidden function parameters that contract uses for security, message delivery monitoring and replay protection reasons.
The actual set of header fields depends on the contract's ABI. If a contract's ABI does not include some headers, then they are not filled.
expire
?: number – Message expiration timestamp (UNIX time) in seconds. If not specified - calculated automatically from message_expiration_timeout(), try_index and message_expiration_timeout_grow_factor() (if ABI includesexpire
header).time
?: bigint – Message creation time in milliseconds. If not specified,now
is used (if ABI includestime
header).pubkey
?: string – Public key is used by the contract to check the signature. Encoded inhex
. If not specified, method fails with exception (if ABI includespubkey
header)..
CallSet
function_name
: string – Function name that is being called. Or function id encoded as string in hex (starting with 0x).header
?: FunctionHeader – Function header. If an application omits some header parameters required by the contract's ABI, the library will set the default values for them.input
?: any – Function input parameters according to ABI.
DeploySet
tvc
?: string – Content of TVC file encoded inbase64
. For compatibility reason this field can contain an encodedStateInit
.code
?: string – Contract code BOC encoded with base64.state_init
?: string – State init BOC encoded with base64.workchain_id
?: number – Target workchain for destination address. Default is0
.initial_data
?: any – List of initial values for contract's public variables.initial_pubkey
?: string – Optional public key that can be provided in deploy set in order to substitute one in TVM file or provided by Signer. Public key resolving priority: 1. Public key from deploy set. 2. Public key, specified in TVM file. 3. Public key, provided by Signer. Applicable only for contracts with ABI version < 2.4. Contract initial public key should be explicitly provided insideinitial_data
since ABI 2.4
SignerNoneVariant
No keys are provided.
Creates an unsigned message.
SignerExternalVariant
Only public key is provided in unprefixed hex string format to generate unsigned message and data_to_sign
which can be signed later.
public_key
: string
SignerKeysVariant
Key pair is provided for signing
keys
: KeyPair
SignerSigningBoxVariant
Signing Box interface is provided for signing, allows Dapps to sign messages using external APIs, such as HSM, cold wallet, etc.
handle
: SigningBoxHandle
Signer
Depends on value of the type
field.
When type is 'None'
No keys are provided.
Creates an unsigned message.
When type is 'External'
Only public key is provided in unprefixed hex string format to generate unsigned message and data_to_sign
which can be signed later.
public_key
: string
When type is 'Keys'
Key pair is provided for signing
keys
: KeyPair
When type is 'SigningBox'
Signing Box interface is provided for signing, allows Dapps to sign messages using external APIs, such as HSM, cold wallet, etc.
handle
: SigningBoxHandle
Variant constructors:
MessageBodyType
One of the following value:
Input = "Input"
– Message contains the input of the ABI function.Output = "Output"
– Message contains the output of the ABI function.InternalOutput = "InternalOutput"
– Message contains the input of the imported ABI function. Occurs when contract sends an internal message to other contract.Event = "Event"
– Message contains the input of the ABI event.
AbiParam
name
: stringtype
: stringcomponents
?: AbiParam[]init
?: boolean
AbiEvent
name
: stringinputs
: AbiParam[]id
?: string?
AbiData
key
: numbername
: stringtype
: stringcomponents
?: AbiParam[]
AbiFunction
AbiContract
ABI version
?: numberabi_version
?: numberversion
?: string?header
?: string[]functions
?: AbiFunction[]events
?: AbiEvent[]data
?: AbiData[]fields
?: AbiParam[]
DataLayout
One of the following value:
Input = "Input"
– Decode message body as function input parameters.Output = "Output"
– Decode message body as function output.
ParamsOfEncodeMessageBody
abi
: Abi – Contract ABI.call_set
: CallSet – Function call parameters. Must be specified in non deploy message. In case of deploy message contains parameters of constructor.is_internal
: boolean – True if internal message body must be encoded.signer
: Signer – Signing parameters.processing_try_index
?: number – Processing try index. Used in message processing with retries. Encoder uses the provided try index to calculate message expiration time. Expiration timeouts will grow with every retry. Default value is 0.address
?: string – Destination address of the message Since ABI version 2.3 destination address of external inbound message is used in message body signature calculation. Should be provided when signed external inbound message body is created. Otherwise can be omitted.signature_id
?: number – Signature ID to be used in data to sign preparing when CapSignatureWithId capability is enabled
ResultOfEncodeMessageBody
body
: string – Message body BOC encoded withbase64
.data_to_sign
?: string – Optional data to sign. Encoded withbase64
. Presents whenmessage
is unsigned. Can be used for external message signing. Is this case you need to sing this data and produce signed message usingabi.attach_signature
.
ParamsOfAttachSignatureToMessageBody
abi
: Abi – Contract ABIpublic_key
: string – Public key. Must be encoded withhex
.message
: string – Unsigned message body BOC. Must be encoded withbase64
.signature
: string – Signature. Must be encoded withhex
.
ResultOfAttachSignatureToMessageBody
body
: string
ParamsOfEncodeMessage
abi
: Abi – Contract ABI.address
?: string – Target address the message will be sent to. Must be specified in case of non-deploy message.deploy_set
?: DeploySet – Deploy parameters. Must be specified in case of deploy message.call_set
?: CallSet – Function call parameters. Must be specified in case of non-deploy message. In case of deploy message it is optional and contains parameters of the functions that will to be called upon deploy transaction.signer
: Signer – Signing parameters.processing_try_index
?: number – Processing try index. Used in message processing with retries (if contract's ABI includes "expire" header). Encoder uses the provided try index to calculate message expiration time. The 1st message expiration time is specified in Client config. Expiration timeouts will grow with every retry. Retry grow factor is set in Client config: <.....add config parameter with default value here> Default value is 0.signature_id
?: number – Signature ID to be used in data to sign preparing when CapSignatureWithId capability is enabled
ResultOfEncodeMessage
message
: string – Message BOC encoded withbase64
.data_to_sign
?: string – Optional data to be signed encoded inbase64
. Returned in case ofSigner::External
. Can be used for external message signing. Is this case you need to use this data to create signature and then produce signed message usingabi.attach_signature
.address
: string – Destination address.message_id
: string – Message id.
ParamsOfEncodeInternalMessage
abi
?: Abi – Contract ABI. Can be None if both deploy_set and call_set are None.address
?: string – Target address the message will be sent to. Must be specified in case of non-deploy message.src_address
?: string – Source address of the message.deploy_set
?: DeploySet – Deploy parameters. Must be specified in case of deploy message.call_set
?: CallSet – Function call parameters. Must be specified in case of non-deploy message. In case of deploy message it is optional and contains parameters of the functions that will to be called upon deploy transaction.value
: string – Value in nanotokens to be sent with message.bounce
?: boolean – Flag of bounceable message. Default is true.enable_ihr
?: boolean – Enable Instant Hypercube Routing for the message. Default is false.
ResultOfEncodeInternalMessage
message
: string – Message BOC encoded withbase64
.address
: string – Destination address.message_id
: string – Message id.
ParamsOfAttachSignature
abi
: Abi – Contract ABIpublic_key
: string – Public key encoded inhex
.message
: string – Unsigned message BOC encoded inbase64
.signature
: string – Signature encoded inhex
.
ResultOfAttachSignature
message
: string – Signed message BOCmessage_id
: string – Message ID
ParamsOfDecodeMessage
abi
: Abi – contract ABImessage
: string – Message BOCallow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)function_name
?: string – Function name or function id if is known in advancedata_layout
?: DataLayout
DecodedMessageBody
body_type
: MessageBodyType – Type of the message body content.name
: string – Function or event name.value
?: any – Parameters or result value.header
?: FunctionHeader – Function header.
ParamsOfDecodeMessageBody
abi
: Abi – Contract ABI used to decode.body
: string – Message body BOC encoded inbase64
.is_internal
: boolean – True if the body belongs to the internal message.allow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)function_name
?: string – Function name or function id if is known in advancedata_layout
?: DataLayout
ParamsOfEncodeAccount
state_init
: string – Account state init.balance
?: bigint – Initial balance.last_trans_lt
?: bigint – Initial value for thelast_trans_lt
.last_paid
?: number – Initial value for thelast_paid
.boc_cache
?: BocCacheType – Cache type to put the result. The BOC itself returned if no cache type provided
ResultOfEncodeAccount
account
: string – Account BOC encoded inbase64
.id
: string – Account ID encoded inhex
.
ParamsOfDecodeAccountData
abi
: Abi – Contract ABIdata
: string – Data BOC or BOC handleallow_partial
?: boolean – Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC:true
- return decoded valuesfalse
- return error of incomplete BOC deserialization (default)
ResultOfDecodeAccountData
data
: any – Decoded data as a JSON structure.
ParamsOfUpdateInitialData
abi
: Abi – Contract ABIdata
: string – Data BOC or BOC handleinitial_data
?: any – List of initial values for contract's static variables.abi
parameter should be provided to set initial datainitial_pubkey
?: string – Initial account owner's public key to set into account databoc_cache
?: BocCacheType – Cache type to put the result. The BOC itself returned if no cache type provided.
ResultOfUpdateInitialData
data
: string – Updated data BOC or BOC handle