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

BlockDataStatus BridgeNetworks BridgeStatus BridgeType ChainStatus GlitterEnvironment PriceDataStatus SolanaPublicNetworks TokenBridgeStatus TransactionType USDCBridgeStatus

Classes

AlgorandAccountsStore AlgorandConnect BridgeApproveSchema BridgeCancelSchema BridgeInitSchema BridgeReleaseSchema BridgeSetSchema BridgeTokens BridgeV2Tokens CurrentBlock DeserializeEvmBridgeTransfer EvmBridgeEventsParser EvmConnect GasEstimator GlitterBridgeSDK RoutingHelper SerializeEvmBridgeTransfer Shorten SolanaAccountsStore SolanaConnect TokenPricing TronConnect ValueUnits

Interfaces

TronTriggerConstantContractResult

Type Aliases

AlgorandAccount AlgorandAccountInformation AlgorandAssetMetadata AlgorandConfig AlgorandMultiSigAccount AlgorandNativeTokenConfig AlgorandPollerOptions AlgorandStandardAssetConfig BridgeDepositEvent BridgeEvmNetworks BridgeReleaseEvent BridgeTokenConfig ChainRPCConfig ChainRPCConfigs CoinMarketCapQuoteResponse CurrentBlockData DepositNote EventTopics EvmConfig EvmNetworkConfig GasEstimate GasTokenEstimate GasUsedEstimate GlitterBridgeConfig PartialBridgeTxn PartialTxn PollerOptions Routing RoutingPoint SolanaAccount SolanaAccountsConfig SolanaConfig Token2ChainConfig Token2Config Token2ConfigList TokenConfig TokenPriceData TransferEvent TronConfig TronConstantContract TronResources

Properties

mainnetTokenConfig testnetTokenConfig

Variables

NetworkIdentifiers mainnetConfig testnetApi testnetConfig

Functions

AlgoBlockData AlgoGasPrice EVMBlockData EVMGasPrice LoadSolanaSchema LogProgress PartialBridgeTxnEquals Precise PreciseDecimals RoutingDefault RoutingPointDefault RoutingString SetRoutingUnits Sleep SolanaBlockData SolanaGasPrice StringToEnum TokenBridgeProgress TokenBridgeStatusDescription TronBlockData TronGasPrice USDCBridgeProgress USDCBridgeStatusDescription addr_to_pk base64To0xString base64ToBigUIntString base64ToString bridgeUSDC closeTokenAccountTransaction createAssociatedTokenAccountTransaction fromCoinMarketCap fromHexString fromTRX generateAssociatedTokenAccountAddress getAssociatedTokenAccount getHashedTransactionId getNetworkByNumericId getNumericNetworkId getPriceFromCoingecko getTRXBurnByEnergy instanceofAlgoAccount sendSolTransaction sendTokenTransaction solBridgeTransaction solanaMnemonicToSecretkey toHexString toTRX tokenBridgeTransaction tronEstimateReleaseTxEnergy tronEstimateTrc20TransferEnergy walletToAddress

Properties

mainnetTokenConfig

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

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;
        }[];
    })[]

Settings

Member Visibility

Theme

Generated using TypeDoc