Skip to content

Latest commit

 

History

History
1586 lines (1198 loc) · 49.8 KB

JS-SDK.md

File metadata and controls

1586 lines (1198 loc) · 49.8 KB
Raw

安装

yarn add chainx.js

或者

npm install chainx.js

快速开始

示例

const Chainx = require('chainx.js').default;

(async () => {
  // 目前只支持 websocket 链接
  const chainx = new Chainx('wss://w1.chainx.org/ws');

  // 等待异步的初始化
  await chainx.isRpcReady();

  // 查询某个账户的资产情况
  const bobAssets = await chainx.asset.getAssetsByAccount('5DtoAAhWgWSthkcj7JfDcF2fGKEWg91QmgMx37D6tFBAc6Qg', 0, 10);

  console.log('bobAssets: ', JSON.stringify(bobAssets));

  // 构造交易参数（同步）

  const extrinsic = chainx.asset.transfer('5DtoAAhWgWSthkcj7JfDcF2fGKEWg91QmgMx37D6tFBAc6Qg', 'PCX', '1000', '转账 PCX');

  // 查看 method 哈希
  console.log('Function: ', extrinsic.method.toHex());

  // 签名并发送交易，0x0000000000000000000000000000000000000000000000000000000000000000 是用于签名的私钥
  extrinsic.signAndSend('0x0000000000000000000000000000000000000000000000000000000000000000', (error, response) => {
    if (error) {
      console.log(error);
    } else if (response.status === 'Finalized') {
      if (response.result === 'ExtrinsicSuccess') {
        console.log('交易成功');
      }
    }
  });
})();

离线签名 http 版本

const { ApiBase, HttpProvider } = require('chainx.js');
const nacl = require('tweetnacl');

// 签名过程
async function ed25519Sign(message) {
  // 签名账户的 32 位私钥
  const privateKey = Buffer.from('5858582020202020202020202020202020202020202020202020202020202020', 'hex');
  // 使用 ed25519 算法进行签名。
  return nacl.sign.detached(message, nacl.sign.keyPair.fromSeed(privateKey).secretKey);
}

(async () => {
  const chainx = new ApiBase(new HttpProvider('https://w1.chainx.org/rpc'));

  await chainx._isReady;

  // 签名账户的公钥
  const address = '5CjVPmj6Bm3TVUwfY5ph3PE2daxPHp1G3YZQnrXc8GDjstwT';

  // 投票提息
  const extrinsic = chainx.tx.xStaking.claim(address);

  // 获取该账户交易次数
  const nonce = await chainx.query.system.accountNonce(address);

  // 获取待签原文
  // 可传入参数： extrinsic.encodeMessage(address, { nonce, acceleration = 1, blockHash = genesisHash, era = '0x00' })
  const encoded = extrinsic.encodeMessage(address, { nonce, acceleration: 10 });

  // 获取手续费，
  const fee = await extrinsic.getFee(address, { acceleration: 1 });

  console.log('fee', fee)

  // 离线签名
  const signature = await ed25519Sign(encoded);

  // 注入签名
  extrinsic.appendSignature(signature);

  // 发送交易
  const txHash = await extrinsic.send();

  console.log(txHash);
})();

离线签名 websocket 版本

const Chainx = require('chainx.js').default;
const nacl = require('tweetnacl');

// 签名过程
async function ed25519Sign(message) {
  // 签名账户的 32 位私钥
  const privateKey = Buffer.from('5858582020202020202020202020202020202020202020202020202020202020', 'hex');
  // 使用 ed25519 算法进行签名。tweetnacl 这个签名用的是 64 位secretKey，实际上等于 privateKey + publicKey。通过这个方法nacl.sign.keyPair.fromSeed，可以从 privateKey 获取到 secretKey。
  return nacl.sign.detached(message, nacl.sign.keyPair.fromSeed(privateKey).secretKey);
}

(async () => {
  // 目前只支持 websocket 链接
  const chainx = new Chainx('wss://w1.chainx.org/ws');

  // 等待异步的初始化
  await chainx.isRpcReady();

  // 签名账户的公钥
  const address = '5CjVPmj6Bm3TVUwfY5ph3PE2daxPHp1G3YZQnrXc8GDjstwT';

  // 投票提息
  const extrinsic = chainx.stake.voteClaim(address);

  // 获取该账户交易次数
  const nonce = await extrinsic.getNonce(address);

  // 获取待签原文
  // 可传入参数： extrinsic.encodeMessage(address, { nonce, acceleration = 1, blockHash = genesisHash, era = '0x00' })
  const encoded = extrinsic.encodeMessage(address, { nonce, acceleration: 10 });

  // 离线签名
  const signature = await ed25519Sign(encoded);

  // 注入签名
  extrinsic.appendSignature(signature);

  // 发送到链上的数据
  // console.log(extrinsic.toHex())

  // 发送交易
  extrinsic.send((error, result) => {
    console.log(error, result);
  });
})();

资产对接示例

/**
一般来说如果只是为了拿到PCX转账的金额，地址，来确认入账，大概的逻辑是这样
  1.监听块高，得到下一个最新块高
  2.得到块中的交易列表
  3.解析每笔交易，如果是XAsset的transfer交易，解析这笔交易的Event是否最后一个event是Sucess？如果是，则代表这是一笔成功的转账交易。
    a.解析这笔交易的参数得到发送人，收款人地址dest，收款金额，资产类型，备注
    b.如果收款人的dest是关注的地址，则确认入账（处理业务）
**/

const { ApiBase, HttpProvider, WsProvider } = require('chainx.js');

