minterjs-tx

A low level module for creating, manipulating and signing Minter transactions. Consider using minter-js-sdk to have full-featured solution.

It is complemented by the following packages:

minter-js-sdk complete JS solution to work with Minter
minterjs-wallet to create wallet
minterjs-util utility functions

Install

npm install minterjs-tx

Usage

Full example

example

import MinterTx from 'minterjs-tx';
import MinterTxSignature from 'minterjs-tx/src/tx-signature';
import MinterTxDataSend from 'minterjs-tx/src/tx-data/send';
import {TX_TYPE_SEND} from 'minterjs-tx/src/tx-types';
import {formatCoin} from 'minterjs-tx/src/helpers';

// make tx data
const txData = new MinterTxDataSend({
    to: '0x0000000000000000000000000000000000000000',
    coin: formatCoin('BIP'),
    value: `0x01`,
});

// make tx
const tx = new MinterTx({
    nonce: '0x01',
    chainId: '0x01',
    gasPrice: '0x01',
    gasCoin: formatCoin('BIP'), 
    type: TX_TYPE_SEND,
    data: txData.serialize(),
});

// sign tx
const privateKey = Buffer.from('5fa3a8b186f6cc2d748ee2d8c0eb7a905a7b73de0f2c34c5e7857c3b46f187da', 'hex');
tx.signatureData = (new MinterTxSignature()).sign(tx.hash(false), privateKey).serialize();

// get signed tx string
const serializedTx = tx.serialize().toString('hex');

// post tx to blockchain
fetch(`https://minter-node-1.testnet.minter.network/send_transaction?tx=0x${serializedTx}`)
    .then((response) => {
        console.log('Success!', response.json());
    });

Initialization

import MinterTx from 'minterjs-tx';

const tx = new MinterTx(txParams);

Tx params

All tx params can be passed as Buffer or Hex string

