EVER SDK
Developer ToolsEver PlatformForum
  • Ever SDK
  • Quick start (JavaScript)
  • Add EVER to your backend
  • Reference
    • Types and Methods
      • Modules
      • Module abi
      • Module boc
      • Module client
      • Module crypto
      • Module debot
      • Module net
      • Module processing
      • Module proofs
      • Module tvm
      • Module utils
    • Error API
    • Error Codes
    • JavaScript Reference
    • Rust Reference
  • Samples
    • JavaScript Samples
  • guides
    • Installation
      • Add SDK to your App
    • Configuration
      • Endpoint Configuration
      • Message Expiration
      • Message Retry
      • Config Reference
    • Work with contracts
      • Add Contract to your App
      • Use your own Giver
      • Deploy
      • Run on-chain
      • Run ABI Get Method
      • Run Fift Get Method
      • Query/Subscribe for messages(events)
      • Decode Messages(Event)
      • External Signing
      • Emulate Transaction
      • Estimate Fees
      • Validate address, convert address
      • Monitor Messages
      • Trace message processing with REMP
    • Crypto
      • Mnemonics and Keys
    • Queries and subscriptions
      • Use-cases
      • How to work with net module
      • net.query syntax
      • Data pagination
      • Subscribe to Updates
      • Query Collection
      • Aggregate Collection
  • For Binding Developers
    • How to work with Application Objects in binding generators
    • JSON Interface to Ton Client
  • Links
    • Ever SDK repository
    • AppKit JS documentation
Powered by GitBook
On this page
  • Common Types
  • ResponseHandler
  • Modules
  • client – Provides information about library.
  • crypto – Crypto functions.
  • abi – Provides message encoding and decoding according to the ABI specification.
  • boc – BOC manipulation module.
  • processing – Message processing module.
  • utils – Misc utility Functions.
  • tvm
  • net – Network access.
  • debot – UNSTABLE DEPRECATED Module for working with debot.
  • proofs – UNSTABLE DEPRECATED Module for proving data, retrieved from TONOS API.

Was this helpful?

  1. Reference
  2. Types and Methods

Modules

PreviousTypes and MethodsNextModule abi

Last updated 1 year ago

Was this helpful?

Common Types

ResponseHandler

type ResponseHandler = (params: any, responseType: number) => void;

Handles additional function responses.

Where:

  • params: any – Response parameters. Actual type depends on API function.

  • responseType: number – Function specific response type.

Modules

– Provides information about library.

– Returns Core Library API reference

– Returns Core Library version

– Returns Core Library API reference

– Returns detailed information about this build.

– Resolves application request processing result

– Crypto functions.

– Integer factorization

– Modular exponentiation

– Calculates CRC16 using TON algorithm.

– Generates random byte array of the specified length and returns it in base64 format

– Converts public key to ton safe_format

– Generates random ed25519 key pair.

– Signs a data using the provided keys.

– Verifies signed data using the provided public key. Raises error if verification is failed.

– Calculates SHA256 hash of the specified data.

– Calculates SHA512 hash of the specified data.

– Perform scrypt encryption

– Generates a key pair for signing from the secret key

– Signs data using the signer's secret key.

– Verifies the signature and returns the unsigned message

– Signs the message using the secret key and returns a signature.

– Verifies the signature with public key and unsigned data.

– Generates a random NaCl key pair

– Generates key pair from a secret key

– Public key authenticated encryption

– Decrypt and verify the cipher text using the receivers secret key, the senders public key, and the nonce.

– Encrypt and authenticate message using nonce and secret key.

– Decrypts and verifies cipher text using nonce and secret key.

– Prints the list of words from the specified dictionary

– Generates a random mnemonic

– Generates mnemonic from pre-generated entropy

– Validates a mnemonic phrase

– Derives a key pair for signing from the seed phrase

– Generates an extended master private key that will be the root for all the derived keys

– Returns extended private key derived from the specified extended private key and child index

– Derives the extended private key from the specified key and path

– Extracts the private key from the serialized extended private key

– Extracts the public key from the serialized extended private key

– Performs symmetric chacha20 encryption.