(async () => {
  // 使用 http 连接
  const api = new ApiBase(new HttpProvider('https://w1.chainx.org.cn/rpc'));
  // 使用 websocket 连接
  // const api = new ApiBase(new WsProvider('wss://w1.chainx.org.cn/ws'))

  await api.isReady;

  const transferCallIndex = Buffer.from(api.tx.xAssets.transfer.callIndex).toString('hex');

  async function getTransfers(blockNumber) {
    const blockHash = await api.rpc.chain.getBlockHash(blockNumber);
    const block = await api.rpc.chain.getBlock(blockHash);
    const estrinsics = block.block.extrinsics;
    const transfers = [];

    for (let i = 0; i < estrinsics.length; i++) {
      const e = estrinsics[i];
      if (Buffer.from(e.method.callIndex).toString('hex') === transferCallIndex) {
        const allEvents = await api.query.system.events.at(blockHash);
        events = allEvents
          .filter(({ phase }) => phase.type === 'ApplyExtrinsic' && phase.value.eqn(i))
          .map(event => {
            const o = event.toJSON();
            o.method = event.event.data.method;
            return o;
          });
        result = events[events.length - 1].method;

        transfers.push({
          index: i,
          blockHash: blockHash.toHex(),
          blockNumber: blockNumber,
          result,
          tx: {
            signature: e.signature.toJSON(),
            method: e.method.toJSON(),
          },
          events: events,
          txHash: e.hash.toHex(),
        });
      }
    }

    return transfers;
  }

  const transfers = await getTransfers(237509);

  console.log(JSON.stringify(transfers));
})();

Chainx.js

目前只接受 websocket 的方式，调用 rpc。使用前需要等待程序初始化完成：

const chainx = new Chainx('wss://w1.chainx.org.cn/ws');

chainx.isRpcReady().then(() => {
  // ...
});

// 监听事件
chainx.on('disconnected', () => {}) // websocket 链接断开
chainx.on('error', () => {}) // 发生一个错误
chainx.on('connected', () => {}) // websocket 已连接
chainx.on('ready', () => {}) // 初始化完成

// 操作 websocket 对象，断开 websocket 连接
chainx.provider.websocket.close()

初始化过程会自动会从链上获取网络版本。这将会影响到显示的账号地址的格式。请注意，这是异步的，未初始化完成前，默认是测试网络。 也可以通过 chainx.account.setNet('mainnet') 或 chainx.account.setNet('testnet')，手动指定网络版本。

类型定义

几乎所有 api 函数的参数都对应一个类型定义。此时只要传入参数能被解析，即是合法的。例如：accountId 有很多种表现形式：

  • bs58 格式 "5Ey5ZRPVfGee7DVview3h3FkwMU6WTw2NZjYxD7o3NED7bZe"
  • hex 格式 "0x806a491666670aa087e04770c025d64b2ecebfd91a74efdc4f4329642de32365"
  • Buffer 对象 <Buffer 80 6a 49 16 66 67 0a a0 87 e0 47 70 c0 25 d6 4b 2e ce bf d9 1a 74 ef dc 4f 43 29 64 2d e3 23 65>
  • Uint8Array 对象 Uint8Array [ 128, 106, 73, 22, 102, 103, 10, 160, 135, 224, 71, 112, 192, 37, 214, 75, 46, 206, 191, 217, 26, 116, 239, 220, 79, 67, 41, 100, 45, 227, 35, 101]

以上均是合法的参数。

大部分类型都存在两个基本的方法：toJSON()，toHex()，toJSON() 用于将数据转化为用于 javascript 中的基础类型。而 toHex() 则一般是用于获取该数据编码后的二进制的十六进制的表示。在 chainx.js 中存在几种基本的类型，其余的类型基本上都是从它们中派生出来的。

  • UInt： 在 chainx.js 内部，几乎所有的无符号数字都是继承于 UInt 类型，它是基于 Bn.js 实现的。常见的如 Balance，U32，U64 都是它的子类。

  • Text：文本类型，继承于原生的 String ，toHex 的时候按 utf8 格式编码。

  • Enum：枚举类型，如：

    export default class TxType extends Enum {
  constructor(index) {
    super(['Withdraw', 'Deposit'], index);
  }
}

    此时说明枚举值有 'Withdraw', 'Deposit'。同时new TxType('Withdraw') 和 new TxType(0) 得到的同样的值。

  • Vector：表现为一个数组的形式。如 Vector.with(U32) 则表示，由 U32 组成的数组。通过 toJSON()方法，可以得到一个数组。

  • Struct：表现为一个 Object 的形式。如：

  • export class EventMetadata extends Struct {
  constructor(value) {
    super(
      {
        name: Text,
        arguments: Vector.with(Type),
        documentation: Vector.with(Text),
      },
      value
    );
  }
}

    eventMetadata.toJSON() 将得到

    {
  name: 'text',
  arguments: [type, type, ...],
  documentation: ['text', 'text', ...],
}

    这样形式的 object

  • Compact ：该类型通常与其它类型复合组成一个新的类型，此时内部数据编码是被压缩过的。如 Compact.with(Nonce)，将会压缩 Nonce的编码。

智能合约

交易

chainx.api.tx.xContracts.putCode(gasLimit, code)

将给定的二进制 Wasm 代码存储到链上，同时可以获取它的 codeHash。只能通过已存储的代码实例化合约。

const { compactAddLength } = require('@chainx/util');
const code = compactAddLength(fs.readFileSync(path.resolve(__dirname, './erc20.wasm')));

const extrinsic = chainx.api.tx.xContracts.putCode(100000000, code);

