@eosdt/eosdt-js v1.3.6

EOSDT JS

A JavaScript library to execute EOSDT contracts methods.

Usage

Install the module using NPM:

$ npm install @eosdt/eosdt-js

Use service module Connector to initiate one of functional modules. Connector uses EOS node address and an array of private keys. Transactions would be signed with given keys and sent to blockchain through given node.

const { EosdtConnector } = require("@eosdt/eosdt-js")

const nodeAddress = "http://node-address.example.com:80"

const connector = new EosdtConnector(nodeAddress, ["private-key-1", "private-key-2"])

const eosPositions = connector.getPositions()
const eosLiquidator = connector.getLiquidator()

const pbtcPositions = connector.getBasicPositions("PBTC")
const pbtcLiquidator = connector.getLiquidator("PBTC")

const pethPositions = connector.getBasicPositions("PETH")
const pethLiquidator = connector.getLiquidator("PETH")

const governance = connector.getGovernance()
const balances = connector.getBalances()
const savings = connector.getSavingsRate()

Fore more code examples, checkout examples folder.

Modules documentation

ITrxParamsArgument

Classes

ArmContract

Kind: global class

• ArmContract
  • .armEos(accountName, amount, arm, [transactionParams]) ⇒ Promise
  • .armExistingEosPosition(owner, positionId, arm, [transactionParams]) ⇒ Promise
  • .dearmEosPosition(owner, positionId, debtTarget, [transactionParams]) ⇒ Promise
  • .getSettings() ⇒ Promise.<object>

armContract.armEos(accountName, amount, arm, transactionParams) ⇒ Promise

Kind: instance method of ArmContract
Returns: Promise - Promise of transaction receipt

armContract.armExistingEosPosition(owner, positionId, arm, transactionParams) ⇒ Promise

Kind: instance method of ArmContract
Returns: Promise - Promise of transaction receipt

armContract.dearmEosPosition(owner, positionId, debtTarget, transactionParams) ⇒ Promise

Kind: instance method of ArmContract
Returns: Promise - Promise of transaction receipt

armContract.getSettings() ⇒ Promise.<object>

Kind: instance method of ArmContract
Returns: Promise.<object> - Positions contract settings

BalanceGetter

Kind: global class

• BalanceGetter
  • new BalanceGetter(connector)
  • .getEos(account) ⇒ Promise.<number>
  • .getEosdt(account) ⇒ Promise.<number>
  • .getNut(account) ⇒ Promise.<number>
  • .getPbtc(account) ⇒ Promise.<number>
  • .getPeth(account) ⇒ Promise.<number>

new BalanceGetter(connector)

balanceGetter.getEos(account) ⇒ Promise.<number>

Kind: instance method of BalanceGetter
Returns: Promise.<number> - EOS balance of account

balanceGetter.getEosdt(account) ⇒ Promise.<number>

Kind: instance method of BalanceGetter
Returns: Promise.<number> - EOSDT balance of account

balanceGetter.getNut(account) ⇒ Promise.<number>

Kind: instance method of BalanceGetter
Returns: Promise.<number> - NUT balance of account

balanceGetter.getPbtc(account) ⇒ Promise.<number>

Kind: instance method of BalanceGetter
Returns: Promise.<number> - PBTC balance of account

balanceGetter.getPeth(account) ⇒ Promise.<number>

Kind: instance method of BalanceGetter
Returns: Promise.<number> - PETH balance of account

BasicPositionsContract

Kind: global class

• BasicPositionsContract
  • new BasicPositionsContract(connector, tokenSymbol)
  • .newPosition(accountName, collatAmount, eosdtAmount, [transactionParams]) ⇒ Promise
  • .newEmptyPosition(maker, [transactionParams])
  • .give(giverAccount, receiver, positionId, [transactionParams]) ⇒ Promise
  • .addCollateral(senderName, amount, positionId, [transactionParams]) ⇒ Promise
  • .deleteCollateral(senderName, amount, positionId, [transactionParams]) ⇒ Promise
  • .generateDebt(senderName, amount, positionId, [transactionParams]) ⇒ Promise
  • .burnbackDebt(senderName, amount, positionId, [transactionParams]) ⇒ Promise
  • .addCollatAndDebt(senderName, addedCollatAmount, generatedDebtAmount, positionId, [transactionParams]) ⇒ Promise
  • .pbtcDelCollatAndRedeem(senderName, amount, positionId, btcAddress, [transactionParams]) ⇒ Promise
  • .marginCall(senderName, positionId, [transactionParams]) ⇒ Promise
  • .del(creator, positionId, [transactionParams]) ⇒ Promise
  • .paybackAndDelete(maker, debtAmount, positionId, [transactionParams]) ⇒ Promise
  • .close(senderAccount, positionId, [transactionParams]) ⇒ Promise
  • .getContractTokenBalance() ⇒ Promise.<number>
  • .getRates() ⇒ Promise.<Array.<object>>
  • .getRatesNew() ⇒ Promise.<Array.<object>>
  • .getLtvRatiosTable() ⇒ Promise.<Array.<object>>
  • .getPositionLtvRatio(id) ⇒ Promise.<(object|undefined)>
  • .getPositionById(id) ⇒ Promise.<(object|undefined)>
  • .getPositionByMaker(maker) ⇒ Promise.<(object|undefined)>
  • .getAllUserPositions(maker) ⇒ Promise.<Array.<object>>
  • .getAllPositions() ⇒ Promise.<Array.<object>>
  • .getLatestUserPosition(accountName) ⇒ Promise.<(object|undefined)>
  • .getParameters() ⇒ Promise.<object>
  • .getSettings() ⇒ Promise.<object>

new BasicPositionsContract(connector, tokenSymbol)

basicPositionsContract.newPosition(accountName, collatAmount, eosdtAmount, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.newEmptyPosition(maker, transactionParams)

Kind: instance method of BasicPositionsContract

basicPositionsContract.give(giverAccount, receiver, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.addCollateral(senderName, amount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.deleteCollateral(senderName, amount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.generateDebt(senderName, amount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.burnbackDebt(senderName, amount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.addCollatAndDebt(senderName, addedCollatAmount, generatedDebtAmount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.pbtcDelCollatAndRedeem(senderName, amount, positionId, btcAddress, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.marginCall(senderName, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.del(creator, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.paybackAndDelete(maker, debtAmount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.close(senderAccount, positionId, transactionParams) ⇒ Promise

Kind: instance method of BasicPositionsContract
Returns: Promise - Promise of transaction receipt

basicPositionsContract.getContractTokenBalance() ⇒ Promise.<number>

Kind: instance method of BasicPositionsContract
Returns: Promise.<number> - Contract's collateral asset balance.

basicPositionsContract.getRates() ⇒ Promise.<Array.<object>>

Kind: instance method of BasicPositionsContract
Returns: Promise.<Array.<object>> - Table of current system token prices (contract 'pricefeed.eq' - table 'oraclerates'). These are valid rates, except fields 'backend_price' and 'backend_update' are missing

basicPositionsContract.getRatesNew() ⇒ Promise.<Array.<object>>

Kind: instance method of BasicPositionsContract
Returns: Promise.<Array.<object>> - Table of current system token prices (contract 'pricefeed.eq' - table 'newrates'). These are valid rates including all rates data

basicPositionsContract.getLtvRatiosTable() ⇒ Promise.<Array.<object>>

Kind: instance method of BasicPositionsContract
Returns: Promise.<Array.<object>> - Table of current LTV ratios for all positions.

basicPositionsContract.getPositionLtvRatio(id) ⇒ Promise.<(object|undefined)>

Kind: instance method of BasicPositionsContract
Returns: Promise.<(object|undefined)> - Current LTV ratio for position by id

basicPositionsContract.getPositionById(id) ⇒ Promise.<(object|undefined)>

Kind: instance method of BasicPositionsContract
Returns: Promise.<(object|undefined)> - A position object

basicPositionsContract.getPositionByMaker(maker) ⇒ Promise.<(object|undefined)>

Kind: instance method of BasicPositionsContract
Returns: Promise.<(object|undefined)> - Position object - first position that belongs to maker account

basicPositionsContract.getAllUserPositions(maker) ⇒ Promise.<Array.<object>>

Kind: instance method of BasicPositionsContract
Returns: Promise.<Array.<object>> - Array of all positions objects, created by the maker

basicPositionsContract.getAllPositions() ⇒ Promise.<Array.<object>>

Kind: instance method of BasicPositionsContract
Returns: Promise.<Array.<object>> - An array of all positions created on this contract

basicPositionsContract.getLatestUserPosition(accountName) ⇒ Promise.<(object|undefined)>

Kind: instance method of BasicPositionsContract
Returns: Promise.<(object|undefined)> - Position object - position of the account with maximum id value

basicPositionsContract.getParameters() ⇒ Promise.<object>

Kind: instance method of BasicPositionsContract
Returns: Promise.<object> - Positions contract parameters

basicPositionsContract.getSettings() ⇒ Promise.<object>

Kind: instance method of BasicPositionsContract
Returns: Promise.<object> - Positions contract settings

BpManager

Kind: global class

• BpManager
  • new BpManager(connector)
  • .getAllBpPositions() ⇒ Promise.<Array.<object>>
  • .getBpPosition() ⇒ Promise.<(object|undefined)>
  • .registerBlockProducer(bpName, depositedAmount, [transactionParams]) ⇒ Promise
  • .changeBlockProducerReward(bpName, rewardAmount, [transactionParams]) ⇒ Promise
  • .unregisterBlockProducer(bpName, [transactionParams]) ⇒ Promise
  • .depositEos(fromAccount, bpName, eosAmount, [transactionParams]) ⇒ Promise

new BpManager(connector)

bpManager.getAllBpPositions() ⇒ Promise.<Array.<object>>

Kind: instance method of BpManager
Returns: Promise.<Array.<object>> - An array of objects, that contain information about registered block producers

bpManager.getBpPosition() ⇒ Promise.<(object|undefined)>

Kind: instance method of BpManager
Returns: Promise.<(object|undefined)> - Object with information about a registered block producer

bpManager.registerBlockProducer(bpName, depositedAmount, transactionParams) ⇒ Promise

Kind: instance method of BpManager
Returns: Promise - Promise of transaction receipt

bpManager.changeBlockProducerReward(bpName, rewardAmount, transactionParams) ⇒ Promise

Kind: instance method of BpManager
Returns: Promise - Promise of transaction receipt

bpManager.unregisterBlockProducer(bpName, transactionParams) ⇒ Promise

Kind: instance method of BpManager
Returns: Promise - Promise of transaction receipt

bpManager.depositEos(fromAccount, bpName, eosAmount, transactionParams) ⇒ Promise

Kind: instance method of BpManager
Returns: Promise - Promise of transaction receipt

EosdtConnector

Kind: global class

• EosdtConnector
  • new EosdtConnector(nodeAddress, privateKeys)
  • .getBasicPositions(collateralToken) ⇒
  • .getPositions()
  • .getLiquidator([collateralToken]) ⇒
  • .getSavingsRateCont() ⇒
  • .getArmContract() ⇒
  • .getTokenSwapContract() ⇒
  • .getGovernance() ⇒
  • .getBalances() ⇒

new EosdtConnector(nodeAddress, privateKeys)

eosdtConnector.getBasicPositions(collateralToken) ⇒

Kind: instance method of EosdtConnector
Returns: Instance of BasicPositionsContract

eosdtConnector.getPositions()

Kind: instance method of EosdtConnector

eosdtConnector.getLiquidator(collateralToken) ⇒

Kind: instance method of EosdtConnector
Returns: Instance of LiquidatorContract

eosdtConnector.getSavingsRateCont() ⇒

Kind: instance method of EosdtConnector
Returns: Instance of SavingsRateContract

eosdtConnector.getArmContract() ⇒

Kind: instance method of EosdtConnector
Returns: Instance of ArmContract

eosdtConnector.getTokenSwapContract() ⇒

Kind: instance method of EosdtConnector
Returns: Instance of TokenSwapContract

eosdtConnector.getGovernance() ⇒

Kind: instance method of EosdtConnector
Returns: Instance of GovernanceContract

eosdtConnector.getBalances() ⇒

Kind: instance method of EosdtConnector
Returns: Instance of BalanceGetter

GovernanceContract

Kind: global class

• GovernanceContract
  • new GovernanceContract(connector)
  • .propose(proposal, senderName, [transactionParams]) ⇒ Promise
  • .expire(proposalName, senderName, [transactionParams]) ⇒ Promise
  • .applyChanges(proposalName, senderName, [transactionParams]) ⇒ Promise
  • .cleanProposal(proposalName, deletedVotes, senderName, [transactionParams]) ⇒ Promise
  • .stake(senderName, nutsAmount, [trxMemo], [transactionParams]) ⇒ Promise
  • .unstake(nutAmount, voterName, [transactionParams]) ⇒ Promise
  • .vote(proposalName, vote, voterName, voteJson, [transactionParams]) ⇒ Promise
  • .unvote(proposalName, voterName, [transactionParams]) ⇒ Promise
  • .voteForBlockProducers(voterName, producers, [transactionParams]) ⇒ Promise
  • .stakeAndVoteForBlockProducers(voterName, nutAmount, producers, [transactionParams]) ⇒ Promise
  • .getVoterInfo() ⇒ Promise.<(object|undefined)>
  • .getVoterInfosTable() ⇒ Promise.<Array.<object>>
  • .getVotes() ⇒ Promise.<Array.<object>>
  • .getVotesForAccount() ⇒ Promise.<Array.<object>>
  • .getProposals() ⇒ Promise.<Array.<object>>
  • .getBpVotes() ⇒ Promise.<Array.<object>>
  • .getProxyInfo() ⇒ Promise.<(object|undefined)>
  • .getSettings() ⇒ Promise.<object>
  • .getParameters() ⇒ Promise.<object>

new GovernanceContract(connector)

governanceContract.propose(proposal, senderName, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.expire(proposalName, senderName, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.applyChanges(proposalName, senderName, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.cleanProposal(proposalName, deletedVotes, senderName, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.stake(senderName, nutsAmount, trxMemo, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.unstake(nutAmount, voterName, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.vote(proposalName, vote, voterName, voteJson, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.unvote(proposalName, voterName, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.voteForBlockProducers(voterName, producers, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.stakeAndVoteForBlockProducers(voterName, nutAmount, producers, transactionParams) ⇒ Promise

Kind: instance method of GovernanceContract
Returns: Promise - Promise of transaction receipt

governanceContract.getVoterInfo() ⇒ Promise.<(object|undefined)>

Kind: instance method of GovernanceContract
Returns: Promise.<(object|undefined)> - Amount of NUTs staked by account in Governance contract and their unstake date

governanceContract.getVoterInfosTable() ⇒ Promise.<Array.<object>>

Kind: instance method of GovernanceContract
Returns: Promise.<Array.<object>> - Table of information on accounts that staked NUT

governanceContract.getVotes() ⇒ Promise.<Array.<object>>

Kind: instance method of GovernanceContract
Returns: Promise.<Array.<object>> - An array with all Governance contract votes (up to 10000)

governanceContract.getVotesForAccount() ⇒ Promise.<Array.<object>>

Kind: instance method of GovernanceContract
Returns: Promise.<Array.<object>> - All account votes

governanceContract.getProposals() ⇒ Promise.<Array.<object>>

Kind: instance method of GovernanceContract
Returns: Promise.<Array.<object>> - An array with all Governance contract proposals (up to 10000)

governanceContract.getBpVotes() ⇒ Promise.<Array.<object>>

Kind: instance method of GovernanceContract
Returns: Promise.<Array.<object>> - Array of objects, containing block producers names and amount of NUT votes for them

governanceContract.getProxyInfo() ⇒ Promise.<(object|undefined)>

Kind: instance method of GovernanceContract
Returns: Promise.<(object|undefined)> - Voter info for eosdtbpproxy

governanceContract.getSettings() ⇒ Promise.<object>

Kind: instance method of GovernanceContract
Returns: Promise.<object> - Governance contract settings
<a name="GovernanceContract+getParameters"