nonce - int, used for prevent transaction reply (count of txs for this private key + 1)
`chainId' - int, identify network type, 0x01 - mainnet, 0x02 - testnet
gasPrice - big int, used for managing transaction fees
gasCoin - symbol of a coin to pay fee
type - type of transaction (see below).
data - data of transaction (depends on transaction type, see below).
payload (arbitrary bytes) - arbitrary user-defined bytes, e.g. tx message
serviceData - reserved field.
ECDSA fields (r, s and v) - digital signature of transaction

Methods

`.sign(privateKey)`

Sign a transaction with a given private key. privateKey - 32 bytes Buffer.

tx.sign(privateKey);

`.verifySignature()`

Determines if the signature is valid. Returns boolean.

const isValid = tx.verifySignature();

`.validate(stringError)`

Validates the signature. stringError - whether to return a string with a description of why the validation failed. Return boolean or string with errors.

const isValid = tx.validate();
const validationErrors = tx.validate(true);

`.hash(includeSignature)`

Computes a sha3-256 hash of the serialized tx. includeSignature - whether or not to include the signature, default true. Returns Buffer.

// hash of tx with signature
const hash = tx.hash();
// hash of tx without signature
const hashWithoutSignature = tx.hash(false);

`.getSenderAddress()`

Returns the sender's address. Returns Buffer.

const address = tx.getSenderAddress();

`.getSenderPublicKey()`

Returns the sender's public key. Returns Buffer.

const publicKey = tx.getSenderPublicKey();

Tx types

TX_TYPE_SEND: '0x01' TX_TYPE_SELL: '0x02' TX_TYPE_SELL_ALL: '0x03' TX_TYPE_BUY: '0x04' TX_TYPE_CREATE_COIN: '0x05' TX_TYPE_DECLARE_CANDIDACY: '0x06' TX_TYPE_DELEGATE: '0x07' TX_TYPE_UNBOND: '0x08' TX_TYPE_REDEEM_CHECK: '0x09' TX_TYPE_SET_CANDIDATE_ON: '0x0A' TX_TYPE_SET_CANDIDATE_OFF: '0x0B' TX_TYPE_CREATE_MULTISIG: '0x0C' TX_TYPE_MULTISEND: '0x0D' TX_TYPE_EDIT_CANDIDATE: '0x0E'

Tx data

Send

import {toBuffer, convertToPip} from 'minterjs-util';
import MinterTxDataSend from 'minterjs-tx/src/tx-data/send';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataSend({
   coin: formatCoin('MNT'),
   to: toBuffer('Mx7633980c000139dd3bd24a3f54e06474fa941e16'),
   value: `0x${convertToPip(10, 'hex')}`,
});

Multisend

import {toBuffer, convertToPip} from 'minterjs-util';
import MinterTxDataMultisend from 'minterjs-tx/src/tx-data/send';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataMultisend({
    list: [
        {
           coin: formatCoin('MNT'),
           to: toBuffer('Mx7633980c000139dd3bd24a3f54e06474fa941e16'),
           value: `0x${convertToPip(10, 'hex')}`,
        },
        {
           coin: formatCoin('MNT'),
           to: toBuffer('Mxddab6281766ad86497741ff91b6b48fe85012e3c'),
           value: `0x${convertToPip(2, 'hex')}`,
        },
    ]
});

Sell

import {convertToPip} from 'minterjs-util';
import MinterTxDataSell from 'minterjs-tx/src/tx-data/sell';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataSell({
   coinToSell: formatCoin('MNT'),
   valueToSell: `0x${convertToPip(10, 'hex')}`,
   coinToBuy: formatCoin('BELTCOIN'),
});

Sell All

import {convertToPip} from 'minterjs-util';
import MinterTxDataSellAll from 'minterjs-tx/src/tx-data/sell-all';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataSellAll({
   coinToSell: formatCoin('MNT'),
   coinToBuy: formatCoin('BELTCOIN'),
});

Buy

import {convertToPip} from 'minterjs-util';
import MinterTxDataBuy from 'minterjs-tx/src/tx-data/buy';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataBuy({
     coinToBuy: formatCoin('MNT'),
     valueToBuy: `0x${convertToPip(10, 'hex')}`,
     coinToSell: formatCoin('BELTCOIN'),
 });

Create Coin

import {convertToPip} from 'minterjs-util';
import MinterTxDataCreateCoin from 'minterjs-tx/src/tx-data/create-coin';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataCreateCoin({
   name: 'My coin',
   symbol: formatCoin('MYCOIN'),
   initialAmount: `0x${convertToPip(10, 'hex')}`,
   initialReserve: `0x${convertToPip(50, 'hex')}`,
   constantReserveRatio: 100,
});

Declare Candidacy

import {toBuffer, convertToPip} from 'minterjs-util';
import MinterTxDataDeclareCandidacy from 'minterjs-tx/src/tx-data/declare-candidacy';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataDeclareCandidacy({
   address: toBuffer('Mx7633980c000139dd3bd24a3f54e06474fa941e16'),
   pubKey: toBuffer('Mpf9e036839a29f7fba2d5394bd489eda927ccb95acc99e506e688e4888082b3a3'),
   commission: 10,
   coin: formatCoin('MNT'),
   stake: `0x${convertToPip(1000, 'hex')}`,
});

Edit Candidacy

import {toBuffer} from 'minterjs-util';
import MinterTxDataEditCandidate from 'minterjs-tx/src/tx-data/declare-candidacy';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataEditCandidate({
   ownerAddress: toBuffer('Mx7633980c000139dd3bd24a3f54e06474fa941e16'),
   rewardAddress: toBuffer('Mx7633980c000139dd3bd24a3f54e06474fa941e16'),
   pubKey: toBuffer('Mpf9e036839a29f7fba2d5394bd489eda927ccb95acc99e506e688e4888082b3a3'),
});

Delegate

import {toBuffer, convertToPip} from 'minterjs-util';
import MinterTxDataDelegate from 'minterjs-tx/src/tx-data/delegate';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataDelegate({
   pubKey: toBuffer('Mpf9e036839a29f7fba2d5394bd489eda927ccb95acc99e506e688e4888082b3a3'),
   coin: formatCoin('MNT'),
   stake: `0x${convertToPip(1000, 'hex')}`,
});

Unbond

import {toBuffer, convertToPip} from 'minterjs-util';
import MinterTxDataUnbond from 'minterjs-tx/src/tx-data/unbond';
import {formatCoin} from 'minterjs-tx/src/helpers';

const txData = new MinterTxDataUnbond({
   pubKey: toBuffer('Mpf9e036839a29f7fba2d5394bd489eda927ccb95acc99e506e688e4888082b3a3'),
   coin: formatCoin('MNT'),
   stake: `0x${convertToPip(1000, 'hex')}`,
});

Redeem Check

import {toBuffer} from 'minterjs-util';
import {Buffer} from 'safe-buffer';
import MinterTxDataRedeemCheck from 'minterjs-tx/src/tx-data/redeem-check';

const txData = new MinterTxDataRedeemCheck({
   rawCheck: toBuffer('Mcf89f01830f423f8a4d4e5400000000000000888ac7230489e80000b841ada7ad273bef8a1d22f3e314fdfad1e19b90b1fe8dc7eeb30bd1d391e89af8642af029c138c2e379b95d6bc71b26c531ea155d9435e156a3d113a14c912dfebf001ca0781a7b7d781634bcf632579b99d583887ab093dfbd50b65de5c0e5813028a277a071272d8e1be721f5307f40f87daa4ab632781640f18fd424839396442cc7ff17'),
   proof: Buffer.from('7f8b6d3ed18d2fe131bbdc9f9bce3b96724ac354ce2cfb49b4ffc4bd71aabf580a8dfed407a34122e45d290941d855d744a62110fa1c11448078b13d3117bdfc01', 'hex'),
});

Set Candidate On

import {toBuffer} from 'minterjs-util';
import MinterTxDataSetCandidateOn from 'minterjs-tx/src/tx-data/set-candidate-on';

const txData = new MinterTxDataSetCandidateOn({
   pubKey: toBuffer('Mpf9e036839a29f7fba2d5394bd489eda927ccb95acc99e506e688e4888082b3a3'),
});

Set Candidate Off

import {toBuffer} from 'minterjs-util';
import MinterTxDataSetCandidateOff from 'minterjs-tx/src/tx-data/set-candidate-off';

const txData = new MinterTxDataSetCandidateOff({
   pubKey: toBuffer('Mpf9e036839a29f7fba2d5394bd489eda927ccb95acc99e506e688e4888082b3a3'),
});

Create Multisig

import {toBuffer} from 'minterjs-util';
import MinterTxDataCreateMultisig from 'minterjs-tx/src/tx-data/set-candidate-off';

const txData = new MinterTxDataCreateMultisig({
   addresses: [toBuffer('Mxee81347211c72524338f9680072af90744333146'), toBuffer('Mxee81347211c72524338f9680072af90744333145'), toBuffer('Mxee81347211c72524338f9680072af90744333144')],
   weights: [1, 3, 5],
   threshold: 7,
});

License

MIT License

highfeed/minterjs-tx