let codeHash;

ex.signAndSend(Test, (error, result) => {
  console.log(error, result);
  if (result && result.result === 'ExtrinsicSuccess') {
    // 获取 codeHash
    codeHash = result.events.find(e => e.method === 'CodeStored').event.data;
  }
});

chainx.api.tx.xContracts.instantiate(endowment, gasLimit, codeHash， data)

从 putCode 生成的' codehash '实例化一个新合约，同时也可以转移一些余额"。

// 合约 abi
const erc20 = require('./erc20');
// 解析 abi
const Abi = require('@chainx/api-contract');

const abi = new Abi(erc20);
// 5GE7vwvDmKCCPrVLc9XZJAiAspM9LhQWbQjPvZ3QxzBUbhT7
const extrinsic = chainx.api.tx.xContracts.instantiate(
  1000,
  100000000,
  '0x5e71dc66c1527bf4047942c5ada9c5c59941bff8eb8b2d1a6d849306bfd52e93',
  abi.constructors[0](...), // 合约的构造函数
);

let contractAddress

ex.signAndSend(Test, (error, result) => {
  if (result && result.result === 'ExtrinsicSuccess') {
    // 获取 contractAddress
    contractAddress = result.events.find(e => e.method === 'Instantiated').event.data[1];
  }
});

chainx.api.tx.xContracts.call(dest, value, gasLimit, data)

调用合约，同时也可以传输一些余额。

const abi = new Abi(erc20);

const ex = chainx.api.tx.xContracts.call(
  '5GE7vwvDmKCCPrVLc9XZJAiAspM9LhQWbQjPvZ3QxzBUbhT7', // contract address
  0, // value
  10000000, // gas
  // 调用的函数
  abi.messages.transfer('5FvHGYk44FHZXznrhoskVyr2zGPYn5CpUXphRKM8eGRJZMtX', 10)
);

ex.signAndSend(Alice, (error, result) => {
  console.log(error, result);
});

chainx.api.tx.xContracts.convertToXrc20(token, value, gasLimit)

转化成 XRC20

const ex = chainx.api.tx.xContracts.convertToXrc20(
  'BTC', // token
  1000, // value
  500000 // gas
);

ex.signAndSend(Alice, (error, result) => {
  console.log(error, result);
});

chainx.chain.convertToAsset(token, balance, value, gas)

将 xrc 资产转为余额

chainx.chain.convertToAsset('BTC', 100000, 0, 500000).then(extrinsic => {
  extrinsic.signAndSend(Alice, (error, result) => {
    console.log(error, result);
  });
});

RPC

chainx.api.rpc.chainx.contractcall({ "dest": 5SS..., "gasLimit": 500000, "inputData": 0x..., "origin": 5HH... })

参见 https://github.com/chainx-org/ChainX/wiki/RPC#chainx_contractcall

chainx.api.rpc.chainx.contractXRCTokenInfo()

参见 https://github.com/chainx-org/ChainX/wiki/RPC#chainx_contractxrctokeninfo

chainx.api.rpc.chainx.contractXRC20Call({ "token": "BTC", "selector": "BalanceOf", "inputData": 0x...})

参见 https://github.com/chainx-org/ChainX/wiki/RPC#chainx_contractxrc20call

Account 模块

通过chainx.account.from(seed | privateKey | mnemonic) 可以生成一个 account 对象。

const alice = chainx.account.from('0x....')
alice.address() // bs58 地址
alice.publicKey() // 公钥 0x...
alice.privateKey() // 私钥 0x...

此外，我们约定，凡是十六进制的字符串，均以 0x 开头，如私钥，公钥等。

账户操作

const { Account } = require('chainx.js');

const account1 = Account.generate();

const publicKey1 = account1.publicKey(); // 公钥
console.log('publicKey1: ', publicKey1);

const privateKey1 = account1.privateKey(); // 私钥
console.log('privateKey1: ', privateKey1);

const address1 = account1.address(); // 地址
console.log('address1: ', address1);

const mnemonic = Account.newMnemonic(); // 随机助记词
console.log('mnemonic: ', mnemonic);

const account2 = Account.from(mnemonic); // 从助记词生成账户

const address2 = Account.encodeAddress(account2.publicKey()); // 从公钥生成地址
console.log('address2: ', address2);

const publicKey2 = Account.decodeAddress(address2); // 从地址获取生成公钥
console.log('publicKey2: ', publicKey2);

Account.setNet('testnet'); // 设置为测试网
const address3 = Account.encodeAddress(publicKey2); // 测试网地址
console.log('address3:', address3);

Account.setNet('mainnet'); // 设置为主网
const address4 = Account.encodeAddress(publicKey2); // 主网地址
console.log('address4:', address4);

const account3 = Account.from(privateKey1); // 从私钥生成账户
console.log('address:', account3.address()); // 地址

交易函数

我们需要有几个步骤，来完成一次完整的交易。首先确定我们需要调用的 Method，如下列所示。以下 api 均返回一个 SubmittableExtrinsic 对象，它继承于 Extrinsic 。注意所有涉及到金额的部分，均是以最小的精度为单位。不存在小数。

SubmittableExtrinsic 存在几个比较重要的方法：

  • encodeMessage(address, { nonce, acceleration = 1, blockHash = genesisHash, era = '0x00' }): 获取编码后的代签原文。其中 address，是用于签名的账户的地址，nonce 指该地址的当前交易数，acceleration 指加速倍率。

  • sign(account, { nonce, acceleration, blockHash })：使用 account 签名该交易，其中 nonce 指该账户当前交易数。acceleration 指加速倍率，倍率越高手续费被扣的越多，同时交易也越快。blockHash 默认为当前链的初始哈希。

  • signAndSend(account, options?, callback?)：使用 account 签名并发送该笔交易。acount 可以是账户的私钥，也可以是 account 对象。options 是可选的，和 sign 方法的参数一样，其中 nonce 默认自动从链上获取，acceleration 默认为 1。callback 是回调函数，第一个参数是 error，第二个参数是 result。对于一个正常的交易，callback 将会被调用若干次：

  • e.signAndSend('0x....', { acceleration: 10 }, (error, result) => {
  /**
  将输出三次
 	{
    "result": null,
    "index": null,
    "events": null,
    // 交易 hash
    "txHash": "0x4e93b7cae2868273a8a891684581564cf4431a81e90d2e6c7ee377b26648ac1d",
    "blockHash": null,
    "broadcast": null,
    // 交易状态
    "status": "Ready"
	}
	{
    "result": null,
    "index": null,
    "events": null,
    "txHash": "0x4e93b7cae2868273a8a891684581564cf4431a81e90d2e6c7ee377b26648ac1d",
    "blockHash": null,
    // 广播
    "broadcast": [
      "QmYqN9CKmx3qrNoaqXzDf7PiqvDssc1ALRYBLS65J6Z5wB",
      "QmZGSfxrgWP4Kv9VWmnnYKAs8WNAq1ooQ7kXaAxuS78LZp",
      "QmfNwbvXLbHsxPCmByimLxv1J7ZJpAjSfm82mSEnbobRkY",
      "QmUNmpe6UoSpE3LhkL9knqTogbPDn7Lsg1EQErPDkUJzgL",
      "QmSAwXWpAg45Zsp5X7U6hrAU5dFVacXifowjHbnC2VruRv",
      "QmXxCbLmSMTfFGWep7TNnvUfHSYwGiJ8AyMVPDwyWVAbWn",
      "QmVV2AJ3ju8iwBoE3zzf3tuadjAWyJEaR7338TcXjjcFfL",
      "Qmdfxi8As1jUxx9SrQJYCDgQYPKhiXtgYVvX8vr2RsgYD1",
      "QmPSVr8NRaZdUeNf3eAJfHgmV8WNtePgAWCAX5cU3H4qtn",
      "QmaQSTwbvcxRjs83qAQLW4zfpZ4BnkBHzPhxUE9e85zuUw",
      "QmP39VaaWPBYQ57JoZPYgz8yQg8khMX1LLuN4zwv7xZZEh"
    ],
    // 广播中
    "status": "Broadcast"
  }
	{
	// ExtrinsicSuccess 是交易成功。ExtrinsicFail 是交易失败
  "result": "ExtrinsicSuccess",
  "index": 2,
  // 关联的 events 列表
  "events": [{ "phase": 2, "event": [{...}] }, { "phase": 2, "event": [{...}] }, { "phase": 2, "event": [{...}] }],
  "txHash": "0x4e93b7cae2868273a8a891684581564cf4431a81e90d2e6c7ee377b26648ac1d",
  // 上链的块哈希
  "blockHash": "0x56482c31dff1a35db9fbac22be02ae294545a6440dda53f49e240e6df5f2460d",
  "broadcast": null,
  // 交易完成
  "status": "Finalised"
}

  **/
  console.log(result);
})

chainx.trustee.createWithdrawTx(withdrawalIdList, tx)

提交构造的提现交易原文，原文tx支持两种情况：

  1. 没有任何签名的待签原文，后续可以继续调用signWithdrawTx进行自己的签名
  2. **对应于这个发送者（一定是信托）**签署过的待签，也就是将signWithdrawTx的过程合并在了这里，提现交易的提起者可以同时对这笔提现交易签名，调用createWithdrawTx发送ChainX，之后就不需要再调用signWithdrawTx进行签名

参数:

  • withdrawalIdList：提现ID列表
  • tx：构造的待签原文（可以是没有签名的原文与有一个签名的原文，多个签名的不允许）

示例:

chainx.trustee.createWithdrawTx([1, 2], '0x......');

chainx.trustee.signWithdrawTx(tx?)

提交签名后的交易原文

参数:

  • tx：签名后的交易原文

示例:

chainx.trustee.signWithdrawTx('0x......');

chainx.trustee.setupBitcoinTrustee(about, hotEntity, coldEntity)

设置比特币信托地址

参数:

  • tx：签名后的交易原文
  • hotEntity：热地址
  • coldEntity：冷地址

示例:

chainx.trustee.setupBitcoinTrustee('111'， '0x......', '0x......');

chainx.asset.transfer(dest, token, value, memo)

转账

参数:

  • dest：接收人的地址
  • token：转账的币种
  • value：转账金额（最小的精度，只能为整数）
  • memo：备注

示例:

chainx.asset.transfer('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 'PCX', 1000, '转给你');

chainx.asset.withdraw(token, value, addr, ext)

提现

参数:

  • token：提现的资产类型
  • value：提现的数量
  • addr：接收的地址
  • ext：备注

示例:

chainx.asset.withdraw('BTC', 100, '5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', '提现');

chainx.trade.putOrder(pair_index, order_type, order_direction, amount, price)

用户挂单

参数:

  • pairid：交易对ID
  • ordertype：类型（限价单|市价单)
  • direction：方向（买单|卖单)
  • amount：数量
  • price：价格

示例:

chainx.trade.putOrder(1, 'Limit', 'Buy', 100, 100);

chainx.trade.cancelOrder(pair_index, order_index)