– Creates a Crypto Box instance.

– Removes Crypto Box. Clears all secret data.

– Get Crypto Box Info. Used to get encrypted_secret that should be used for all the cryptobox initializations except the first one.

– Get Crypto Box Seed Phrase.

– Get handle of Signing Box derived from Crypto Box.

– Gets Encryption Box from Crypto Box.

– Removes cached secrets (overwrites with zeroes) from all signing and encryption boxes, derived from crypto box.

– Register an application implemented signing box.

– Creates a default signing box implementation.

– Returns public key of signing key pair.

– Returns signed user data.

– Removes signing box from SDK.

– Register an application implemented encryption box.

– Removes encryption box from SDK

– Queries info from the given encryption box

– Encrypts data using given encryption box Note.

– Decrypts data using given encryption box Note.

– Creates encryption box with specified algorithm

– Provides message encoding and decoding according to the ABI specification.

– Encodes message body according to ABI function call.

– Encodes an ABI-compatible message

– Encodes an internal ABI-compatible message

– Combines hex-encoded signature with base64-encoded unsigned_message. Returns signed message encoded in base64.

– Decodes message body using provided message BOC and ABI.

– Decodes message body using provided body BOC and ABI.

– Creates account state BOC

– Decodes account data using provided data BOC and ABI.

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

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

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

– Decodes BOC into JSON as a set of provided parameters.

– Encodes given parameters in JSON into a BOC using param types from ABI.

– Calculates contract function ID by contract ABI

– Extracts signature from message body and calculates hash to verify the signature

– BOC manipulation module.

– Decodes tvc according to the tvc spec. Read more about tvc structure here https://github.com/everx-labs/ever-struct/blob/main/src/scheme/mod.rs#L30

– Parses message boc into a JSON

– Parses transaction boc into a JSON

– Parses account boc into a JSON

– Parses block boc into a JSON

– Parses shardstate boc into a JSON

– Extract blockchain configuration from key block and also from zerostate.

– Calculates BOC root hash

– Calculates BOC depth

– Extracts code from TVC contract image

– Get BOC from cache

– Save BOC into cache or increase pin counter for existing pinned BOC

– Unpin BOCs with specified pin defined in the cache_set. Decrease pin reference counter for BOCs with specified pin defined in the cache_set. BOCs which have only 1 pin and its reference counter become 0 will be removed from cache

– Encodes bag of cells (BOC) with builder operations. This method provides the same functionality as Solidity TvmBuilder. Resulting BOC of this method can be passed into Solidity and C++ contracts as TvmCell type.

– Returns the contract code's salt if it is present.

– Sets new salt to contract code.

– Decodes contract's initial state into code, data, libraries and special options.

– Encodes initial contract state from code, data, libraries ans special options (see input params)

– Encodes a message

– Returns the compiler version used to compile the code.

– Message processing module.

– Starts monitoring for the processing results of the specified messages.

– Returns summary information about current state of the specified monitoring queue.

– Fetches next resolved results from the specified monitoring queue.

– Cancels all background activity and releases all allocated system resources for the specified monitoring queue.

– Sends specified messages to the blockchain.

– Sends message to the network

– Performs monitoring of the network for the result transaction of the external inbound message processing.

– Creates message, sends it to the network and monitors its processing.

– Misc utility Functions.

– Converts address from any TON format to any TON format

– Validates and returns the type of any TON address.

– Calculates storage fee for an account over a specified time period

– Compresses data using Zstandard algorithm

– Decompresses data using Zstandard algorithm

– Emulates all the phases of contract execution locally

– Executes get-methods of ABI-compatible contracts

– Executes a get-method of FIFT contract

– Network access.

– Performs DAppServer GraphQL query.

– Performs multiple queries per single fetch.

– Queries collection data

– Aggregates collection data.

– Returns an object that fulfills the conditions or waits for its appearance

– Cancels a subscription

– Creates a collection subscription

– Creates a subscription

– Suspends network module to stop any network activity

– Resumes network module to enable network activity

– Returns ID of the last block in a specified account shard

– Requests the list of alternative endpoints from server

