@glitter-finance/sdk-web
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

“box-dev-logo”

Glitter Finance Web SDK

Following SDK is actively developed by dev team of glitter finance and this SDK is actively managed by Glitter team with full support.

SDK Libraries

  1. Wallets (Different Wallet Integrations for different chains)
  2. Bridge (Bridging specified tokens between different network)

Wallets

You can find several wallet implementations in the SDK.

  1. Metamask
  2. Phantom
  3. Solflare
  4. Pera
  5. Defly
  6. Wallet Connect
  7. Exodus using Wallet Connect
  8. Tronlink
  9. Coin 98

All wallets providers and their connect methods are available in the SDK.

Bridge

You will be able to use bridge functionality through this SDK for several chains.

  1. Algorand
  2. Polygon
  3. Avalanche
  4. Ethereum
  5. Solana
  6. Tron

Installing

Using npm:

$ npm i @glitter-finance/sdk-web

Usage

Importing Wallets and using it for different chains.

import {
  Wallets,
} from "@glitter-finance/sdk-web";

Example

const metamask = new GlitterWallets.networks[chainKey].metamask();
const result = await metamask.connect();
const provider = await metamask.getProvider();

In the above code snippet the chainKey is the chainId to which chain the wallet is getting connected. The chainKey can be specified using ChainNames or Chain ENUM.

import {
  ChainNames,
  Chains
} from "@glitter-finance/sdk-web";

Importing Bridge for each chain and using their functions to bridge.

import {
  SolanaBridge,
  AlgorandBridge,
  EVMBridge,
  TronBridge,
} from "@glitter-finance/sdk-web";

For Solana and Algorand if you want to check whether a token is opted in the wallet or not for that you can use this:

For Algorand

  const bridge = new AlgorandBridge();
  const exists = await obj.optInAccountExists(address, symbol);

For Solana

  const bridge = new SolanaBridge(RPC_URL);
  const exists = await obj.optInAccountExists(address, symbol);

And if it's not opted in to the wallet then you can use this for the opt in:

For Algorand

  const bridge = new AlgorandBridge();
  const transactions = await bridge.optIn(address, symbol);

For Solana

  const bridge = new SolanaBridge(RPC_URL);
  const transactions = await bridge.optIn(address, symbol);

The optIn function will return you the unsigned transaction.

For Bridge you can use the below function:

transactions = await bridge.bridge(swpk, dwpk, dcid, stid, amt);

This will return you the unsigned transaction for the respective chain. This bridge function is present in all Supported network Bridge class.

For further more detail View Docs

Readme

Keywords

none

Package Sidebar

Install

npm i @glitter-finance/sdk-web

Weekly Downloads

1

Version

2.0.1

License

MIT

Unpacked Size

578 kB

Total Files

50

Last publish

Collaborators

  • mamali-glitter
  • aurel-glitter
  • alirizvi512
  • saad-glitter
  • davidglitter
  • andrewcarl