取消挂单

参数:

  • pairid：交易对ID
  • index：用户委托编号

示例:

chainx.trade.cancelOrder(0, 2);

chainx.stake.register(name)

注册节点。

参数:

  • name：注册节点的名称

示例:

chainx.stake.register('节点');

chainx.stake.nominate(targetAddress, value, memo)

对节点投票。

参数:

  • targetAddress：被投票的节点的地址
  • value: 投票金额
  • memo: 备注

示例:

chainx.stake.nominate('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 1000, '投票');

chainx.stake.unnominate(targetAddress, value, memo)

撤销对节点的投票。

参数:

  • targetAddress ：撤票节点
  • value ：撤票金额
  • memo：备注

示例:

chainx.stake.refresh('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 1000, '撤销投票');

chainx.stake.refresh(url?, desire_to_run?, next_key?, about?)

更新节点网址，参选状态，出块地址和关于。所有参数均是可选项，不传需要填写 null 作为占位。

参数:

  • url: 节点网址
  • desireToRun: 是否参选
  • nextKey: 出块地址
  • about: 关于

示例:

chainx.stake.refresh(null, true, null, '我是节点');

chainx.stake.voteClaim(target)

选举投票提息。

参数:

  • target: 投票节点

示例:

chainx.stake.voteClaim('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ');

chainx.stake.depositClaim(token)

充值挖矿提息。

参数:

  • token: 充值币种

示例:

chainx.stake.depositClaim('BTC');

chainx.stake.unfreeze(target, revocation_index)

撤销投票后，撤销金额有一定的时候锁定期。锁定期满后，可以对锁定金额进行解冻，使其变为可用余额。

参数:

  • target: 解冻节点

  • revocationIndex: 解冻索引。 用户对同一解冻节点可能同时有多次解冻操作，该索引指明解冻编号

示例:

chainx.stake.unfreeze('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 1);

chainx.stake.setupTrustee(chain, about, hot_entity, cold_entity)

设置信托节点信息。

参数:

  • chain: 链 ID

  • about: 关于

  • hotEntity: 链的热地址

  • coldEntity: 链的冷地址

示例:

chainx.stake.setupTrustee('ChainX', 'about', ['Bitcoin', '0x......'], ['Bitcoin', '0x......']);

获取数据

ChainX对于数据的获取基本是是对RPC接口调用的封装

无特别说明，则RPC调用获取数据的返回的均是 Promise。大部分接口均可以传递一个块 hash 作为最后一个参数。即是查询该块下的数据。例子：

// 查询某个块hash的账户资产信息
chainx.asset.getAssetsByAccount(
  '5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa', 
  0, 
  100, 
  '0x376945b9a09b9b0698b334f557ba7d892974625d2ff0a192270a236e7a6ba297'
)

chainx.chain.getInfo()

获取链的基本信息

参数:

无

示例:

chainx.chain.getInfo()
/**
{ name: 'ChainX V0.9.7', version: '0.9.7', era: 'ChainX' }
**/

chainx.chain.getBlockPeriod()

获取出块的间隔

参数:

无

示例:

chainx.chain.getBlockPeriod()
/**
2 // 2 秒一个块
**/

chainx.chain.subscribeNewHead()

订阅最新的块，返回一个 rxjs 标准的 observable

参数:

无

示例:

const subscription = chainx.chain.subscribeNewHead().subscribe(result => {
  console.log('当前块高：', result.number)
  subscription.unsubscribe() // 取消订阅
})
/**
{
  "number": 381887, // 当前块高
  "hash": "0x513fbb976d775d7cda6d1b4b659160a5fd8ae9aed0c3f296123a067948837cd7", // 当前块哈希
  "now": 1554363156 // 当前出块时间
}
**/

chainx.trustee.getTrusteeSessionInfo(chain)

分局链返回当前的信托相关信息

参数:

  • chain: Chain, 链ID

示例:

chainx.trustee.getTrusteeSessionInfo("BTC")
/**
{
	// 冷信托地址信息
	"coldEntity": {
        "addr": "3Ne676pvdydEp425KdHDAEsff5dososuKL",
        "redeemScript": "0x522102132a8a42447c734deca086bd3087c73e0e3b323310b0490eb370532793d1f95f2102ba70207d7c47c22bd46acf91340bc725ddb8e33c65880ca2d1dba585491492542102fabd0895598ee8c11a6d4f4610a8b872fe5cefa2d62e82fef12825ec7901e32c53ae"
    },
    "counts": { # 签名达成条件
        "required": 2,
        "total": 3
    },
    // 热信托地址信息
    "hotEntity": {
        "addr": "3FK7PJiukCS57aPhMdtc6soqKTrQogX2Zz",
        "redeemScript": "0x52210265d615b6bb17e1d93a7836060ea58ed07aa31da5da25ee75ff3ed6c90c787509210342878f854c8c13e160d6aadb611aff7caea2e24d8c661bfce14920d9d27ede892102a3ee44550a9c13575e99f96fc56db20e2f7f686276c82a5737bacca07163571f53ae"
    },
	"sessionNumber": 0, // 当前信托届数，每换届一次就会增加1
	"trusteeList": [
		// 当前这条链的信托节点账户列表
    	{
        	"accountId": "0xf75d1c241c59e2a6a88efcf239df0eabb229b3697b4c844c788c9c51fcb25d2d",
        	"props": {
        	    "about": "bitocin",
        	    "coldEntity": "0x02132a8a42447c734deca086bd3087c73e0e3b323310b0490eb370532793d1f95f",
        	    "hotEntity": "0x0265d615b6bb17e1d93a7836060ea58ed07aa31da5da25ee75ff3ed6c90c787509"
        	}
        },
        {
            "accountId": "0x5f423525f65a2b6eb5866a9159dee5edebb00c85e43147bf02ef1921590c4df1",
            "props": {
                "about": "bitocin",
                "coldEntity": "0x02ba70207d7c47c22bd46acf91340bc725ddb8e33c65880ca2d1dba58549149254",
                "hotEntity": "0x0342878f854c8c13e160d6aadb611aff7caea2e24d8c661bfce14920d9d27ede89"
            }
        },
        {
            "accountId": "0x98c51995fdc63afbe50b010c71b5cabe14e270d1665e82f958c39bdd5bfb8f9a",
            "props": {
                "about": "bitocin",
                "coldEntity": "0x02fabd0895598ee8c11a6d4f4610a8b872fe5cefa2d62e82fef12825ec7901e32c",
                "hotEntity": "0x02a3ee44550a9c13575e99f96fc56db20e2f7f686276c82a5737bacca07163571f"
            }
        }
	]
}
**/

chainx.trustee.getTrusteeInfoByAccount(who)

获取该用户的信托信息（已注册信托后会显示）

参数:

  • who: AccountId 账户

示例:

chainx.trustee.getTrusteeInfoByAccount('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ')
/**
{
    "Bitcoin": {
        "about": "bitocin", // 注册信息
        "coldEntity": "0x02132a8a42447c734deca086bd3087c73e0e3b323310b0490eb370532793d1f95f", // 注册的冷公钥
        "hotEntity": "0x0265d615b6bb17e1d93a7836060ea58ed07aa31da5da25ee75ff3ed6c90c787509" // 注册的热公钥
    },
    // ...
}
**/

chainx.trustee.getWithdrawTx(chain)

获取对应链的提现交易，已经与这个交易相关的ChainX申请提现的用户提现记录id列表（用于信托获取对应链上正在处理中的多签提现交易，如对于BTC而言，该接口返回信托需要进行签署的比特币提现待签原文以及相关信息）

参数:

  • chain: Chain, 链ID

示例:

chainx.trustee.getWithdrawTx('Bitcoin')
/**
{
  "signStatus": false, //签名状态： false 未签名完成， true 签名完成
  "tx": "0100000001283fe241ec9528a48e6ce79b1ede9aabb59dbe38edeee013a28744c31d3db7860000000000ffffffff0288130000000000001976a914a5155d5636db0a9b8314460812f5105d84a5ae3d88acf0d200000000000017a9145737c1979343920ceea40e7c7d68b264b0effa3e8700000000", //比特币提现的交易原文
  // 这笔交易对应的ChainX用户提现记录的id列表，与`getWithdrawalList`的返回值结合后可以获取用户提现申请的详细记录，用于签署者去验证是否与原文相对应
  "withdrawalIdList": [
  	1,2,3 ... 
  ],
  // 当前已做出的行动信托列表（包含签名确认或者否决），未做出行动的不在列表内，信托详细信息可以从`getTrusteeSessionInfo`获取
  “trusteeList”: [ 
  	["0x..........", true], // 已签名
  	["0x..........", false], // 已否决
  	["0x..........", true], // 已签名
  ]
}
**/

chainx.asset.getAssetsByAccount(who, page_index, page_size)

用户资产信息

参数:

  • who: AccountId 账户
  • page_index: u32 页码 (从0开始)
  • page_size: u32 页大小 (<=100)

示例:

chainx.asset.getAssetsByAccount('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 0, 10)
/**
{
  "data": [
    // 资产列表， 内容同上
    {
      "details": {
        // key 是资产类型的枚举
        "Free": 1000000000,
        "ReservedDexFuture": 0,
        "ReservedDexSpot": 0,
        "ReservedStaking": 0,
        "ReservedStakingRevocation": 0,
        "ReservedWithdrawal": 0
      },
      "name": "PCX"
    },
    {
      "details": {
        "Free": 1000000000,
        "ReservedDexFuture": 0,
        "ReservedDexSpot": 0,
        "ReservedStaking": 0,
        "ReservedStakingRevocation": 0,
        "ReservedWithdrawal": 0
      },
      "name": "BTC"
    }
  ],
  "pageIndex": 0, //当前页码
  "pageSize": 10, //页大小
  "pageTotal": 1 //总共页数
}
**/

chainx.asset.getAssets(page_index, page_size)

总资产信息

参数:

  • page_index：u32 页码 (从0开始)
  • page_size：u32 页大小 (<=100)

示例:

chainx.asset.getAssets(0, 10)
/**
{
  "data": [
    // 资产列表
    {
      "chain": "ChainX",
      "desc": "PCX onchain token",
      "details": {
        // key 是 资产类别的 枚举
        "Free": 2000000000, // 总活动资产数目
        "ReservedCurrency": 0, 
        "ReservedDexFuture": 0, // 总期货交易锁定资产数目
        "ReservedDexSpot": 0, // 总交易锁定资产数目
        "ReservedStaking": 0, // 总投票锁定资产数目
        "ReservedStakingRevocation": 0, // 总投票赎回锁定资产数目
        "ReservedWithdrawal": 0 // 总提现锁定数目
      },
      "name": "PCX", // token id, token 标示
      "online": true,
      "precision": 3,
      "trusteeAddr": ""
    },
    {
      "chain": "Bitcoin",
      "desc": "BTC chainx",
      "details": {
        "Free": 2000000000,
        "ReservedDexFuture": 0,
        "ReservedDexSpot": 0,
        "ReservedStaking": 0,
        "ReservedStakingRevocation": 0,
        "ReservedWithdrawal": 0
      },
      "name": "BTC",
      "online": true,
      "precision": 8,
      "trusteeAddr": "2MtAUgQmdobnz2mu8zRXGSTwUv9csWcNwLU" //接收跨链转账的信托地址
    }
  ],
  "pageIndex": 0, //当前页码
  "pageSize": 10, //页大小
  "pageTotal": 1 //总共页数
}

**/

chainx.asset.getWithdrawalList(chain, page_index, page_size)

当前所有提现中记录

参数:

  • chain: String 链ID 枚举[“ChainX”, “Bitcoin”, “Ethereum”, “Polkadot”]
  • page_index: u32 页码 (从0开始)
  • page_size: u32 页大小 (<=100)

示例:

chainx.asset.getWithdrawalList('Bitcoin', 0, 10)
/**
{
  "data": [
    {
      "address": "mjKE11gjVN4JaC9U8qL6ZB5vuEBgmwik7b", // 提现地址
      "accountid": "0xd172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f", // 提现申请人
      "balance": 10, // 提现金额
      "memo": "", // 提现备注 或其他
      "id": 0, // 提现序列号
      "status": {
      		"value": "Applying", // 提现进入对应链上的提现状态， "Applying" 申请中, "Signing" 签名中, "Broadcasting" 广播中, Confirming 确认中
      		"confirm": 1,  // 只有当`value`为`Confirming`的时候才会有这个值，表示这个交易已有几个确认
      		"total_Confirm": 4, // 只有当`value`为`Confirming`的时候才会有这个值，表示这个交易总共需要几个确认
      }
      "height": 1000 // 申请提现的块高
      "token": "BTC", // 提现资产名
      "txid": "" //对应链的交易id，如Bitcoin就是btc交易的hash
    },
    {
      "address": "mjKE11gjVN4JaC9U8qL6ZB5vuEBgmwik7b",
      "accountid": "0xd172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f",
      "balance": 10,
      "memo": "",
      "id": 1,
      "status": {"value": "Applying"},
      "time": 1547536652,
      "token": "BTC",
      "txid": ""
    }
  ],
  "pageIndex": 0, // 同上
  "pageSize": 100,
  "pageTotal": 1
}
**/

chainx.asset.getWithdrawalListByAccount(who, page_index, page_size)

当前用户的提现中记录

参数:

  • who: AccountId 账户
  • page_index: u32 页码 (从0开始)
  • page_size: u32 页大小 (<=100)

示例:

chainx.asset.getWithdrawalListByAccount('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 0, 10)
/**
与 chainx.asset.getWithdrawalList 返回值相同
**/

chainx.asset.getDepositList(chain, page_index, page_size)

充值中列表

参数:

  • chain: String 链ID 枚举[“ChainX”, “Bitcoin”, “Ethereum”, “Polkadot”]
  • page_index: u32 页码 (从0开始)
  • page_size: u32 页大小 (<=100)

示例:

chainx.asset.getDepositList('Bitcoin', 0, 10)
/**
{
  "data": [
    {
      "accountid": "", //chainx账户
      "address": "mfioc8QgfcTVwuVd787JrdHMVjHACFWGX7", //btc地址
      "balance": 1000, //充值金额
      "confirm": 1, //确认数
      "memo": "", //备注
      "time": 1547003949, //时间戳
      "token": "BTC", //币种
      "totalConfirm": 3, //总确认数
      "txid": "20bf6f637c0f05dbf2936cb0dbdd365ef1292e166aa7ed8af8d6c8418850d58e" //btc交易id
    },
    {
      "accountid": "",
      "address": "mfioc8QgfcTVwuVd787JrdHMVjHACFWGX7",
      "balance": 2000,
      "confirm": 2,
      "memo": "",
      "time": 1547003080,
      "token": "BTC",
      "totalConfirm": 3,
      "txid": "4f0c8ebd3650f6e369a4b400330ffb579c9d163cd0fcea0d065644acff571dd9"
    }
  ],
  "pageIndex": 0,
  "pageSize": 3,
  "pageTotal": 1
}
**/

chainx.asset.getAddressByAccount(who, chain)

ChainX账户绑定BTC地址列表

参数:

  • who: AccountId 账户
  • chain: String 链ID 枚举[“ChainX”, “Bitcoin”, “Ethereum”, “Polkadot”]

示例:

chainx.asset.getAddressByAccount('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 'Bitcoin')
/**
[
  "mfioc8QgfcTVwuVd787JrdHMVjHACFWGX7"
]
**/

chainx.asset.verifyAddressValidity(token, addr, memo)

验证提现地址正确性

参数:

  • token: 币种名
  • addr: 地址
  • memo: 备注 （注：3个参数与提起提现请求时候交易withdraw 的参数列表完全一致）

示例:

chainx.asset.verifyAddressValidity("BTC", "2N8tR484JD32i1DY2FnRPLwBVaNuXSfzoAv", "")
/**
true // 返回 true 代表地址校验正确，false代表错误
**/

chainx.asset.getWithdrawalLimitByToken(token)

chainx 链上与提现金额相关的限制，如提现的最小值与用户提现扣除的手续费

参数:

  • token: 币种名

示例:

chainx.asset.getWithdrawalLimitByToken("BTC")
/**
{
	minimalWithdrawal: 150000,
	fee: 100000
}
**/

chainx.stake.getNominationRecords(who)

用户投票信息

参数:

  • who: AccountId 账户

示例:

chainx.stake.getNominationRecords('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ')
/**
[
  [
    "0x9886b933e38461399f5997ef162b1ef90f8bcb19d3a2f256be0a8d2f85a80d98", // 投票节点
    {
      "lastVoteWeight": 26000, // 票龄
      "lastVoteWeightUpdate": 3461, // 票龄更新高度
      "nomination": 600, // 投票金额
      "revocations": [
        {
          "blockNumer": 117,
          "value": 1
        }
      ] // 撤票记录，117 为可赎回高度，1 为届时的可赎回金额
    }
  ]
]
**/

chainx.stake.getIntentions()

节点列表

参数:

无

示例:

chainx.stake.getIntentions()
/**
[
  {
    "about": "", // 关于
    "account": "0xd172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f", // 账户 ID
    "isActive": true, // 是否参选
    "isTrustee": true, // 是否是信托节点
    "isValidator": true, // 是否是结算节点
    "jackpot": 387096776, // 奖池金额
    "jackpotAddress": "0xce153e3235448f29ca9052a660e36abd9b9fdc72f80a4059a2427ff06b1a3706", // 奖池地址
    "lastTotalVoteWeight": 0, // 总票龄
    "lastTotalVoteWeightUpdate": 0, // 总票龄更新时间
    "name": "Alice", // 节点名
    "selfVote": 1250000000, // 节点自投票
    "sessionKey": "0xd172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f", // 节点出块地址， 类型为 AccountId
    "totalNomination": 1250000000, // 节点总投票
    "url": "Alice.com" // 节点网址
  }
]

**/

chainx.stake.getPseduIntentions()

充值挖矿列表

参数:

无

示例:

chainx.stake.getPseduIntentions()
/**
[
  {
    "circulation": 2000000000, // 总发行量
    "id": "BTC", // 资产ID
    "jackpot": 0, // 奖池金额
    "lastTotalDepositWeight": 0, // 总票龄
    "lastTotalDepositWeightUpdate": 0, // 总票龄更新高度
    "power": 10000000, // 单位资产对PCX算力
    "price": 1000000000 // 单位资产对PCX移动均价
  }
]
**/

chainx.stake.getPseduNominationRecords(who)

用户投票信息

参数:

  • who: AccountId 账户

示例:

chainx.stake.getPseduNominationRecords('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ')
/**
[
  {
    "balance": 1000000000, // 投票金额
    "id": "BTC", // 资产 ID
    "lastTotalDepositWeight": 0, // 票龄
    "lastTotalDepositWeightUpdate": 0 // 票龄更新高度
  }
]

**/

chainx.stake.getBondingDuration()

获取普通用户撤销投票的锁定期，

参数:

无

示例:

chainx.stake.getBondingDuration()
/**
300 //300 个块
**/

chainx.stake.getIntentionBondingDuration()

获取节点用户撤销投票的锁定期

参数:

无

#示例:

chainx.stake.getIntentionBondingDuration()
/**
3000 //3000 个块
**/

chainx.stake.getNextKeyFor(who)

获取节点出块地址

参数:

  • who: AccountId 账户

示例:

chainx.stake.getNextKeyFor('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ')
/**
5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ
**/

chainx.trade.getTradingPairs()

交易对列表

参数:

无

示例:

chainx.trade.getTradingPairs()
/**
[
	{
		"assets": "PCX", # 交易对first
		"averPrice": 271325, # 平均价
		"buyOne": 1605400, # 买一价
		"currency": "BTC", # 交易对second
		"id": 0, # 交易对的ID
		"lastPrice": 400000,
		"maximumBid": 1615500,
		"minimumOffer": 1595400,
		"online": true, # 交易对状态 上线||下线
		"precision": 9, # 交易对价格精度 10.pow(precision)
		"sellOne": 1605500,
		"unitPrecision": 2,
		"updateHeight": 371940
	},
	# ...
]
**/

chainx.trade.getQuotations(id, piece)

交易对报价列表

参数:

  • id:OrderPairID 从chainx.trade.getTradingPairs接口中返回的交易对ID
  • piece:u32 ?档 必须<=10

示例:

chainx.trade.getQuotations(0,10)
/**
{
  "buy": [
    //买N档
    [
      100000, //价格
      20 //数量
    ]
  ],
  "id": 0, //交易对ID
  "piece": 10, //N档
  "sell": [] //卖N档
}
**/

chainx.trade.getOrders(who, page_index, page_size)

用户挂单列表

参数:

  • who: AccountId 账户
  • page_index: u32 页码 (从0开始)
  • page_size: u32 页大小 (<=100)

示例:

chainx.trade.getOrders('5FxL27izsvhViiQtgwBm6kP8XvMSZ3JjyoMCmaw7pGrgXqqJ', 0, 10)
/**
{
  "data": [
    {
      "amount": 40, //数量
      "class": "Limit", //订单类型（限价单|市价单)
      "createTime": 1547551914, //创建时间戳
      "direction": "Buy", //订单方向（卖|买）
      "fillIndex": [], //成交ID
      "hasfillAmount": 0, //已成交数量
      "index": 2, //订单编号
      "lastupdateTime": 1547551914, //最后更新时间戳
      "pair": 0, //交易对ID
      "price": 100000, //价格
      "reserveLast": 4000000, //锁定数量（若是卖，则是assets的数量）
      "status": "FillNo",
      //订单状态 (FillNo,FillPart,FillAll,FillPartAndCancel,Cancel)
      "user": "0xd172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f" //用户账户
    }
  ],
  "pageIndex": 0, //当前页码
  "pageSize": 100, //页大小
  "pageTotal": 1 //总共页数
}
**/