mod_utils.md

Module utils

Misc utility Functions.

Functions

convert_address – Converts address from any TON format to any TON format

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

Types

AddressStringFormat

ParamsOfConvertAddress

ResultOfConvertAddress

ParamsOfCalcStorageFee

ResultOfCalcStorageFee

Functions

convert_address

Converts address from any TON format to any TON format

type ParamsOfConvertAddress = {
    address: string,
    output_format: AddressStringFormat
}

type ResultOfConvertAddress = {
    address: string
}

function convert_address(
    params: ParamsOfConvertAddress,
): Promise<ResultOfConvertAddress>;

Parameters

• address: string – Account address in any TON format.
• output_format: AddressStringFormat – Specify the format to convert to.

Result

• address: string – Address in the specified format

calc_storage_fee

Calculates storage fee for an account over a specified time period

type ParamsOfCalcStorageFee = {
    account: string,
    period: number
}

type ResultOfCalcStorageFee = {
    fee: string
}

function calc_storage_fee(
    params: ParamsOfCalcStorageFee,
): Promise<ResultOfCalcStorageFee>;

Parameters

• account: string
• period: number

Result

• fee: string

Types

AddressStringFormat

type AddressStringFormat = {
    type: 'AccountId'
} | {
    type: 'Hex'
} | {
    type: 'Base64'
    url: boolean,
    test: boolean,
    bounce: boolean
}

Depends on value of the type field.

When type is 'AccountId'

When type is 'Hex'

When type is 'Base64'

• url: boolean
• test: boolean
• bounce: boolean

Variant constructors:

function addressStringFormatAccountId(): AddressStringFormat;
function addressStringFormatHex(): AddressStringFormat;
function addressStringFormatBase64(url: boolean, test: boolean, bounce: boolean): AddressStringFormat;

ParamsOfConvertAddress

type ParamsOfConvertAddress = {
    address: string,
    output_format: AddressStringFormat
}

• address: string – Account address in any TON format.
• output_format: AddressStringFormat – Specify the format to convert to.

ResultOfConvertAddress

type ResultOfConvertAddress = {
    address: string
}

• address: string – Address in the specified format

ParamsOfCalcStorageFee

type ParamsOfCalcStorageFee = {
    account: string,
    period: number
}

• account: string
• period: number

ResultOfCalcStorageFee

type ResultOfCalcStorageFee = {
    fee: string
}

• fee: string