mangata-sdk v0.49.3

DO NOT USE. UNDER DEVELOPMENT

Getting Started

Mangata SDK is a first library, built in typescript that provides easy methods for buying and selling assets on Mangata DEX. The main purpose is to save time for builders of client applications, primarily for algorithmic traders and frontend interface builders.

Installation

// with npm
npm i mangata-sdk

// with yarn
yarn add mangata-sdk

Basic use case

Here is a quick example to get you started, all you need is Mangata instance:

const { Mangata } = require('mangata-sdk');

async function main () {
  // Connect to the local node (also testnet, mainnet)
  const mangata = Mangata.getInstance('ws://127.0.0.1:9944')

  // Retrieve the chainName, nodeName & nodeVersion information
  const [chain, nodeName, nodeVersion] = await Promise.all([
    mangata.getChain(),
    mangata.getNodeName(),
    mangata.getNodeVersion()
  ]);

  console.log(`You are connected to chain ${chain} using ${nodeName} v${nodeVersion}`);
  
  // you can also only call one method
  cont chain = await mangata.getChain()
  console.log(`You are connected to chain ${chain}`)
}

main().catch(console.error).finally(() => process.exit());

Available Methods

TxOptions Type (Optional)

getApi

If you need to retrieve underlying API

const mangata = Mangata.getInstance('ws://127.0.0.1:9944')
const api = await mangata.getApi()
console.log("Connected: ", api.isConnected)

getChain

If you need to retrieve the chain name

const mangata = Mangata.getInstance('ws://127.0.0.1:9944')
const chain = await mangata.getChain()
console.log('Chain: ', chain)

getNonce

Retrieve the current nonce

createPool

Extrinsic to create pool

sellAsset

Extrinsic to sell/swap

buyAsset

Extrinsic to buy/swap

mintLiquidity

Extrinsic to add liquidity to pool

burnLiquidity

Extrinsic to remove liquidity from liquidity pool

calculateBuyPrice

Returns sell amount you need to pay in sold token id for bought token id in buy amount

calculateSellPrice

Returns bought asset amount returned by selling sold token id for bought token id in sell amount

calculateSellPriceId

Returns bought token amount returned by selling sold token id for bought token id in sell amount

calculateBuyPriceId

Returns sell amount you need to pay in sold token id for bought token id in buy amount

getAmountOfTokenIdInPool

Get amount of token id in pool

getLiquidityAssetId

Returns liquidity asset id

getLiquidityPool

Returns pool corresponding to specified liquidity asset ID in from of first and second token Id pair

getTreasury

Returns amount of token ID in Treasury

getTreasuryBurn

Returns amount of currtokenency ID in Treasury Burn

transferToken

Extrinsic that transfers Token Id in value amount from origin to destination

transferTokenAll

Extrinsic that transfers all token Id from origin to destination

getTotalIssuance

Returns total issuance of Token Id

getTokenBalance

Returns token balance for address

getTokenInfo

Returns token info

getBridgeTokens