API : Transaction

<<< Return API Reference

Navigation

• faucet
• getBalance
• getBalances
• makeUnsignedBOXTx
• fetchUtxos
• createRawTx

Premise

const api = new boxdjs.Api(fetch, <http://xxx>, 'http')

Methods

faucet

BOX Faucet

Parameters

* address <string>
* amount <number> (*100000000)

Returns

Void

Example

// faucet 1000 BOX to 'b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA'
await api.faucet({'b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA', 1000 * 100000000})

---

getBalance

Get BOX balance by address.

Parameters

* address <string>

Returns

balance <number>

Example

const { balance } = await api.getBalance('b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA')

---

getBalances

Get BOX balance-list by address-list.

Parameters

* address-list <string[]>

Returns

balance-list <number[]>

Example

const { balance } = await api.getBalance(['b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA', 'b1abnqbGs7ZnkShpFFusp8y1C3f1zQKwC9J'])

---

makeUnsignedBOXTx

Make unsigned BOX transaction.

Parameters

* OriginalTxReq <
  {
    from: <string>
    to: <string[]>
    amounts: <number[]> (*100000000)
  }
>

Returns

UnsignedTx <
  {
    tx: {
        data?;
        lock_time?: <string>;
        magic?: <number>;
        version?: <number>;
        vin: <Vin[]>;
        vout: <Vout[]>;
      };
    rawMsgs;
  }
>

Example

const unsigned_tx = await api.makeUnsignedBOXTx({
      from: 'b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA',
      to: 'b1abnqbGs7ZnkShpFFusp8y1C3f1zQKwC9J',
      amounts: [
          200000000,
          300000000
        ]
    })

---

fetchUtxos

Fetch utxos.

Parameters

* FetchUtxosReq <
  {
    addr: <string>
    amount: <number> (*100000000)
  }
>

Returns

interface: Utxo {
    out_point: {
        hash: <string>;
        index: <number>;
    };
    tx_out: {
        value: <string>;
        script_pub_key: <string>;
    };
    block_height: <number>;
    is_coinbase: <boolean>;
    is_spent: <boolean>;
}
Returns: utxo-list <Utxo[]>

Example

const utxo_res = await api.fetchUtxos({
   addr: 'b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA',
   amount: '18000000000'
})

---

createRawTx

Create raw transaction.

Parameters

* Raw <
  {
    addr: <string>
    to: {
    [to_addr: <string>]: number
  }
    privKey: <string>
  }
>
is_raw: <boolean>

Returns

signed-transaction <
  {
    data?;
    lock_time?: <string>;
    magic?: <number>;
    version?: <number>;
    vin: Vin[];
    vout: Vout[];
  }
>

Example

const created_tx = await api.createRawTx({
  addr: 'b1cRrJ9rhksTgaawpJ8B4sANUUMLGgCmsVA',
  to: {
    "b1anHQsat7FrrtANEY85iowbJf6RsNTkB3a": 10001,
    "b1knDdToJtecuFbeLEdoi286g3acoqhmrmG": 30003
  },
  privKey: '83d076d9dfc13980c9986c84e71f8224f01505f0f76310d0992f1509806068ef'
)

---