nubian-coven-sdk v1.0.19

Nubian Coven SDK

The official Nubain Coven Software Development Kit (SDK) for JavaScript, available for browsers and Node.js backends.

Installation

To get started, install the nubian coven SDK package from npm:

npm install nubian-coven-sdk

Usage

To enable web3 calls via SDK, instantiate web3 library

// in browser
if (window.ethereum) {
  window.web3 = new Web3(window.ethereum)
} else if (window.web3) {
  window.web3 = new Web3(window.web3.currentProvider)
} else {
  window.web3 = new Web3(customProvider)
}

// in nodejs
const Web3 = require('web3')
const NUB = require('nubian-coven-sdk')
const web3 = new Web3(new Web3.providers.HttpProvider(BSC_RPC_URL))

Now instantiate NUB with web3 instance.

// in browser
const nub = new NUB(web3)

// in nodejs
const nub = new NUB({
  web3: web3,
  mode: 'node',
  privateKey: PRIVATE_KEY,
})

The Nubian SDK provides methods to swap and save tokens.

Swap

nub.pancakeswap.swap({ 
  amountA, 
  amountB, 
  tokenA, 
  tokenB,
  path
  [, slippage 
    [, receiver 
      [, ...transactionConfig ]]]
}) => Promise<TransactionReceipt>

This function swaps a token for another. It is a promise that resolves to a transaction receipt if it is successful. It throws an error if it is unsuccessful.

Swap Path/Token Price

When swapping using Pancakeswap each token has a price and a swap path. The swap path refers to the tokens the token you want to swap will be exchanged with before being converted to the destination token. This function returns the most efficient path for the swap and the amount of tokens you get or need to supply.

nub.pancakeswap.getRoute(
  tokenIn, 
  tokenOut, 
  amount,
  direction, 
  fresh
) => Promise<[string, string[]]>

This function returns a promise that resolves to an object. | Object Property | Type |Description | | ----------- | ---------|------------------------------------------------------- | | amount | string |The amount of tokens you get from swap or amount of tokens needed for swap. Depends on the value of direction. Decimal points are applied. | | path | string[] | An array of the path/route for possible token swap |

Save

nub.venus.deposit({
  amount,
  address
  [, receiver
    [, ...transactionConfig ]]
}) => Promise<TransactionReceipt>

This function saves token deposits in Venus protocol. When you save, Venus gives you vTokens. These are tokens that serve as proof of deposit. To get back your tokens saved, you must provide these vTokens. Venus has a set of tokens it allows you to save.

Withdraw Savings

nub.venus.withdraw({
  vTokenAddress
  [, vTokenAmount 
    [, tokenAmount
      [, receiver
        [, ...transactionConfig ]]]]
}) => Promise<TransactionReceipt>

This function allows you to withdraw tokens saved in Venus protocol. You will need to have the corresponding vToken of the token you want to withdraw.

Note: You must provide one of vTokenAmount and tokenAmount.

Util Methods

Token Transfer

You can transfer tokens using the erc20 transfer function. It receives an object as input. It returns a promise that resolves to a transaction object

nub.erc20.transfer({
  token, amount, to [, ...transactionConfig]
}) => Promise<TransactionReceipt>

Estimate Token Transfer Gas

This helps you get the estimated gas needed to do a token transfer based on current network activity. It takes the same parameters as token transfer.

nub.erc20.estimateTransferGas({
  token, amount, to [, ...transactionConfig]
}) => Promise<TransactionReceipt>

It returns a promise that resolves to the gas object.

BNB Transfer

For BNB transfers, use the eth transfer function. It also receives an object as input. It returns a promise that resolves to a transaction object.

nub.eth.transfer({amount, to [, ...transactionConfig]}) => Promise<TransactionReceipt>;

Estimate BNB Transfer Gas

Estimates the fee details needed to make a token transfer.

nub.eth.estimateTransferGas({amount, to [, ...transactionConfig]})

It returns a promise that resolves to the gas object.

Wrap BNB

BNB can be wrapped to WBNB using the SDK.

nub.wbnb.wrap({amount [, ...transactionConfig]}) => Promise<TransactionReceipt>

The function takes in the amount of BNB you want to wrap. It returns a promise that resolves to a transaction receipt.

Estimate Wrap Gas

nub.wbnb.estimateWrapGas({amount [, ...transactionConfig]}) => Promise<GasObject>

The function takes in the amount of BNB you want to use in estimation. It returns a promise that resolves to the gas object.

Unwrap BNB

WBNB can be unwrapped to BNB.

nub.wbnb.unwrap({amount [, ...transactionConfig]}) => Promise<TransactionReceipt>

The function takes in the amount of WBNB you want to unwrap. You must have this amount of WBNB already approved. It returns a promise that resolves to a transaction receipt.

Estimate Unwrap Gas

nub.wbnb.unwrap({amount [, ...transactionConfig]}) => Promise<GasObject>

The function takes in the amount of WBNB you want to unwrap.

Approval

You can approve addresses to spend the ERC20 token. It also receives an object as input and returns a promise that resolves to a transaction object.

nub.erc20.approve({
  token
  [, amount
    [, to
      [, ...transactionConfig]]]
}) => Promise<TransactionReceipt>

Estimate Approval Gas

This helps you get the estimated gas needed to do an approval based on current network activity. It takes the same parameters as approvals.

nub.erc20.estimateApproveGas({
  token
  [, amount
    [, to
      [, ...transactionConfig]]]
}) => Promise<GasObject>

It returns a promise that resolves to the gas object.

Pancakeswap LpToken Price

You can get the price of a Pancakeswap Liquidity provider token (lptoken) in US dollars using this function. It returns a promise that resolves to a number and takes the address of the lp token as an input.

nub.pancakeswap.getLpPrice(tokenAddress) => Promise<number>

Common Terms

Transaction Config

Transaction Receipt

The transaction receipt describes various properties of the blockchain transaction. It is properly described in the web3js documentation.

Gas Object

This object contains all the fee/gas information needed for a transaction.

maxUint256

This is the the maximum figure that can be held in the uint256 type of solidity. It can be represented in Javascript using 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff.

vTokens

vTokens are ERC20 tokens that Venus mints to an address when it makes a successful deposit into the Venus protocol. These tokens are returned when a withdrawal is made. The amount an address has saved can be deduced from the amount of vTokens in its balance. These tokens are transferrable. Here is a list of tokens supported by Venus and their corresponding vToken addresses: