@timestope-official/staking v0.2.1

@timestope-official/staking

This package provides a collection of apis to create, sign/send staking transaction, and receive confirm/receipt.

Installation

npm install @timestope-official/staking

Usage

Create a Feechain instance connecting to testnet

const { Feechain } = require('@timestope-official/core');
const {
  ChainID,
  ChainType,
  hexToNumber,
  numberToHex,
  fromWei,
  Units,
  Unit,
} = require('@timestope-official/utils');

const fch = new Feechain(
    'https://api.s0.b.timestope.net/',
    {
        chainType: ChainType.Feechain,
        chainId: ChainID.FchTestnet,
    },
);

Below, examples show how to send delegate, undelegate, and collect rewards staking transactions. First, set the chainId, gasLimit, gasPrice for all subsequent staking transactions

fch.stakings.setTxParams({
  gasLimit: 25000,
  gasPrice: numberToHex(new fch.utils.Unit('1').asGwei().toWei()),
  chainId: 2
});

Note: create and edit validator transactions are not fully supported in the sdk

Create delegate staking transaction

const delegate = fch.stakings.delegate({
  delegatorAddress: 'fee103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7',
  validatorAddress: 'fee1vfqqagdzz352mtvdl69v0hw953hm993n6v26yl',
  amount: numberToHex(new Unit(1000).asFee().toWei())
});
const delegateStakingTx = delegate.build();

Sign and send the delegate transaction and receive confirmation

// key corresponds to fee103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7, only has testnet balance
fch.wallet.addByPrivateKey('45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e');

fch.wallet.signStaking(delegateStakingTx).then(signedTxn => {
  signedTxn.sendTransaction().then(([tx, hash]) => {
    console.log(hash);
    signedTxn.confirm(hash).then(response => {
      console.log(response.receipt);
    });
  });
});

Similarily, undelegate and collect reward transactions can be composed, signed and sent Create undelegate staking transaction

const undelegate = fch.stakings.undelegate({
  delegatorAddress: 'fee103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7',
  validatorAddress: 'fee1vfqqagdzz352mtvdl69v0hw953hm993n6v26yl',
  amount: numberToHex(new Unit(1000).asFee().toWei())
});
const undelegateStakingTx = undelegate.build();

Create collect rewards staking transaction

const collectRewards = fch.stakings.collectRewards({
  delegatorAddress: 'fee103q7qe5t2505lypvltkqtddaef5tzfxwsse4z7'
});
const collectRewardsStakingTx = collectRewards.build();

Also, similar to normal transaction, signing and sending can be performed asynchronously.