the-crypto-gate v1.0.9

TheCryptoGate.com Blockchain API (BTC, ...)

https://www.npmjs.com/package/the-crypto-gate

• Legend:

  • Methods:

    • getAddressBalance
    • getAddressUnspent
    • pushRawTransaction
    • getTransactionByHash
    • getBlockByID
    • estimateSmartFee

  • HowTo:

    • Create && Broadcast transaction
    • Create new random Crypto KeyPair

Install:

npm i the-crypto-gate --save

Require && set-up apiKey:

const theCryptoGate = require('the-crypto-gate');

const TCG = new theCryptoGate({
  apiKey: '<my-key>',
});

Info: TheCryptoGate library is API-Ready

// express
app.get('/my-custom/api/address/get-balance/:address', async(req, res)=>{

  // ...

  const balanceRes = await TCG.getAddressBalance( address ));

  res.header('Content-Type', 'application/json');
  res.json( balanceRes );

  // ...

});

{
  "code": 200,
  "msg": "OK",
  "data": {
    "balance": 0.00137764,
    "confirmed": 0.00137764,
    "unconfirmed": 0
  }
}

Method: getAddressBalance

Success

const balanceRes = await TCG.getAddressBalance( '15FZLWefShJjwAuDcGgMAhUXXHMgXPyjGb' ));

{
  "code": 200,
  "msg": "OK",
  "data": {
    "balance": 0.00137764,
    "confirmed": 0.00137764,
    "unconfirmed": 0
  }
}

Error or Warning

const balanceRes = await TCG.getAddressBalance( 'WRONG-ADDRESS' ));

{
  "code": <int>, // !200
  "msg": "Description ...",
  "data": {}
}

Method: getAddressUnspent

Get all unspent transactions (UTXO) from Address

WARNING:
  Only for advanced users. You can lose all your Crypto

Success

const res = await TCG.getAddressUnspent( '15FZLWefShJjwAuDcGgMAhUXXHMgXPyjGb' ));

{
  "code": 200,
  "msg": "OK",
  "data": [
    {
      "tx_hash": "c81bdf7a1caeffa7340613da5d01929b24a7de66b499874f1f23a072bebd3935",
      "tx_pos": 1,
      "height": 575219,
      "value": 137764, // amount ins Sat.
      "balance": 0.00137764
    }
  ]
}

Error or Warning

const res = await TCG.getAddressUnspent( 'WRONG-ADDRESS' ));

{
  "code": <int>, // !200
  "msg": "Description ...",
  "data": {}
}

Method: pushRawTransaction

Broadcast your created Transaction into the Blockchain

Success

const res = await TCG.pushRawTransaction( '02000000016d97be4cf0fafccb85b37b ....' ));

{
  "code": 200,
  "msg": "OK",
  "data": {
    // Pushed transaction hash
    "hash": "c81bdf7a1caeffa7340613da5d01929b24a7de66b499874f1f23a072bebd3935",
  }
}

Error or Warning

const res = await TCG.pushRawTransaction( 'EXISTING TRANSACTION-HASH' ));

{
  "code": <code>, // !200
  "msg": "Transaction already in block chain",
  "data": {}
}

Method: getTransactionByHash

Fetch transaction from Blockchain by hash,

Success

const res = await TCG.getTransactionByHash( 'c81bdf7a1caeffa7340613da5d01929b24a7de66b499874f1f23a072bebd3935' ));

{
  "code": 200,
  "msg": "OK",
  "data": {
    "transaction": {
      "txid": "c81bdf7a1caeffa7340613da5d01929b24a7de66b499874f1f23a072bebd3935",
      "hash": "c81bdf7a1caeffa7340613da5d01929b24a7de66b499874f1f23a072bebd3935",
      "version": 2,
      "size": 226,
      "vsize": 226,
      "weight": 904,
      "locktime": 0,
      "vin": [
        ...
      ],
      ...
    }
  }
}

Error or Warning

