Skip to main content

Class: TokenSDK

Hierarchy​

  • Soroban

    ↳ TokenSDK

Constructors​

constructor​

• new TokenSDK(selectedNetwork, activePublicKey?)

Parameters​

NameType
selectedNetworkNetworkDetails
activePublicKey?string

Overrides​

Soroban.constructor

Defined in​

src/sdk/token-sdk.ts:17

Accessors​

setPublicKey​

• Protected set setPublicKey(publicKey): void

Parameters​

NameType
publicKeystring

Returns​

void

Inherited from​

Soroban.setPublicKey

Defined in​

src/sdk/soroban.ts:100

Methods​

balance​

▸ balance(contractAddress, address?): Promise<BigInt>

Retrieves the balance of an address for a given token contract.

If an address is provided, it retrieves the balance for the specified address. If no address is provided, it retrieves the balance for the Freighter user's address.

Parameters​

NameTypeDescription
contractAddressstringThe address of the token contract.
address?string(Optional) The address for which to retrieve the balance. If not provided, the Freighter user's address will be used.

Returns​

Promise<BigInt>

  • A promise that resolves to the balance of the specified address in the token contract as a BigInt.

Throws

If there is an error in retrieving the balance or if no address is provided.

Example

// Example 1: Retrieve the balance of the Freighter user's address for a token contract.
const contractAddress = "CAZNM4AAQCQPUQGR72MIC7NPWHZBDOQKZBUQ3WTULIDALOWMOG23L6JT";
const symbol = await sdk.wallet.balance(contractAddress);
console.log(`Balance: ${symbol}`); // Example output: Balance: 1000n

Example

// Example 2: Retrieve the balance of a specific address for a token contract.
const contractAddress = "CAZNM4AAQCQPUQGR72MIC7NPWHZBDOQKZBUQ3WTULIDALOWMOG23L6JT";
const address = "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN";
const symbol = await sdk.wallet.balance(contractAddress, address);
console.log(`Balance: ${symbol}`); // Example output: Balance: 1000n

Defined in​

src/sdk/token-sdk.ts:91


calculateEstimateGas​

▸ Protected calculateEstimateGas(contractAddress, method, args): Promise<string>

Helper function to estimate the gas cost of a contract call. This estimation is done by creating a transaction builder and simulating the transaction using the Soroban network. The gas cost is calculated as the sum of the base fee and the fee obtained from the simulated transaction.

Parameters​

NameTypeDescription
contractAddressstringThe contract address to estimate gas for.
methodstringThe name of the method to be called on the contract.
argsScVal[]An array of ScVal arguments to pass to the method.

Returns​

Promise<string>

A promise that resolves to a string representation of the estimated gas cost for the contract call.

Example

const gasEstimation = await sdk.estimateGas(
"CCV3ODCHRVCUQTWJZ7F7SLKHGT3JLYWUVHAWMKIYQVSCKMGSOCOJ3AUO",
"init",
[xdr.scVal.scvString("Hello World"), new Address("GB...").toScAddress(), ...]
);

const gasCostInStroops: number = parseInt(gasEstimation); // Convert to a number if needed.

Inherited from​

Soroban.calculateEstimateGas

Defined in​

src/sdk/soroban.ts:81


createAsset​

▸ createAsset(assetCode, assetIssuer?, limit?): Promise<undefined | Asset>

Creates a new asset with the specified asset code, asset issuer, and limit. This operation involves two steps: creating a trustline for the asset and funding it.

Parameters​

NameTypeDefault valueDescription
assetCodestringundefinedThe code (symbol) of the asset to create.
assetIssuer?stringundefined(Optional) The issuer's public key for the asset. Defaults to the current user's public key.
limit?string"10000000"(Optional) The maximum limit for the asset. Defaults to "10000000".

Returns​

Promise<undefined | Asset>

  • A promise that resolves to the created asset or undefined if the operation fails.

Throws

If any step of the asset creation process fails.

Example

const asset = await sdk.wallet.createAsset(
"WXLM",
"GDLEI7MS6EMTGHB7N5YHSVEMEWSWNUM4T77VDEGNTXSBRTIGMXUCE5GF",
10000000)
console.log(asset.getCode()); // WXLM
console.log(asset.getIssuer()); // GDLEI7MS6EMTGHB7N5YHSVEMEWSWNUM4T77VDEGNTXSBRTIGMXUCE5GF

Defined in​

src/sdk/token-sdk.ts:312


decimal​

▸ decimal(contractAddress): Promise<number>

Retrieves the decimal value of a token contract given its contract address.

If the address is not provided, it retrieves the decimal value for the Freighter user's balance.

Parameters​

NameTypeDescription
contractAddressstringThe address of the token contract.

Returns​

Promise<number>

  • A promise that resolves to the decimal value of the token contract.

Throws

If there is an error in retrieving the decimal value.

Example

