Skip to content

Latest commit

 

History

History
125 lines (105 loc) · 2.69 KB

blocks.md

File metadata and controls

125 lines (105 loc) · 2.69 KB
Raw

Blocks

Blocks manage API.

Get block

Get block by id.

var smartholdemApi = require("sthjs-wrapper")
smartholdemApi.getBlock("id: Id of block", (err, success, response) => {
  console.log(response);
});

Response

{
    "success": true,
    "block": {
        "id": "Id of block. (String)",
        "version": "Version of block. (Integer)",
        "timestamp": "Timestamp of block. (Integer)",
        "height": "Height of block. (Integer)",
        "previousBlock": "Previous block id. (String)",
        "numberOfTransactions": "Number of transactions. (Integer)",
        "totalAmount": "Total amount of block. (Integer)",
        "totalFee": "Total fee of block. (Integer)",
        "payloadLength": "Payload length of block. (Integer)",
        "payloadHash": "Payload hash. (Hex String)",
        "generatorPublicKey": "Generator public key. (Hex String)",
        "generatorId": "Generator id. (String)",
        "blockSignature": "Block signature. (Hex)"
    }
}

Get blocks

Get all blocks.

var smartholdemApi = require("sthjs-wrapper")
var parameters = {
  "totalFee: total fee of block. (Integer)",
  "totalAmount: total amount of block. (Integer)",
  "previousBlock: previous block of need block. (String)",
  "height: height of block. (Integer)",
  "generatorPublicKey: generator id of block in hex. (String)",
  "limit: limit of blocks to add to response. Default to 20. (Integer)",
  "offset: offset to load blocks. (Integer)",
  "orderBy: field name to order by. Format: fieldname:orderType. Example: height:desc, timestamp:asc (String)"
};

smartholdemApi.getBlocks(parameters, (error, success, response) => {
  console.log(response);
});

All parameters joins by OR.

Response

{
  "success": true,
  "blocks": [
    "array of blocks"
  ]
}

Get blockchain fee

Get transaction fee for sending "normal" transactions.

var smartholdemApi = require("sthjs-wrapper")

smartholdemApi.getBlockchainFee((error, success, response) => {
  console.log(response);
});

Response

{
  "success": true,
  "fee": "fee amount"
}

Get blockchain height

Get blockchain height.

var smartholdemApi = require("sthjs-wrapper")

smartholdemApi.getBlockchainHeight((error, success, response) => {
  console.log(response);
});

Response

{
  "success": true,
  "height": Height of blockchain. (Integer)
}

Get forged by account

Get amount forged by account.

var smartholdemApi = require("sthjs-wrapper")

smartholdemApi.getForgedByAccount("Delegate public key (String)",
                          (error, success, response) => {
    console.log(response);
});

Response

{
  "success": true,
  "sum": Forged amount (Integer)
}