const res = await TCG.getTransactionByHash( 'WRONG-TRANSACTION-HASH' ));

{
  "code": 400,
  "msg": "Not valid Transaction Hash",
  "data": {}
}

{
  "code": 500,
  "msg": "No such mempool or blockchain transaction. Use gettransaction for wallet transactions",
  "data": {}
}

Method: getBlockByID

Success

const res = await TCG.getBlockByID( 575217 );

{
  "code": 200,
  "msg": "OK",
  "data": {
    ...
  }
}

Error or Warning

{
  "code": <int>, // !200
  "msg": "Description ...",
  "data": {}
}

Method: estimateSmartFee

Get the best transaction fee for the moment.
Within next blocks: Min 2, Max Inf.

The lower <withInNextBlocks>, the heigher <tx-fee> will be

Success

const res = await TCG.estimateSmartFee( <With in next blocks> );

{
  "code": 200,
  "msg": "OK",
  "data": {
    "perKiloByte": 0.00081461,
    "perByte": 7.95518e-7,
    "avgTxBytes": 195,
    "avgTxCoastBtc": 0.00015513,
    "withInNextBlocks": 2
  }
}

Error or Warning

{
  "code": <int>, // !200
  "msg": "Description ...",
  "data": {}
}

Method: getKeyPair

Create new (random) CryptoPair => Public && Private key

WARNING: 
  You must store it in your own database or you will lose all your Crypto 

Success

const KeyPair = await TCG.getKeyPair();

{
  "code": 200,
  "msg": "OK",
  "data": {
    "symbol": "BTC",
    "sec_key": "L1xx81HHJhNFJdmU5soiL1SbYzmZ6Anu8GdtiUE7GDifzViy6rwj",
    "pub_key": "1MD1LWPp3uj53ithDs9ygMi2tFkB3vt27V",
    "encrypted": false
  }
}

Error or Warning

{
  "code": <int>, // !200
  "msg": "Description ...",
  "data": {}
}

Info: Create && Broadcast Transaction

options (optional):

• allowDust: Allow send vary small amount (dust)

• feeType: Try send within next blocks. Can be any of ( 2,3,4,5,6 ). Default: 3

• tryToFitTxFee: if amount plus Tx-Fee is less than total balance, it will try reduce dest. amount to fit transaction cost in transaction itself. NOTE: Works only if dest object contains 1 dest. address

Send to many ...

const sendOutToMany = [
  {address: '1GPwAmZFSZ3vFy1mfJqpDcNqrmXZjMxYV', amount: 0.034},
  {address: '1mfJqpDcNqrmXZjMxYV1GPwAmZFSZ3vFy', amount: 0.012},
  {address: '1mZFSZ3vFyfJqpDcNqrmXZjMxYVm1GPwA', amount: 0.787},
];

Send to one ...

const sendOutToOne = [
  {address: '1GPwAmZFSZ3vFy1mfJqpDcNqrmXZjMxYV', amount: (+aliceBalanceRes.data.balance) },
];

const aliceBalanceRes = await TCG.getAddressBalance( Keys.alice.pub_key );

// Optianal: options
const options = {
  allowDust: false,
  feeType: 3,
  tryToFitTxFee: true,
};

const sendOutToOne = [
  {address: '1GPwAmZFSZ3vFy1mfJqpDcNqrmXZjMxYV', amount: (+aliceBalanceRes.data.balance) },
];

const TxRes = await TCG.createRawTransaction( Keys.alice.sec_key, sendOutToOne, options );

{
  code: 200, 
  msg: 'Transaction is ready to be broadcasted',
  data: {
    raw_tx: 'abcd234569cdef......',
  }
}

if( TxRes.code !== 200 ){
  console.error( TxRes.msg );
  return;
}

Broadcast transaction into Blockchain

const pushRawTxRes = await TCG.pushRawTransaction( TxRes.data.raw_tx );

if( pushRawTxRes.code !== 200 ){
  console.error( TxRes.msg );
  return;
}

// Success
console.log( TxRes.data.hash );