// Retrieve the decimal value of a token contract by its address.
const contractAddress = "CAZNM4AAQCQPUQGR72MIC7NPWHZBDOQKZBUQ3WTULIDALOWMOG23L6JT";
const decimal = await sdk.wallet.decimal(contractAddress);
console.log(`Decimal value: ${decimal}`); // Example output: Decimal value: 7

Defined in​

src/sdk/token-sdk.ts:112


deploy​

▸ deploy(): Promise<string>

Deploys a smart contract token to the using a given WebAssembly (Wasm) binary code and returns the contract's unique identifier (contractId).

Returns​

Promise<string>

  • A promise that resolves to the unique identifier (contractId) of the deployed smart contract.

Async

Throws

If the deployment fails or if contractId retrieval encounters an error.

Example

const wasmId = "706ac9480880242cd030a5efeb060d86f51627fb8488f5e78660a7f175b85fe1";
try {
const contractId = await deploy(wasmId);
const contractAddress = sdk.util.getContractAddress(contractId);
console.log(`Smart contract deployed with contract: ${contractAddress}`);
} catch (error) {
console.error(`Smart contract deployment failed: ${error.message}`);
}

Defined in​

src/sdk/token-sdk.ts:135


getContractAddressFromAsset​

▸ getContractAddressFromAsset(code, issuer): Promise<string>

Retrieves the contract address associated with an asset using its code and issuer's public key.

Parameters​

NameTypeDescription
codestringThe code (symbol) of the asset.
issuerstringThe issuer's public key for the asset.

Returns​

Promise<string>

  • A promise that resolves to the contract address of the asset. Returns an empty string if an error occurs during retrieval.

Async

Example

const assetCode = "XLM";
const assetIssuer = "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN";
try {
const contractAddress = await sdk.token.getContractAddressFromAsset(assetCode, assetIssuer);
console.log(`Contract address for ${assetCode} issued by ${assetIssuer}: ${contractAddress}`);
} catch (error) {
console.error(`Failed to retrieve contract address: ${error.message}`);
}

Defined in​

src/sdk/token-sdk.ts:223


initialise​

▸ initialise(contractAddress, name, symbol, decimal): Promise<boolean>

Used ContractSDK.call to call the contract method initialize. This will be deprecated in the future.

Parameters​

NameType
contractAddressstring
namestring
symbolstring
decimalnumber

Returns​

Promise<boolean>

Defined in​

src/sdk/token-sdk.ts:162


load​

▸ load(contractAddress): SorosanToken

Parameters​

NameType
contractAddressstring

Returns​

SorosanToken

Defined in​

src/sdk/token-sdk.ts:24


name​

▸ name(contractAddress): Promise<string>

Retrieves the name of a token contract given its contract address.

Parameters​

NameTypeDescription
contractAddressstringThe address of the token contract.

Returns​

Promise<string>

  • A promise that resolves to the name of the token contract as a string.

Throws

If there is an error in retrieving the token name.

Example

// Retrieve the name of a token contract by its address.
const contractAddress = "CAZNM4AAQCQPUQGR72MIC7NPWHZBDOQKZBUQ3WTULIDALOWMOG23L6JT";
const tokenName = await sdk.wallet.name(contractAddress);
console.log(`Token Name: ${tokenName}`); // Example output: Token Name: Stellar Token

Defined in​

src/sdk/token-sdk.ts:42


symbol​

▸ symbol(contractAddress): Promise<string>

Retrieves the symbol (ticker) of a token contract given its contract address.

Parameters​

NameTypeDescription
contractAddressstringThe address of the token contract.

Returns​

Promise<string>

  • A promise that resolves to the symbol (ticker) of the token contract as a string.

Throws

If there is an error in retrieving the token symbol.

Example

// Retrieve the symbol of a token contract by its address.
const contractAddress = "CAZNM4AAQCQPUQGR72MIC7NPWHZBDOQKZBUQ3WTULIDALOWMOG23L6JT";
const symbol = await sdk.wallet.symbol(contractAddress);
console.log(`Token Symbol: ${symbol}`); // Example output: Token Symbol: XLM

Defined in​

src/sdk/token-sdk.ts:61


wrap​

▸ wrap(asset): Promise<string>

Wraps the specified asset to create a wrapped token. This operation involves creating a wrapped token contract on the blockchain.

Parameters​

NameTypeDescription
assetAssetThe asset to wrap.

Returns​

Promise<string>

  • A promise that resolves to the contract address of the wrapped token.

Throws

If the asset is not provided, the wrap operation fails, or there is an issue with contract creation.

Example

const asset = await sdk.wallet.createAsset(
"WXLM",
"GDLEI7MS6EMTGHB7N5YHSVEMEWSWNUM4T77VDEGNTXSBRTIGMXUCE5GF",
10000000)
const contractAddress = await sdk.wallet.wrap(asset); // Main method
console.log(contractAddress);

Defined in​

src/sdk/token-sdk.ts:360