Version: 1.3.0

1.3.0 Dec 8, 2020

Featured

• net.query method . Performs custom graphql query that can be copied directly from the playground.
• net.suspend and net.resume methods for disabling and enabling network activity. One of the possible use-cases is to manage subscriptions when a mobile application is brought to the background and into the foreground again.
• Smart summary and description doc separation.
• ts-generator includes doc comments in JSDoc format.

Version: 1.2.0

1.2.0 Nov 26, 2020

Featured

• UNSTABLE API. This API is experimental. It can be changed in the next releases.
  debot module was added with debot engine functions, such as : start, fetch, execute, remove. See the debot module documentation for more info.
  Check our tests for code examples.

• External signing was supported for message encoding: SigningBox type for Signer enum was supported.
  Now it is possible to sign messages with externally implemented signing box interface without private key disclosure to the library. Can be used in case of signing via HSM API or via cold wallet - when there is no access to the private key.

  It is also possible to create a Signing Box instance inside SDK - from a key pair passed into the library with get_signing_box method. It can be used for some test cases. Also it increases security - you need to pass your keys one time only.

  Check the crypto module documentation for SigningBoxHandle type and register_signing_box, get_signing_box, signing_box_get_public_key, signing_box_sign.
  Check our tests for code examples.

Fixed

• panic after tc_destroy_context call. Now all contexts use global async runtime
• field mnemonic_hdkey_compliant was removed from CryptoConfig (unused by the library)
• original and resolved errors are swapped in result. Now error.code contains original error code

Version: 1.1.2

1.1.2 Nov 15, 2020

Fixed

• wasm feature was not worked.
• crypto.factorize doesn't panic on invalid challenge
• client.get_api_reference returns proper version
• ABI JSON with explicit function ID is parsed properly

Version: 1.1.1

1.1.1 Nov 11, 2020

Fixed

• To be compatible with older rust version change api type derivation with vec![]
  instead of prev [].into()

Version 1.1.0

1.1.0 Nov 9, 2020

New

• ChaCha20 encryption support crypto.chacha20.
• boc.parse_shardstate function for shardstates parsing.
• boc.get_boc_hash function for calculating BOC root hash
• client.build_info fully defined and documented.
• processing.wait_for_transaction and processing.process_message functions execute contract
  locally in case if transaction waiting fails in order to resolve the contract execution error
• run_executor, run_tvm now return exit_arg in case of TVM errors.
• Create the build_info.json on the build stage.
• Abi::Contract variant as an alias to deprecated Abi::Serialized
• Abi::Json variant to specify an ABI as a raw JSON string.
• api.json now contains details about numeric types: Number and BigInt are now
  have new fields number_type and number_size.
• api.json ref type names are fully qualified now in form of module.type,
  for example abi.Signer.

Fixed

• TS generator fix some field names that is an invalid JS identifiers.
• Use install_name_tool to fix loading library paths at libton_client.dylib.
• api.json is reduced, so it can't contains tuple types, only structs.
  All types are exactly match to JSON.
• out_of_sync_threshold config parameter is u32

Unstable

• tc_request_ptr function to use pointers void* instead of request_id u32.
  This feature is UNSTABLE yet.

Version 1.0.0

1.0.0 Oct 27, 2020

Differences between Core SDK v0 and v1

• 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.

• [breaking] crypto module. default values for mnemonic-related functions have been changed:

  dictionary is 1, for word count is 12, derivation path is 'm/44'/396'/0'/0/0

• [breaking] crypto module. removed word_count parameter from words function

• [breaking] crypto module. compliant parameter is removed from functions mnemonic_derive_sign_keys, hdkey_xprv_derive_path, hdkey_xprv_derive,

• [new] boc module. Functions parse_block, parse_account, parse_message, parse_transaction that parse bocs to JSONs are introduced.

• [breaking] net module. Functions query , wait.for, subscribe are renamed to query_collection, wait_for_collection, subscribe_collection

  table parameter is renamed to collection. filter parameter is now optional and of json type (passed as json object instead of string)

• [breaking] net module. Function get.next is removed.

• [breaking] net module.subscribe_collection now uses callback to return data.

• [breaking] abi module. decode_message introduced instead of decode_unknown_run, decode_run_output

• [breaking] abi module. encode_message introduced instead of encode_unsigned_deploy_message, encode_unsigned_run_message, run.encode_message, deploy.encode_message

• [breaking] abi module. signer: Signer parameter used instead of key_pair: KeyPair , which can be of None (unsigned message will be produced), External (data to be signed +unsigned message), Keys (signed message will be produced), SigningBox (message will be signed using a provided interface - will be supported in coming releases)

• [breaking] processing module. process_message introduced instead of deploy and run. Parameter set was drastically changed.

• [breaking] processing module. process_message - now, if the contract was already deployed, deploy fails with an exception of double constructor call.

• [new] processing module. process_message - any function can be called at deploy, not only constructor, also there can be no function call.

• [new] processing module. process_message now can optionally use callback to monitor message processing (creation, sending, shard block fetching, transaction receiving).

• [fixed] processing module. process_message - deploy can be performed without a key pair

• [breaking] tvm module. run_local is divided into 2 functions run_tvm and run_executor.

• [new] tvm module. run_tvm function - performs contract code execution on tvm (part of compute phase). Helps to run contract methods without ACCEPT. Returns account state with updated data, list of external messages and (optional, for ABI contracts only) list of messages decoded data.

• [new] tvm module. run_executor function - performs full contract code execution on Transaction Executor (part of collator protocol that performs all phases and checks and - as a successful result - forms a transaction) Returns updated account state, parsed transaction, list of parsed messages with optional decoded message bodies.

• [breaking] tvm module. run_get does not download account boc from the network anymore, but takes account boc as a parameter.

Version 0.26.0

0.26.0 Aug 7, 2020

New

• crypto function crypto.derive_sign_keys_from_mnemonic
• full local run functions use LocalRunContext to exactly reproduce all transaction parameters and
  produce the same result as node

Version 0.25.4

0.25.4 Aug 5, 2020

Fixed

• waitForTransaction didn't use prev_alt_ref for block walking

Version 0.25.3

0.25.3 Jul 30, 2020

New

• All methods that require contract's code/data can use field boc
  in account document to extract code and data
  (instead of code and data fields).
• Optional bocBase64 parameter of method tvm.get that can be used
  instead of codeBase64 and dataBase64.

Version 0.25.2

0.25.2 Jul 29, 2020

New

• error.data object extended with fields address, function_name, account_balance,
  account_address, query_url, config_server for appropriate errors