GXClient

GXClient is a wrapped toolkit of gxbjs, a client to interact with gxchain apis.

You can get more info on docs.

Install

`` bash
npm install gxclient --save
`

For react-native, the following extra command should be executed before using gxclient:

` bash
npm i --save react-native-randombytes
npm i --save-dev rn-nodeify@latest
./node_modules/.bin/rn-nodeify --hack --install
`

Usage(CLI)

` bash
$ npm install gxclient -g
$ gxclient -h
`

`bash
Usage: gxclient [cmd]

Options:
-V, --version output the version number
-v --version print gxclient version
-h, --help output usage information

Commands:
list|ls List all apis
generate_key Generate gxchain key pairs
private_to_public Export public key from private key
is_valid_private Check if private key is valid
is_valid_public Check if public key is valid
register [options] Register gxchain account
get_account [options] Get account information by account_name
get_account_by_public_key [options] Get account information by account_name
get_object [options] Get object by object_id
get_account_balances|get_account_balance [options] Get account balances by account_name
get_asset [options] Get asset info by asset symbol
get_block [options] Get block by block height
transfer [options] [boradcast] Send a transfer transaction
vote [options] [overwrite] [fee_asset_id] [boradcast] Vote for TrustNodes
call_contract [options] [amount_asset] [boradcast] Call smart contract method
get_contract_tables [options] Get contract table by contract_name
get_contract_abi [options] Get contract abi by contract_name
get_table_objects [options] [start] [limit] Get table records by contract_name and table_name
broadcast [options] broadcast transaction
get_chain_id [options] get_chain_id
`

Usage(Client)

`js
import GXClientFactory from "gxclient";

const private_key = "5Ka9YjFQtfUUX2Ddnqka...";
const account_name = "gxcaccount";
const asset_precicion = 5;

let client = GXClientFactory.instance({keyProvider:private_key, account:account_name,network:"wss://testnet.gxchain.org"});

// set broadcast to false so we could calculate the fee before broadcasting
let broadcast = true;

//Sending 15GXS to gxb456 with memo "GXChain NB"
client.transfer("gxb456", "GXChain NB", "15 GXC", broadcast).then(resp => {
let transaction = broadcast ? resp[0].trx : resp;
let txid = broadcast ? resp[0].id : "";
console.log(JSON.stringify(transaction));
console.log("txid:", txid, "fee:", transaction.operations[0].fee.amount / Math.pow(10, asset_precicion));
// > txid: f28d27ac74649a76f58c9b84fb7ea700163e31c4 fee: 0.0118
// Since gxchain implemented dpos consensus, the transaction will be confirmed until the block becomes irreversible
// You can find the logic when a transfer operation was confirmed in the example of detectTransaction
}).catch(ex => {
console.error(ex);
});

``

APIs

API documents

Other

- It's very welcome for developers to translate this project into different programing languages
- We are looking forward to your pull requests