Module crypto

Performs prime factorization – decomposition of a composite number into a product of smaller prime integers (factors). See [https://en.wikipedia.org/wiki/Integer_factorization]

type ParamsOfFactorize = {
    composite: string
}

type ResultOfFactorize = {
    factors: string[]
}

function factorize(
    params: ParamsOfFactorize,
): Promise<ResultOfFactorize>;

Parameters

composite: string – Hexadecimal representation of u64 composite number.

Result

factors: string[] – Two factors of composite or empty if composite can't be factorized.

modular_power

Modular exponentiation

Performs modular exponentiation for big integers (base^exponent mod modulus). See [https://en.wikipedia.org/wiki/Modular_exponentiation]

type ParamsOfModularPower = {
    base: string,
    exponent: string,
    modulus: string
}

type ResultOfModularPower = {
    modular_power: string
}

function modular_power(
    params: ParamsOfModularPower,
): Promise<ResultOfModularPower>;

Parameters

base: string – base argument of calculation.
exponent: string – exponent argument of calculation.
modulus: string – modulus argument of calculation.

Result

modular_power: string – Result of modular exponentiation

ton_crc16

Calculates CRC16 using TON algorithm.

type ParamsOfTonCrc16 = {
    data: string
}

type ResultOfTonCrc16 = {
    crc: number
}

function ton_crc16(
    params: ParamsOfTonCrc16,
): Promise<ResultOfTonCrc16>;

Parameters

data: string – Input data for CRC calculation.
Encoded with base64.

Result

crc: number – Calculated CRC for input data.

generate_random_bytes

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

type ParamsOfGenerateRandomBytes = {
    length: number
}

type ResultOfGenerateRandomBytes = {
    bytes: string
}

function generate_random_bytes(
    params: ParamsOfGenerateRandomBytes,
): Promise<ResultOfGenerateRandomBytes>;

Parameters

length: number – Size of random byte array.

Result

bytes: string – Generated bytes encoded in base64.

convert_public_key_to_ton_safe_format

Converts public key to ton safe_format

type ParamsOfConvertPublicKeyToTonSafeFormat = {
    public_key: string
}

type ResultOfConvertPublicKeyToTonSafeFormat = {
    ton_public_key: string
}

function convert_public_key_to_ton_safe_format(
    params: ParamsOfConvertPublicKeyToTonSafeFormat,
): Promise<ResultOfConvertPublicKeyToTonSafeFormat>;

Parameters

public_key: string – Public key - 64 symbols hex string

Result

ton_public_key: string – Public key represented in TON safe format.

generate_random_sign_keys

Generates random ed25519 key pair.

type KeyPair = {
    public: string,
    secret: string
}

function generate_random_sign_keys(): Promise<KeyPair>;

Result

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

sign

Signs a data using the provided keys.

type ParamsOfSign = {
    unsigned: string,
    keys: KeyPair
}

type ResultOfSign = {
    signed: string,
    signature: string
}

function sign(
    params: ParamsOfSign,
): Promise<ResultOfSign>;

Parameters

unsigned: string – Data that must be signed encoded in base64.
keys: KeyPair – Sign keys.

Result

signed: string – Signed data combined with signature encoded in base64.
signature: string – Signature encoded in hex.

verify_signature

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

type ParamsOfVerifySignature = {
    signed: string,
    public: string
}

type ResultOfVerifySignature = {
    unsigned: string
}

function verify_signature(
    params: ParamsOfVerifySignature,
): Promise<ResultOfVerifySignature>;

Parameters

signed: string – Signed data that must be verified encoded in base64.
public: string – Signer's public key - 64 symbols hex string

Result

unsigned: string – Unsigned data encoded in base64.

sha256

Calculates SHA256 hash of the specified data.

type ParamsOfHash = {
    data: string
}

type ResultOfHash = {
    hash: string
}

function sha256(
    params: ParamsOfHash,
): Promise<ResultOfHash>;

Parameters

data: string – Input data for hash calculation.
Encoded with base64.

Result

hash: string – Hash of input data.
Encoded with 'hex'.

sha512

Calculates SHA512 hash of the specified data.

type ParamsOfHash = {
    data: string
}

type ResultOfHash = {
    hash: string
}

function sha512(
    params: ParamsOfHash,
): Promise<ResultOfHash>;

Parameters

data: string – Input data for hash calculation.
Encoded with base64.

Result

hash: string – Hash of input data.
Encoded with 'hex'.

scrypt

Perform scrypt encryption

Derives key from password and key using scrypt algorithm. See [https://en.wikipedia.org/wiki/Scrypt].

Arguments

log_n - The log2 of the Scrypt parameter N
r - The Scrypt parameter r
p - The Scrypt parameter p

Conditions

log_n must be less than 64
r must be greater than 0 and less than or equal to 4294967295
p must be greater than 0 and less than 4294967295

Recommended values sufficient for most use-cases

log_n = 15 (n = 32768)
r = 8
p = 1

type ParamsOfScrypt = {
    password: string,
    salt: string,
    log_n: number,
    r: number,
    p: number,
    dk_len: number
}

type ResultOfScrypt = {
    key: string
}

function scrypt(
    params: ParamsOfScrypt,
): Promise<ResultOfScrypt>;

Parameters

password: string – The password bytes to be hashed. Must be encoded with base64.
salt: string – Salt bytes that modify the hash to protect against Rainbow table attacks. Must be encoded with base64.
log_n: number – CPU/memory cost parameter
r: number – The block size parameter, which fine-tunes sequential memory read size and performance.
p: number – Parallelization parameter.
dk_len: number – Intended output length in octets of the derived key.

Result

key: string – Derived key.
Encoded with hex.

nacl_sign_keypair_from_secret_key

Generates a key pair for signing from the secret key

NOTE: In the result the secret key is actually the concatenation of secret and public keys (128 symbols hex string) by design of NaCL. See also the stackexchange question.

type ParamsOfNaclSignKeyPairFromSecret = {
    secret: string
}

type KeyPair = {
    public: string,
    secret: string
}

function nacl_sign_keypair_from_secret_key(
    params: ParamsOfNaclSignKeyPairFromSecret,
): Promise<KeyPair>;

Parameters

secret: string – Secret key - unprefixed 0-padded to 64 symbols hex string

Result

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

nacl_sign

Signs data using the signer's secret key.

type ParamsOfNaclSign = {
    unsigned: string,
    secret: string
}

type ResultOfNaclSign = {
    signed: string
}

function nacl_sign(
    params: ParamsOfNaclSign,
): Promise<ResultOfNaclSign>;

Parameters

unsigned: string – Data that must be signed encoded in base64.
secret: string – Signer's secret key - unprefixed 0-padded to 128 symbols hex string (concatenation of 64 symbols secret and 64 symbols public keys). See nacl_sign_keypair_from_secret_key.

Result

signed: string – Signed data, encoded in base64.

nacl_sign_open

Verifies the signature and returns the unsigned message

Verifies the signature in signed using the signer's public key public and returns the message unsigned.

If the signature fails verification, crypto_sign_open raises an exception.

type ParamsOfNaclSignOpen = {
    signed: string,
    public: string
}

type ResultOfNaclSignOpen = {
    unsigned: string
}

function nacl_sign_open(
    params: ParamsOfNaclSignOpen,
): Promise<ResultOfNaclSignOpen>;

Parameters

signed: string – Signed data that must be unsigned.
Encoded with base64.
public: string – Signer's public key - unprefixed 0-padded to 64 symbols hex string

Result

unsigned: string – Unsigned data, encoded in base64.

nacl_sign_detached

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

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

type ParamsOfNaclSign = {
    unsigned: string,
    secret: string
}

type ResultOfNaclSignDetached = {
    signature: string
}

function nacl_sign_detached(
    params: ParamsOfNaclSign,
): Promise<ResultOfNaclSignDetached>;

Parameters

unsigned: string – Data that must be signed encoded in base64.
secret: string – Signer's secret key - unprefixed 0-padded to 128 symbols hex string (concatenation of 64 symbols secret and 64 symbols public keys). See nacl_sign_keypair_from_secret_key.

Result

signature: string – Signature encoded in hex.

nacl_sign_detached_verify

Verifies the signature with public key and unsigned data.

type ParamsOfNaclSignDetachedVerify = {
    unsigned: string,
    signature: string,
    public: string
}

type ResultOfNaclSignDetachedVerify = {
    succeeded: boolean
}

function nacl_sign_detached_verify(
    params: ParamsOfNaclSignDetachedVerify,
): Promise<ResultOfNaclSignDetachedVerify>;

Parameters

unsigned: string – Unsigned data that must be verified.
Encoded with base64.
signature: string – Signature that must be verified.
Encoded with hex.
public: string – Signer's public key - unprefixed 0-padded to 64 symbols hex string.

Result

succeeded: boolean – true if verification succeeded or false if it failed

nacl_box_keypair

Generates a random NaCl key pair

type KeyPair = {
    public: string,
    secret: string
}

function nacl_box_keypair(): Promise<KeyPair>;

Result

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

nacl_box_keypair_from_secret_key

Generates key pair from a secret key

type ParamsOfNaclBoxKeyPairFromSecret = {
    secret: string
}

type KeyPair = {
    public: string,
    secret: string
}

function nacl_box_keypair_from_secret_key(
    params: ParamsOfNaclBoxKeyPairFromSecret,
): Promise<KeyPair>;

Parameters

secret: string – Secret key - unprefixed 0-padded to 64 symbols hex string

Result

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

nacl_box

Public key authenticated encryption

Encrypt and authenticate a message using the senders secret key, the receivers public key, and a nonce.

type ParamsOfNaclBox = {
    decrypted: string,
    nonce: string,
    their_public: string,
    secret: string
}

type ResultOfNaclBox = {
    encrypted: string
}

function nacl_box(
    params: ParamsOfNaclBox,
): Promise<ResultOfNaclBox>;

Parameters

decrypted: string – Data that must be encrypted encoded in base64.
nonce: string – Nonce, encoded in hex
their_public: string – Receiver's public key - unprefixed 0-padded to 64 symbols hex string
secret: string – Sender's private key - unprefixed 0-padded to 64 symbols hex string

Result

encrypted: string – Encrypted data encoded in base64.

nacl_box_open

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

type ParamsOfNaclBoxOpen = {
    encrypted: string,
    nonce: string,
    their_public: string,
    secret: string
}

type ResultOfNaclBoxOpen = {
    decrypted: string
}

function nacl_box_open(
    params: ParamsOfNaclBoxOpen,
): Promise<ResultOfNaclBoxOpen>;

Parameters

encrypted: string – Data that must be decrypted.
Encoded with base64.
nonce: string
their_public: string – Sender's public key - unprefixed 0-padded to 64 symbols hex string
secret: string – Receiver's private key - unprefixed 0-padded to 64 symbols hex string

Result

decrypted: string – Decrypted data encoded in base64.

nacl_secret_box

Encrypt and authenticate message using nonce and secret key.

type ParamsOfNaclSecretBox = {
    decrypted: string,
    nonce: string,
    key: string
}

type ResultOfNaclBox = {
    encrypted: string
}

function nacl_secret_box(
    params: ParamsOfNaclSecretBox,
): Promise<ResultOfNaclBox>;

Parameters

decrypted: string – Data that must be encrypted.
Encoded with base64.
nonce: string – Nonce in hex
key: string – Secret key - unprefixed 0-padded to 64 symbols hex string

Result

encrypted: string – Encrypted data encoded in base64.

nacl_secret_box_open

Decrypts and verifies cipher text using nonce and secret key.

type ParamsOfNaclSecretBoxOpen = {
    encrypted: string,
    nonce: string,
    key: string
}

type ResultOfNaclBoxOpen = {
    decrypted: string
}

function nacl_secret_box_open(
    params: ParamsOfNaclSecretBoxOpen,
): Promise<ResultOfNaclBoxOpen>;

Parameters

encrypted: string – Data that must be decrypted.
Encoded with base64.
nonce: string – Nonce in hex
key: string – Public key - unprefixed 0-padded to 64 symbols hex string

Result

decrypted: string – Decrypted data encoded in base64.

mnemonic_words

Prints the list of words from the specified dictionary

type ParamsOfMnemonicWords = {
    dictionary?: number
}

type ResultOfMnemonicWords = {
    words: string
}

function mnemonic_words(
    params: ParamsOfMnemonicWords,
): Promise<ResultOfMnemonicWords>;

Parameters

dictionary?: number – Dictionary identifier

Result

words: string – The list of mnemonic words

mnemonic_from_random

Generates a random mnemonic

Generates a random mnemonic from the specified dictionary and word count

type ParamsOfMnemonicFromRandom = {
    dictionary?: number,
    word_count?: number
}

type ResultOfMnemonicFromRandom = {
    phrase: string
}

function mnemonic_from_random(
    params: ParamsOfMnemonicFromRandom,
): Promise<ResultOfMnemonicFromRandom>;

Parameters

dictionary?: number – Dictionary identifier
word_count?: number – Mnemonic word count

Result

phrase: string – String of mnemonic words

mnemonic_from_entropy

Generates mnemonic from pre-generated entropy

type ParamsOfMnemonicFromEntropy = {
    entropy: string,
    dictionary?: number,
    word_count?: number
}

type ResultOfMnemonicFromEntropy = {
    phrase: string
}

function mnemonic_from_entropy(
    params: ParamsOfMnemonicFromEntropy,
): Promise<ResultOfMnemonicFromEntropy>;

Parameters

entropy: string – Entropy bytes.
Hex encoded.
dictionary?: number – Dictionary identifier
word_count?: number – Mnemonic word count

Result

phrase: string – Phrase

mnemonic_verify

Validates a mnemonic phrase

The phrase supplied will be checked for word length and validated according to the checksum specified in BIP0039.

type ParamsOfMnemonicVerify = {
    phrase: string,
    dictionary?: number,
    word_count?: number
}

type ResultOfMnemonicVerify = {
    valid: boolean
}

function mnemonic_verify(
    params: ParamsOfMnemonicVerify,
): Promise<ResultOfMnemonicVerify>;

Parameters

phrase: string – Phrase
dictionary?: number – Dictionary identifier
word_count?: number – Word count

Result

valid: boolean – Flag indicating if the mnemonic is valid or not

mnemonic_derive_sign_keys

Derives a key pair for signing from the seed phrase

Validates the seed phrase, generates master key and then derives the key pair from the master key and the specified path

type ParamsOfMnemonicDeriveSignKeys = {
    phrase: string,
    path?: string,
    dictionary?: number,
    word_count?: number
}

type KeyPair = {
    public: string,
    secret: string
}

function mnemonic_derive_sign_keys(
    params: ParamsOfMnemonicDeriveSignKeys,
): Promise<KeyPair>;

Parameters

phrase: string – Phrase
path?: string – Derivation path, for instance "m/44'/396'/0'/0/0"
dictionary?: number – Dictionary identifier
word_count?: number – Word count

Result

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

hdkey_xprv_from_mnemonic

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

type ParamsOfHDKeyXPrvFromMnemonic = {
    phrase: string,
    dictionary?: number,
    word_count?: number
}

type ResultOfHDKeyXPrvFromMnemonic = {
    xprv: string
}

function hdkey_xprv_from_mnemonic(
    params: ParamsOfHDKeyXPrvFromMnemonic,
): Promise<ResultOfHDKeyXPrvFromMnemonic>;

Parameters

phrase: string – String with seed phrase
dictionary?: number – Dictionary identifier
word_count?: number – Mnemonic word count

Result

xprv: string – Serialized extended master private key

hdkey_derive_from_xprv

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

type ParamsOfHDKeyDeriveFromXPrv = {
    xprv: string,
    child_index: number,
    hardened: boolean
}

type ResultOfHDKeyDeriveFromXPrv = {
    xprv: string
}

function hdkey_derive_from_xprv(
    params: ParamsOfHDKeyDeriveFromXPrv,
): Promise<ResultOfHDKeyDeriveFromXPrv>;

Parameters

xprv: string – Serialized extended private key
child_index: number – Child index (see BIP-0032)
hardened: boolean – Indicates the derivation of hardened/not-hardened key (see BIP-0032)

Result

xprv: string – Serialized extended private key

hdkey_derive_from_xprv_path

Derives the extended private key from the specified key and path

type ParamsOfHDKeyDeriveFromXPrvPath = {
    xprv: string,
    path: string
}

type ResultOfHDKeyDeriveFromXPrvPath = {
    xprv: string
}

function hdkey_derive_from_xprv_path(
    params: ParamsOfHDKeyDeriveFromXPrvPath,
): Promise<ResultOfHDKeyDeriveFromXPrvPath>;

Parameters

xprv: string – Serialized extended private key
path: string – Derivation path, for instance "m/44'/396'/0'/0/0"

Result

xprv: string – Derived serialized extended private key

hdkey_secret_from_xprv

Extracts the private key from the serialized extended private key

type ParamsOfHDKeySecretFromXPrv = {
    xprv: string
}

type ResultOfHDKeySecretFromXPrv = {
    secret: string
}

function hdkey_secret_from_xprv(
    params: ParamsOfHDKeySecretFromXPrv,
): Promise<ResultOfHDKeySecretFromXPrv>;

Parameters

xprv: string – Serialized extended private key

Result

secret: string – Private key - 64 symbols hex string

hdkey_public_from_xprv

Extracts the public key from the serialized extended private key

type ParamsOfHDKeyPublicFromXPrv = {
    xprv: string
}

type ResultOfHDKeyPublicFromXPrv = {
    public: string
}

function hdkey_public_from_xprv(
    params: ParamsOfHDKeyPublicFromXPrv,
): Promise<ResultOfHDKeyPublicFromXPrv>;

Parameters

xprv: string – Serialized extended private key

Result

public: string – Public key - 64 symbols hex string

chacha20

Performs symmetric chacha20 encryption.

type ParamsOfChaCha20 = {
    data: string,
    key: string,
    nonce: string
}

type ResultOfChaCha20 = {
    data: string
}

function chacha20(
    params: ParamsOfChaCha20,
): Promise<ResultOfChaCha20>;

Parameters

data: string – Source data to be encrypted or decrypted.
Must be encoded with base64.
key: string – 256-bit key.
Must be encoded with hex.
nonce: string – 96-bit nonce.
Must be encoded with hex.

Result

data: string – Encrypted/decrypted data.
Encoded with base64.

register_signing_box

Register an application implemented signing box.

type RegisteredSigningBox = {
    handle: SigningBoxHandle
}

function register_signing_box(
    obj: AppSigningBox,
): Promise<RegisteredSigningBox>;

Result

handle: SigningBoxHandle – Handle of the signing box.

get_signing_box

Creates a default signing box implementation.

type KeyPair = {
    public: string,
    secret: string
}

type RegisteredSigningBox = {
    handle: SigningBoxHandle
}

function get_signing_box(
    params: KeyPair,
): Promise<RegisteredSigningBox>;

Parameters

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

Result

handle: SigningBoxHandle – Handle of the signing box.

signing_box_get_public_key

Returns public key of signing key pair.

type RegisteredSigningBox = {
    handle: SigningBoxHandle
}

type ResultOfSigningBoxGetPublicKey = {
    pubkey: string
}

function signing_box_get_public_key(
    params: RegisteredSigningBox,
): Promise<ResultOfSigningBoxGetPublicKey>;

Parameters

handle: SigningBoxHandle – Handle of the signing box.

Result

pubkey: string – Public key of signing box.
Encoded with hex

signing_box_sign

Returns signed user data.

type ParamsOfSigningBoxSign = {
    signing_box: SigningBoxHandle,
    unsigned: string
}

type ResultOfSigningBoxSign = {
    signature: string
}

function signing_box_sign(
    params: ParamsOfSigningBoxSign,
): Promise<ResultOfSigningBoxSign>;

Parameters

signing_box: SigningBoxHandle – Signing Box handle.
unsigned: string – Unsigned user data.
Must be encoded with base64.

Result

signature: string – Data signature.
Encoded with hex.

remove_signing_box

Removes signing box from SDK.

type RegisteredSigningBox = {
    handle: SigningBoxHandle
}

function remove_signing_box(
    params: RegisteredSigningBox,
): Promise<void>;

Parameters

handle: SigningBoxHandle – Handle of the signing box.

register_encryption_box

Register an application implemented encryption box.

type RegisteredEncryptionBox = {
    handle: EncryptionBoxHandle
}

function register_encryption_box(
    obj: AppEncryptionBox,
): Promise<RegisteredEncryptionBox>;

Result

handle: EncryptionBoxHandle – Handle of the encryption box

remove_encryption_box

Removes encryption box from SDK

type RegisteredEncryptionBox = {
    handle: EncryptionBoxHandle
}

function remove_encryption_box(
    params: RegisteredEncryptionBox,
): Promise<void>;

Parameters

handle: EncryptionBoxHandle – Handle of the encryption box

encryption_box_get_info

Queries info from the given encryption box

type ParamsOfEncryptionBoxGetInfo = {
    encryption_box: EncryptionBoxHandle
}

type ResultOfEncryptionBoxGetInfo = {
    info: EncryptionBoxInfo
}

function encryption_box_get_info(
    params: ParamsOfEncryptionBoxGetInfo,
): Promise<ResultOfEncryptionBoxGetInfo>;

Parameters

encryption_box: EncryptionBoxHandle – Encryption box handle

Result

info: EncryptionBoxInfo – Encryption box information

encryption_box_encrypt

Encrypts data using given encryption box Note.

Block cipher algorithms pad data to cipher block size so encrypted data can be longer then original data. Client should store the original data size after encryption and use it after decryption to retrieve the original data from decrypted data.

type ParamsOfEncryptionBoxEncrypt = {
    encryption_box: EncryptionBoxHandle,
    data: string
}

type ResultOfEncryptionBoxEncrypt = {
    data: string
}

function encryption_box_encrypt(
    params: ParamsOfEncryptionBoxEncrypt,
): Promise<ResultOfEncryptionBoxEncrypt>;

Parameters

encryption_box: EncryptionBoxHandle – Encryption box handle
data: string – Data to be encrypted, encoded in Base64

Result

data: string – Encrypted data, encoded in Base64.
Padded to cipher block size

encryption_box_decrypt

Decrypts data using given encryption box Note.

Block cipher algorithms pad data to cipher block size so encrypted data can be longer then original data. Client should store the original data size after encryption and use it after decryption to retrieve the original data from decrypted data.

type ParamsOfEncryptionBoxDecrypt = {
    encryption_box: EncryptionBoxHandle,
    data: string
}

type ResultOfEncryptionBoxDecrypt = {
    data: string
}

function encryption_box_decrypt(
    params: ParamsOfEncryptionBoxDecrypt,
): Promise<ResultOfEncryptionBoxDecrypt>;

Parameters

encryption_box: EncryptionBoxHandle – Encryption box handle
data: string – Data to be decrypted, encoded in Base64

Result

data: string – Decrypted data, encoded in Base64.

create_encryption_box

Creates encryption box with specified algorithm

type ParamsOfCreateEncryptionBox = {
    algorithm: EncryptionAlgorithm
}

type RegisteredEncryptionBox = {
    handle: EncryptionBoxHandle
}

function create_encryption_box(
    params: ParamsOfCreateEncryptionBox,
): Promise<RegisteredEncryptionBox>;

Parameters

algorithm: EncryptionAlgorithm – Encryption algorithm specifier including cipher parameters (key, IV, etc)

Result

handle: EncryptionBoxHandle – Handle of the encryption box

Types

CryptoErrorCode

enum CryptoErrorCode {
    InvalidPublicKey = 100,
    InvalidSecretKey = 101,
    InvalidKey = 102,
    InvalidFactorizeChallenge = 106,
    InvalidBigInt = 107,
    ScryptFailed = 108,
    InvalidKeySize = 109,
    NaclSecretBoxFailed = 110,
    NaclBoxFailed = 111,
    NaclSignFailed = 112,
    Bip39InvalidEntropy = 113,
    Bip39InvalidPhrase = 114,
    Bip32InvalidKey = 115,
    Bip32InvalidDerivePath = 116,
    Bip39InvalidDictionary = 117,
    Bip39InvalidWordCount = 118,
    MnemonicGenerationFailed = 119,
    MnemonicFromEntropyFailed = 120,
    SigningBoxNotRegistered = 121,
    InvalidSignature = 122,
    EncryptionBoxNotRegistered = 123,
    InvalidIvSize = 124,
    UnsupportedCipherMode = 125,
    CannotCreateCipher = 126,
    EncryptDataError = 127,
    DecryptDataError = 128,
    IvRequired = 129
}

One of the following value:

InvalidPublicKey = 100
InvalidSecretKey = 101
InvalidKey = 102
InvalidFactorizeChallenge = 106
InvalidBigInt = 107
ScryptFailed = 108
InvalidKeySize = 109
NaclSecretBoxFailed = 110
NaclBoxFailed = 111
NaclSignFailed = 112
Bip39InvalidEntropy = 113
Bip39InvalidPhrase = 114
Bip32InvalidKey = 115
Bip32InvalidDerivePath = 116
Bip39InvalidDictionary = 117
Bip39InvalidWordCount = 118
MnemonicGenerationFailed = 119
MnemonicFromEntropyFailed = 120
SigningBoxNotRegistered = 121
InvalidSignature = 122
EncryptionBoxNotRegistered = 123
InvalidIvSize = 124
UnsupportedCipherMode = 125
CannotCreateCipher = 126
EncryptDataError = 127
DecryptDataError = 128
IvRequired = 129

SigningBoxHandle

type SigningBoxHandle = number

EncryptionBoxHandle

type EncryptionBoxHandle = number

EncryptionBoxInfo

Encryption box information

type EncryptionBoxInfo = {
    hdpath?: string,
    algorithm?: string,
    options?: any,
    public?: any
}

hdpath?: string – Derivation path, for instance "m/44'/396'/0'/0/0"
algorithm?: string – Cryptographic algorithm, used by this encryption box
options?: any – Options, depends on algorithm and specific encryption box implementation
public?: any – Public information, depends on algorithm

EncryptionAlgorithm

type EncryptionAlgorithm = ({
    type: 'AES'
} & AesParams)

Depends on value of the type field.

When type is 'AES'

mode: CipherMode
key: string
iv?: string

Variant constructors:

function encryptionAlgorithmAES(params: AesParams): EncryptionAlgorithm;

CipherMode

enum CipherMode {
    CBC = "CBC",
    CFB = "CFB",
    CTR = "CTR",
    ECB = "ECB",
    OFB = "OFB"
}

One of the following value:

CBC = "CBC"
CFB = "CFB"
CTR = "CTR"
ECB = "ECB"
OFB = "OFB"

AesParams

type AesParams = {
    mode: CipherMode,
    key: string,
    iv?: string
}

mode: CipherMode
key: string
iv?: string

AesInfo

type AesInfo = {
    mode: CipherMode,
    iv?: string
}

mode: CipherMode
iv?: string

ParamsOfFactorize

type ParamsOfFactorize = {
    composite: string
}

composite: string – Hexadecimal representation of u64 composite number.

ResultOfFactorize

type ResultOfFactorize = {
    factors: string[]
}

factors: string[] – Two factors of composite or empty if composite can't be factorized.

ParamsOfModularPower

type ParamsOfModularPower = {
    base: string,
    exponent: string,
    modulus: string
}

base: string – base argument of calculation.
exponent: string – exponent argument of calculation.
modulus: string – modulus argument of calculation.

ResultOfModularPower

type ResultOfModularPower = {
    modular_power: string
}

modular_power: string – Result of modular exponentiation

ParamsOfTonCrc16

type ParamsOfTonCrc16 = {
    data: string
}

data: string – Input data for CRC calculation.
Encoded with base64.

ResultOfTonCrc16

type ResultOfTonCrc16 = {
    crc: number
}

crc: number – Calculated CRC for input data.

ParamsOfGenerateRandomBytes

type ParamsOfGenerateRandomBytes = {
    length: number
}

length: number – Size of random byte array.

ResultOfGenerateRandomBytes

type ResultOfGenerateRandomBytes = {
    bytes: string
}

bytes: string – Generated bytes encoded in base64.

ParamsOfConvertPublicKeyToTonSafeFormat

type ParamsOfConvertPublicKeyToTonSafeFormat = {
    public_key: string
}

public_key: string – Public key - 64 symbols hex string

ResultOfConvertPublicKeyToTonSafeFormat

type ResultOfConvertPublicKeyToTonSafeFormat = {
    ton_public_key: string
}

ton_public_key: string – Public key represented in TON safe format.

KeyPair

type KeyPair = {
    public: string,
    secret: string
}

public: string – Public key - 64 symbols hex string
secret: string – Private key - u64 symbols hex string

ParamsOfSign

type ParamsOfSign = {
    unsigned: string,
    keys: KeyPair
}

unsigned: string – Data that must be signed encoded in base64.
keys: KeyPair – Sign keys.

ResultOfSign

type ResultOfSign = {
    signed: string,
    signature: string
}

signed: string – Signed data combined with signature encoded in base64.
signature: string – Signature encoded in hex.

ParamsOfVerifySignature

type ParamsOfVerifySignature = {
    signed: string,
    public: string
}

signed: string – Signed data that must be verified encoded in base64.
public: string – Signer's public key - 64 symbols hex string

ResultOfVerifySignature

type ResultOfVerifySignature = {
    unsigned: string
}

unsigned: string – Unsigned data encoded in base64.

ParamsOfHash

type ParamsOfHash = {
    data: string
}

data: string – Input data for hash calculation.
Encoded with base64.

ResultOfHash

type ResultOfHash = {
    hash: string
}

hash: string – Hash of input data.
Encoded with 'hex'.

ParamsOfScrypt

type ParamsOfScrypt = {
    password: string,
    salt: string,
    log_n: number,
    r: number,
    p: number,
    dk_len: number
}

password: string – The password bytes to be hashed. Must be encoded with base64.
salt: string – Salt bytes that modify the hash to protect against Rainbow table attacks. Must be encoded with base64.
log_n: number – CPU/memory cost parameter
r: number – The block size parameter, which fine-tunes sequential memory read size and performance.
p: number – Parallelization parameter.
dk_len: number – Intended output length in octets of the derived key.

ResultOfScrypt

type ResultOfScrypt = {
    key: string
}

key: string – Derived key.
Encoded with hex.

ParamsOfNaclSignKeyPairFromSecret

type ParamsOfNaclSignKeyPairFromSecret = {
    secret: string
}

secret: string – Secret key - unprefixed 0-padded to 64 symbols hex string

ParamsOfNaclSign

type ParamsOfNaclSign = {
    unsigned: string,
    secret: string
}

unsigned: string – Data that must be signed encoded in base64.
secret: string – Signer's secret key - unprefixed 0-padded to 128 symbols hex string (concatenation of 64 symbols secret and 64 symbols public keys). See nacl_sign_keypair_from_secret_key.

ResultOfNaclSign

type ResultOfNaclSign = {
    signed: string
}

signed: string – Signed data, encoded in base64.

ParamsOfNaclSignOpen

type ParamsOfNaclSignOpen = {
    signed: string,
    public: string
}

signed: string – Signed data that must be unsigned.
Encoded with base64.
public: string – Signer's public key - unprefixed 0-padded to 64 symbols hex string

ResultOfNaclSignOpen

type ResultOfNaclSignOpen = {
    unsigned: string
}

unsigned: string – Unsigned data, encoded in base64.

ResultOfNaclSignDetached

type ResultOfNaclSignDetached = {
    signature: string
}

signature: string – Signature encoded in hex.

ParamsOfNaclSignDetachedVerify

type ParamsOfNaclSignDetachedVerify = {
    unsigned: string,
    signature: string,
    public: string
}

unsigned: string – Unsigned data that must be verified.
Encoded with base64.
signature: string – Signature that must be verified.
Encoded with hex.
public: string – Signer's public key - unprefixed 0-padded to 64 symbols hex string.

ResultOfNaclSignDetachedVerify

type ResultOfNaclSignDetachedVerify = {
    succeeded: boolean
}

succeeded: boolean – true if verification succeeded or false if it failed

ParamsOfNaclBoxKeyPairFromSecret

type ParamsOfNaclBoxKeyPairFromSecret = {
    secret: string
}

secret: string – Secret key - unprefixed 0-padded to 64 symbols hex string

ParamsOfNaclBox

type ParamsOfNaclBox = {
    decrypted: string,
    nonce: string,
    their_public: string,
    secret: string
}

decrypted: string – Data that must be encrypted encoded in base64.
nonce: string – Nonce, encoded in hex
their_public: string – Receiver's public key - unprefixed 0-padded to 64 symbols hex string
secret: string – Sender's private key - unprefixed 0-padded to 64 symbols hex string

ResultOfNaclBox

type ResultOfNaclBox = {
    encrypted: string
}

encrypted: string – Encrypted data encoded in base64.

ParamsOfNaclBoxOpen

type ParamsOfNaclBoxOpen = {
    encrypted: string,
    nonce: string,
    their_public: string,
    secret: string
}

encrypted: string – Data that must be decrypted.
Encoded with base64.
nonce: string
their_public: string – Sender's public key - unprefixed 0-padded to 64 symbols hex string
secret: string – Receiver's private key - unprefixed 0-padded to 64 symbols hex string

ResultOfNaclBoxOpen

type ResultOfNaclBoxOpen = {
    decrypted: string
}

decrypted: string – Decrypted data encoded in base64.

ParamsOfNaclSecretBox

type ParamsOfNaclSecretBox = {
    decrypted: string,
    nonce: string,
    key: string
}

decrypted: string – Data that must be encrypted.
Encoded with base64.
nonce: string – Nonce in hex
key: string – Secret key - unprefixed 0-padded to 64 symbols hex string

ParamsOfNaclSecretBoxOpen

type ParamsOfNaclSecretBoxOpen = {
    encrypted: string,
    nonce: string,
    key: string
}

encrypted: string – Data that must be decrypted.
Encoded with base64.
nonce: string – Nonce in hex
key: string – Public key - unprefixed 0-padded to 64 symbols hex string

ParamsOfMnemonicWords

type ParamsOfMnemonicWords = {
    dictionary?: number
}

dictionary?: number – Dictionary identifier

ResultOfMnemonicWords

type ResultOfMnemonicWords = {
    words: string
}

words: string – The list of mnemonic words

ParamsOfMnemonicFromRandom

type ParamsOfMnemonicFromRandom = {
    dictionary?: number,
    word_count?: number
}

dictionary?: number – Dictionary identifier
word_count?: number – Mnemonic word count

ResultOfMnemonicFromRandom

type ResultOfMnemonicFromRandom = {
    phrase: string
}

phrase: string – String of mnemonic words

ParamsOfMnemonicFromEntropy

type ParamsOfMnemonicFromEntropy = {
    entropy: string,
    dictionary?: number,
    word_count?: number
}

entropy: string – Entropy bytes.
Hex encoded.
dictionary?: number – Dictionary identifier
word_count?: number – Mnemonic word count

ResultOfMnemonicFromEntropy

type ResultOfMnemonicFromEntropy = {
    phrase: string
}

phrase: string – Phrase

ParamsOfMnemonicVerify

type ParamsOfMnemonicVerify = {
    phrase: string,
    dictionary?: number,
    word_count?: number
}

phrase: string – Phrase
dictionary?: number – Dictionary identifier
word_count?: number – Word count

ResultOfMnemonicVerify

type ResultOfMnemonicVerify = {
    valid: boolean
}

valid: boolean – Flag indicating if the mnemonic is valid or not

ParamsOfMnemonicDeriveSignKeys

type ParamsOfMnemonicDeriveSignKeys = {
    phrase: string,
    path?: string,
    dictionary?: number,
    word_count?: number
}

phrase: string – Phrase
path?: string – Derivation path, for instance "m/44'/396'/0'/0/0"
dictionary?: number – Dictionary identifier
word_count?: number – Word count

ParamsOfHDKeyXPrvFromMnemonic

type ParamsOfHDKeyXPrvFromMnemonic = {
    phrase: string,
    dictionary?: number,
    word_count?: number
}

phrase: string – String with seed phrase
dictionary?: number – Dictionary identifier
word_count?: number – Mnemonic word count

ResultOfHDKeyXPrvFromMnemonic

type ResultOfHDKeyXPrvFromMnemonic = {
    xprv: string
}

xprv: string – Serialized extended master private key

ParamsOfHDKeyDeriveFromXPrv

type ParamsOfHDKeyDeriveFromXPrv = {
    xprv: string,
    child_index: number,
    hardened: boolean
}

xprv: string – Serialized extended private key
child_index: number – Child index (see BIP-0032)
hardened: boolean – Indicates the derivation of hardened/not-hardened key (see BIP-0032)

ResultOfHDKeyDeriveFromXPrv

type ResultOfHDKeyDeriveFromXPrv = {
    xprv: string
}

xprv: string – Serialized extended private key

ParamsOfHDKeyDeriveFromXPrvPath

type ParamsOfHDKeyDeriveFromXPrvPath = {
    xprv: string,
    path: string
}

xprv: string – Serialized extended private key
path: string – Derivation path, for instance "m/44'/396'/0'/0/0"

ResultOfHDKeyDeriveFromXPrvPath

type ResultOfHDKeyDeriveFromXPrvPath = {
    xprv: string
}

xprv: string – Derived serialized extended private key

ParamsOfHDKeySecretFromXPrv

type ParamsOfHDKeySecretFromXPrv = {
    xprv: string
}

xprv: string – Serialized extended private key

ResultOfHDKeySecretFromXPrv

type ResultOfHDKeySecretFromXPrv = {
    secret: string
}

secret: string – Private key - 64 symbols hex string

ParamsOfHDKeyPublicFromXPrv

type ParamsOfHDKeyPublicFromXPrv = {
    xprv: string
}

xprv: string – Serialized extended private key

ResultOfHDKeyPublicFromXPrv

type ResultOfHDKeyPublicFromXPrv = {
    public: string
}

public: string – Public key - 64 symbols hex string

ParamsOfChaCha20

type ParamsOfChaCha20 = {
    data: string,
    key: string,
    nonce: string
}

data: string – Source data to be encrypted or decrypted.
Must be encoded with base64.
key: string – 256-bit key.
Must be encoded with hex.
nonce: string – 96-bit nonce.
Must be encoded with hex.

ResultOfChaCha20

type ResultOfChaCha20 = {
    data: string
}

data: string – Encrypted/decrypted data.
Encoded with base64.

RegisteredSigningBox

type RegisteredSigningBox = {
    handle: SigningBoxHandle
}

handle: SigningBoxHandle – Handle of the signing box.

ParamsOfAppSigningBox

Signing box callbacks.

type ParamsOfAppSigningBox = {
    type: 'GetPublicKey'
} | {
    type: 'Sign'
    unsigned: string
}

Depends on value of the type field.

When type is 'GetPublicKey'

Get signing box public key

When type is 'Sign'

Sign data

unsigned: string – Data to sign encoded as base64

Variant constructors:

function paramsOfAppSigningBoxGetPublicKey(): ParamsOfAppSigningBox;
function paramsOfAppSigningBoxSign(unsigned: string): ParamsOfAppSigningBox;

ResultOfAppSigningBox

Returning values from signing box callbacks.

type ResultOfAppSigningBox = {
    type: 'GetPublicKey'
    public_key: string
} | {
    type: 'Sign'
    signature: string
}

Depends on value of the type field.

When type is 'GetPublicKey'

Result of getting public key

public_key: string – Signing box public key

When type is 'Sign'

Result of signing data

signature: string – Data signature encoded as hex

Variant constructors:

function resultOfAppSigningBoxGetPublicKey(public_key: string): ResultOfAppSigningBox;
function resultOfAppSigningBoxSign(signature: string): ResultOfAppSigningBox;

ResultOfSigningBoxGetPublicKey

type ResultOfSigningBoxGetPublicKey = {
    pubkey: string
}

pubkey: string – Public key of signing box.
Encoded with hex

ParamsOfSigningBoxSign

type ParamsOfSigningBoxSign = {
    signing_box: SigningBoxHandle,
    unsigned: string
}

signing_box: SigningBoxHandle – Signing Box handle.
unsigned: string – Unsigned user data.
Must be encoded with base64.

ResultOfSigningBoxSign

type ResultOfSigningBoxSign = {
    signature: string
}

signature: string – Data signature.
Encoded with hex.

RegisteredEncryptionBox

type RegisteredEncryptionBox = {
    handle: EncryptionBoxHandle
}

handle: EncryptionBoxHandle – Handle of the encryption box

ParamsOfAppEncryptionBox

Encryption box callbacks.

type ParamsOfAppEncryptionBox = {
    type: 'GetInfo'
} | {
    type: 'Encrypt'
    data: string
} | {
    type: 'Decrypt'
    data: string
}

Depends on value of the type field.

When type is 'GetInfo'

Get encryption box info

When type is 'Encrypt'

Encrypt data

data: string – Data, encoded in Base64

When type is 'Decrypt'

Decrypt data

data: string – Data, encoded in Base64

Variant constructors:

function paramsOfAppEncryptionBoxGetInfo(): ParamsOfAppEncryptionBox;
function paramsOfAppEncryptionBoxEncrypt(data: string): ParamsOfAppEncryptionBox;
function paramsOfAppEncryptionBoxDecrypt(data: string): ParamsOfAppEncryptionBox;

ResultOfAppEncryptionBox

Returning values from signing box callbacks.

type ResultOfAppEncryptionBox = {
    type: 'GetInfo'
    info: EncryptionBoxInfo
} | {
    type: 'Encrypt'
    data: string
} | {
    type: 'Decrypt'
    data: string
}

Depends on value of the type field.

When type is 'GetInfo'

Result of getting encryption box info

info: EncryptionBoxInfo

When type is 'Encrypt'

Result of encrypting data

data: string – Encrypted data, encoded in Base64

When type is 'Decrypt'

Result of decrypting data

data: string – Decrypted data, encoded in Base64

Variant constructors:

function resultOfAppEncryptionBoxGetInfo(info: EncryptionBoxInfo): ResultOfAppEncryptionBox;
function resultOfAppEncryptionBoxEncrypt(data: string): ResultOfAppEncryptionBox;
function resultOfAppEncryptionBoxDecrypt(data: string): ResultOfAppEncryptionBox;

ParamsOfEncryptionBoxGetInfo

type ParamsOfEncryptionBoxGetInfo = {
    encryption_box: EncryptionBoxHandle
}

encryption_box: EncryptionBoxHandle – Encryption box handle

ResultOfEncryptionBoxGetInfo

type ResultOfEncryptionBoxGetInfo = {
    info: EncryptionBoxInfo
}

info: EncryptionBoxInfo – Encryption box information

ParamsOfEncryptionBoxEncrypt

type ParamsOfEncryptionBoxEncrypt = {
    encryption_box: EncryptionBoxHandle,
    data: string
}

encryption_box: EncryptionBoxHandle – Encryption box handle
data: string – Data to be encrypted, encoded in Base64

ResultOfEncryptionBoxEncrypt

type ResultOfEncryptionBoxEncrypt = {
    data: string
}

data: string – Encrypted data, encoded in Base64.
Padded to cipher block size

ParamsOfEncryptionBoxDecrypt

type ParamsOfEncryptionBoxDecrypt = {
    encryption_box: EncryptionBoxHandle,
    data: string
}

encryption_box: EncryptionBoxHandle – Encryption box handle
data: string – Data to be decrypted, encoded in Base64

ResultOfEncryptionBoxDecrypt

type ResultOfEncryptionBoxDecrypt = {
    data: string
}

data: string – Decrypted data, encoded in Base64.

ParamsOfCreateEncryptionBox

type ParamsOfCreateEncryptionBox = {
    algorithm: EncryptionAlgorithm
}

algorithm: EncryptionAlgorithm – Encryption algorithm specifier including cipher parameters (key, IV, etc)

AppSigningBox

type ResultOfAppSigningBoxGetPublicKey = {
    public_key: string
}

type ParamsOfAppSigningBoxSign = {
    unsigned: string
}

type ResultOfAppSigningBoxSign = {
    signature: string
}

export interface AppSigningBox {
    get_public_key(): Promise<ResultOfAppSigningBoxGetPublicKey>,
    sign(params: ParamsOfAppSigningBoxSign): Promise<ResultOfAppSigningBoxSign>,
}

get_public_key

Get signing box public key

type ResultOfAppSigningBoxGetPublicKey = {
    public_key: string
}

function get_public_key(): Promise<ResultOfAppSigningBoxGetPublicKey>;

Result

public_key: string – Signing box public key

sign

Sign data

type ParamsOfAppSigningBoxSign = {
    unsigned: string
}

type ResultOfAppSigningBoxSign = {
    signature: string
}

function sign(
    params: ParamsOfAppSigningBoxSign,
): Promise<ResultOfAppSigningBoxSign>;

Parameters

unsigned: string – Data to sign encoded as base64

Result

signature: string – Data signature encoded as hex

AppEncryptionBox

type ResultOfAppEncryptionBoxGetInfo = {
    info: EncryptionBoxInfo
}

type ParamsOfAppEncryptionBoxEncrypt = {
    data: string
}

type ResultOfAppEncryptionBoxEncrypt = {
    data: string
}

type ParamsOfAppEncryptionBoxDecrypt = {
    data: string
}

type ResultOfAppEncryptionBoxDecrypt = {
    data: string
}

export interface AppEncryptionBox {
    get_info(): Promise<ResultOfAppEncryptionBoxGetInfo>,
    encrypt(params: ParamsOfAppEncryptionBoxEncrypt): Promise<ResultOfAppEncryptionBoxEncrypt>,
    decrypt(params: ParamsOfAppEncryptionBoxDecrypt): Promise<ResultOfAppEncryptionBoxDecrypt>,
}

get_info

Get encryption box info

type ResultOfAppEncryptionBoxGetInfo = {
    info: EncryptionBoxInfo
}

function get_info(): Promise<ResultOfAppEncryptionBoxGetInfo>;

Result

info: EncryptionBoxInfo

encrypt

Encrypt data

type ParamsOfAppEncryptionBoxEncrypt = {
    data: string
}

type ResultOfAppEncryptionBoxEncrypt = {
    data: string
}

function encrypt(
    params: ParamsOfAppEncryptionBoxEncrypt,
): Promise<ResultOfAppEncryptionBoxEncrypt>;

Parameters

data: string – Data, encoded in Base64

Result

data: string – Encrypted data, encoded in Base64

decrypt

Decrypt data

type ParamsOfAppEncryptionBoxDecrypt = {
    data: string
}

type ResultOfAppEncryptionBoxDecrypt = {
    data: string
}

function decrypt(
    params: ParamsOfAppEncryptionBoxDecrypt,
): Promise<ResultOfAppEncryptionBoxDecrypt>;

Parameters

data: string – Data, encoded in Base64

Result

data: string – Decrypted data, encoded in Base64

Files

mod_crypto.md

Latest commit

History

mod_crypto.md

File metadata and controls

Module crypto

Functions

Types

Functions

factorize

Parameters

Result

modular_power

Parameters

Result

ton_crc16

Parameters

Result

generate_random_bytes

Parameters

Result

convert_public_key_to_ton_safe_format

Parameters

Result

generate_random_sign_keys

Result

sign

Parameters

Result

verify_signature

Parameters

Result

sha256

Parameters

Result

sha512

Parameters

Result

scrypt

Arguments

Conditions

Recommended values sufficient for most use-cases

Parameters

Result

nacl_sign_keypair_from_secret_key

Parameters

Result

nacl_sign

Parameters

Result

nacl_sign_open

Parameters

Result

nacl_sign_detached

Parameters

Result

nacl_sign_detached_verify

Parameters

Result

nacl_box_keypair

Result

nacl_box_keypair_from_secret_key

Parameters

Result

nacl_box

Parameters

Result

nacl_box_open

Parameters

Result

nacl_secret_box

Parameters

Result

nacl_secret_box_open

Parameters

Result

mnemonic_words

Parameters

Result