Module @glitter-finance/sdk-core

“box-dev-logo”

Glitter Finance Core SDK

Examples

  1. SDK Setup
    import { BridgeNetworks, BridgeTokens, GlitterBridgeSDK, GlitterEnvironment } from "@glitter-finance/sdk-core";
...

const sdk = new GlitterBridgeSDK();
sdk.setEnvironment(GlitterEnvironment.mainnet)
sdk.connect([
BridgeNetworks.algorand,
BridgeNetworks.Avalanche,
BridgeNetworks.Ethereum,
BridgeNetworks.Polygon,
BridgeNetworks.solana,
BridgeNetworks.TRON,
])
  1. Add Solana and Algorand Accounts
    ...
const algorand = sdk.algorand!
const solana = sdk.solana!

const algoAccount = await algorand.accountsStore.add("<mnemonic>")
const solAccount = await solana.accountStore.add("<mnemonic>")
  1. Get Supported Tokens List
    import { BridgeNetworks, BridgeTokens } from "@glitter-finance/sdk-core";
...

const supportedTokensAlgorand = BridgeTokens.getTokens(BridgeNetworks.algorand)
const supportedTokensSolana = BridgeTokens.getTokens(BridgeNetworks.solana)
const supportedTokensTron = BridgeTokens.getTokens(BridgeNetworks.TRON)
  1. Bridge Tokens
    ...

// Briding xALGO from Solana
const bridgexAlgoTxId = await sdk.solana?.bridge(
solAccount.addr,
algoAccount.addr,
BridgeNetworks.algorand,
"xALGO",
BigInt(10000000)
)

console.log(bridgexAlgoTxId)

Tests

yarn jest packages/sdk-core/tests/enumToString.test --testNamePattern 'Main Test'

Enumerations

Classes

Interfaces

Type Aliases

Properties

Variables

Functions

Properties

mainnetTokenConfig: {
    tokens: ({
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
        cmc_id: string;
        coingecko_id: string;
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
        cmc_id: string;
        coingecko_id: string;
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
        cmc_id: string;
        coingecko_id: string;
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: {
            address: string;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
            vault_address: string;
            vault_type: string;
        }[];
        cmc_id: string;
        coingecko_id: string;
    })[];
}

Type declaration

  • tokens: ({
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
        cmc_id: string;
        coingecko_id: string;
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
        cmc_id: string;
        coingecko_id: string;
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
        cmc_id: string;
        coingecko_id: string;
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: {
            address: string;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
            vault_address: string;
            vault_type: string;
        }[];
        cmc_id: string;
        coingecko_id: string;
    })[]
testnetTokenConfig: {
    tokens: ({
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: {
            address: string;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
            vault_id: number;
            vault_type: string;
        }[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: {
            address: string;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
            vault_address: string;
            vault_type: string;
        }[];
    })[];
}

Type declaration

  • tokens: ({
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            isNative?: undefined;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            isNative: boolean;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: ({
            address?: undefined;
            asset_id: number;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        } | {
            address: string;
            asset_id?: undefined;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
        })[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: {
            address: string;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
            vault_id: number;
            vault_type: string;
        }[];
    } | {
        asset_bridge_fee: number;
        asset_id: number;
        asset_name: string;
        asset_symbol: string;
        chains: {
            address: string;
            chain: string;
            decimals: number;
            min_transfer: number;
            name: string;
            symbol: string;
            vault_address: string;
            vault_type: string;
        }[];
    })[]

Generated using TypeDoc