– Sets the list of endpoints to use on reinit

– Requests the list of alternative endpoints from server

– Allows to query and paginate through the list of accounts that the specified account has interacted with, sorted by the time of the last internal message between accounts

– Returns a tree of transactions triggered by a specific message.

– Creates block iterator.

– Resumes block iterator.

– Creates transaction iterator.

– Resumes transaction iterator.

– Returns next available items.

– Removes an iterator

– Returns signature ID for configured network if it should be used in messages signature

– Module for working with debot.

– Creates and instance of DeBot.

– Starts the DeBot.

– Fetches DeBot metadata from blockchain.

– Executes debot action.

– Sends message to Debot.

– Destroys debot handle.

– Module for proving data, retrieved from TONOS API.

– Proves that a given block's data, which is queried from TONOS API, can be trusted.

– Proves that a given transaction's data, which is queried from TONOS API, can be trusted.

– Proves that a given message's data, which is queried from TONOS API, can be trusted.

crypto
abi
boc
processing
utils
tvm
net
debot
UNSTABLE
DEPRECATED
proofs
UNSTABLE
DEPRECATED
client
UNSTABLE
DEPRECATED
UNSTABLE
DEPRECATED
UNSTABLE
DEPRECATED
UNSTABLE
DEPRECATED
UNSTABLE
DEPRECATED
UNSTABLE
DEPRECATED
get_api_reference
version
config
build_info
resolve_app_request
monitor_messages
get_monitor_info
fetch_next_monitor_results
cancel_monitor
send_messages
send_message
wait_for_transaction
process_message
decode_tvc
parse_message
parse_transaction
parse_account
parse_block
parse_shardstate
get_blockchain_config
get_boc_hash
get_boc_depth
get_code_from_tvc
cache_get
cache_set
cache_unpin
encode_boc
get_code_salt
set_code_salt
decode_state_init
encode_state_init
encode_external_in_message
get_compiler_version
convert_address
get_address_type
calc_storage_fee
compress_zstd
decompress_zstd
encode_message_body
attach_signature_to_message_body
encode_message
encode_internal_message
attach_signature
decode_message
decode_message_body
encode_account
decode_account_data
update_initial_data
encode_initial_data
decode_initial_data
decode_boc
encode_boc
calc_function_id
get_signature_data
init
start
fetch
execute
send
remove
run_executor
run_tvm
run_get
factorize
modular_power
ton_crc16
generate_random_bytes
convert_public_key_to_ton_safe_format
generate_random_sign_keys
sign
verify_signature
sha256
sha512
scrypt
nacl_sign_keypair_from_secret_key
nacl_sign
nacl_sign_open
nacl_sign_detached
nacl_sign_detached_verify
nacl_box_keypair
nacl_box_keypair_from_secret_key
nacl_box
nacl_box_open
nacl_secret_box
nacl_secret_box_open
mnemonic_words
mnemonic_from_random
mnemonic_from_entropy
mnemonic_verify
mnemonic_derive_sign_keys
hdkey_xprv_from_mnemonic
hdkey_derive_from_xprv
hdkey_derive_from_xprv_path
hdkey_secret_from_xprv
hdkey_public_from_xprv
chacha20
create_crypto_box
remove_crypto_box
get_crypto_box_info
get_crypto_box_seed_phrase
get_signing_box_from_crypto_box
get_encryption_box_from_crypto_box
clear_crypto_box_secret_cache
register_signing_box
get_signing_box
signing_box_get_public_key
signing_box_sign
remove_signing_box
register_encryption_box
remove_encryption_box
encryption_box_get_info
encryption_box_encrypt
encryption_box_decrypt
create_encryption_box
query
batch_query
query_collection
aggregate_collection
wait_for_collection
unsubscribe
subscribe_collection
subscribe
suspend
resume
find_last_shard_block
fetch_endpoints
set_endpoints
get_endpoints
query_counterparties
query_transaction_tree
create_block_iterator
resume_block_iterator
create_transaction_iterator
resume_transaction_iterator
iterator_next
remove_iterator
get_signature_id
proof_block_data
proof_transaction_data
proof_message_data