youchain.js 使用指南

导入 youchain.js 并进行调用

const YOUChain = require('youchain');
const youchain = new YOUChain("http://localhost:8283");
// 使用 -> youchain.you
// 使用 -> youchain.utils
// 使用 -> youchain.version

获取 youchain.js 的模块

YOUChain.modules;  // 获取模块
> {
    YOU: [Function: YOU],
    Net: [Function: Net],
    Personal: [Function: Personal]
}

options 配置

描述:youchain 模块为交易确认流程提供多种初始化配置,以下是目前常用的配置:

  • defaultAccount
  • defaultBlock
  • defaultGas
  • defaultGasPrice
  • transactionBlockTimeout
  • transactionConfirmationBlocks
  • transactionPollingTimeout
const YOUChain = require('youchain');
const options = {
    defaultAccount: '0x0',    // 默认账户
    defaultBlock: 'latest',    // 默认区块
    defaultGas: 1,              // 用于发送请求
    defaultGasPrice: 0,      // 用于发送请求
    transactionBlockTimeout: 50,  // 交易区块超时时间
    transactionConfirmationBlocks: 12,  //交易确认区块数
    transactionPollingTimeout: 750  // 交易长连接超时时间
}
const youchain = new YOUChain('http://localhost:8283', options);

setProvider

youchain.setProvider(myProvider) //设置所有模块的 provider
youchain.you.setProvider(myProvider) // 设置单独模块的 provider

示例:

const YOUChain = require('youchain');
const youchain = new YOUChain('http://localhost:8283');
// 或者
youchain.setProvider(new YOUChain.providers.HttpProvider('http://localhost:8283'));
youchain.setProvider(new YOUChain.providers.WebsocketProvider('ws://localhost:8283'));

providers

描述:当前可获取的 providers 类型。

YOUChain.providers;
> {
    HttpProvider: [Function: HttpProvider],
    WebsocketProvider: [Function: WebsocketProvider]
}

示例:

const YOUChain = require('youchain');
const youchain = new YOUChain(YOUChain.givenProvider || 'ws://localhost:8284/ws');
// 或者
const youchain = new YOUChain(YOUChain.givenProvider || new YOUChain.providers.WebsocketProvider('ws://localhost:8284/ws'));

givenProvider

备注:使用与 YOUChain 兼容的浏览器,浏览器环境会默认设置一个 provider,否则值为 null。

YOUChain.givenProvider
youchain.you.givenProvider

currentProvider

描述:返回当前 provider 的值,否则值为 null。

youchain.currentProvider
youchain.you.currentProvider

version

描述:获取 youchain.js 版本信息。

youchain.version; 
// 获取 youchain.js 版本
> "1.0.1"