The Core SDK major version 0 is no longer actively developed. It is recommended to migrate to SDK with major version 1. See the migration guide below.

Differences between Core SDK v0 and v1

Structure, naming and parameters

• All api functions are defined in mod.rs of appropriate modules
• Function names are the same as API function names: module.function_name
• Parameters naming:
  • In snake case
  • Base64 suffix is removed from parameter names. For example, bocBase64 is changed to boc
• Parsed boc replaced with unparsed boc in all function input parameters
• All functions take byte arrays in a defined encoding:
  • base64 - encoding used for byte arrays of variable length: text, images, etc.
  • hex-lower-case - encoding used to encode fixed length bit sequences: hashes, keys, salt, etc.
• contracts module is splitted into 5 modules:
  • tvm - embedded TVM execution functions
  • boc - raw cell and BOC manipulation functions
  • abi - abi-compatible messages creation and parsing functions
  • processing - blockchain interaction functions
  • utils - has only convert_address ATM, later will be used for some useful stuff
• query module is renamed to net
• new client module with functions version, api_reference
• All the environment functions (fetch, websocket, spawn, now, etc.) were abstracted behind a separate environment layer crate ClientEnv. The standard core env layer implementation is in std_client_env . Later (in 1.1 release) web_client_env implementation for Web will be added.
• Error codes are distributed across the modules the following way: client - 0..99, crypto - 100..199, boc - 200..299, abi - 300..399, tvm - 400..499, processing - 500..599, net - 600..699
• Error descriptions related to a module are described in error.rs file in the module's folder
• decode_message, process_message, wait_for_transaction, run_tvm, run_executor, etc. (all the functions that return decoded messages) now returns int*/uint* data as a string which can be either decimal or 0x-prefixed hex string. Hex representation can be in any register and have any number of leading zeroes.

Featured

• All the functions are asynchronous
• All the functions that can be called via JSON-api are public, so that they can be used directly without JSON-api.
• Inline documentation and api reference added.
• [breaking] interops.rs, tonclient.h. create_context now takes config parameter - context creation and setup happen at the same time. Config structure has been changed.