Skip to content

Latest commit

 

History

History
1532 lines (1232 loc) · 44.7 KB

README_zh.md

File metadata and controls

1532 lines (1232 loc) · 44.7 KB
Raw

Logo of the project

LemoChain Core SDK

npm Build Status Coverage Status GitHub license

通过 JSON RPC 协议访问 LemoChain Core 节点上的数据

需要先在本地通过--rpc参数启动一个LemoChain Core节点，或远程连接到一个已存在的 LemoChain Core 节点，才能运行本项目

中文版
English

安装

使用 Yarn

yarn add lemo-core-sdk

在浏览器中引入

  • 在 html 中引入 lemo-core-sdk.min.js 文件
  • 通过全局变量 LemoCore 使用 SDK

示例

const LemoCore = require('lemo-core-sdk')
const lemo = new LemoCore({
    host: 'http://127.0.0.1:8001'
})

lemo.chain.getBlockByNumber(0).then(function(block) {
    console.log(block)
})

LemoChain Core API

基本上所有异步接口都返回 Promise 对象
所有接口都可在 LemoChain Core 的控制台中使用，但通过远程连接（如 http、websocket）到节点时，只能使用部分接口

API 功能 异步 可远程使用
lemo.getBlock(heightOrHash, withBody) 根据高度或 hash 获取区块 ✓ ✓
lemo.getNewestBlock(withBody) 获取最新的块 ✓ ✓
lemo.getNewestUnstableBlock() 获取最新的不稳定块 ✓
lemo.getNewestHeight() 获取最新高度 ✓ ✓
lemo.getNewestUnstableHeight() 获取最新不稳定块高度 ✓
lemo.getGenesis() 获取创世区块 ✓ ✓
lemo.getChainID() 获取当前链 ID ✓ ✓
lemo.getCandidateTop30() 获取排名前30的候选节点列表 ✓ ✓
lemo.getDeputyNodeList(onlyBlockSigner) 获取当前所有共识节点的信息列表 ✓ ✓
lemo.getTermReward(height) 获取换届奖励信息 ✓ ✓
lemo.getAllRewardValue() 获取所有的收益信息 ✓ ✓
lemo.getNodeVersion() 节点版本号 ✓ ✓
lemo.watchBlock(withBody, callback) 监听新的区块 ✓
lemo.stopWatchBlock(subscribeId) 停止监听区块 ✓
lemo.net.connect(nodeAddr) 连接节点 ✓
lemo.net.disconnect(nodeAddr) 断开连接 ✓
lemo.net.getConnections() 获取已建立的连接信息 ✓
lemo.net.getConnectionsCount() 获取已建立的连接数 ✓ ✓
lemo.net.getInfo() 获取本节点信息 ✓ ✓
lemo.net.getNodeID() 获取本节点的nodeId ✓ ✓
lemo.net.broadcastConfirm(hash) 广播确认 ✓
lemo.net.fetchConfirm(height) 拉取指定高度区块的确认包 ✓
lemo.mine.start() 开启挖矿 ✓
lemo.mine.stop() 停止挖矿 ✓
lemo.mine.getMining() 是否正在挖矿 ✓ ✓
lemo.mine.getMiner() 获取当前共识节点的记账收益地址 ✓ ✓
lemo.account.newKeyPair() 创新账户公私钥 ✓ ✓
lemo.account.getBalance(addr) 获取账户余额 ✓ ✓
lemo.account.getAccount(addr) 获取账户信息 ✓ ✓
lemo.account.getCandidateInfo(addr) 获取候选人信息 ✓ ✓
lemo.account.getVoteFor(addr) 获取账户的投票信息 ✓ ✓
lemo.account.getEquity(addr, assetId) 获取账户的资产余额 ✓ ✓
lemo.account.createTempAddress(from, userId) 创建临时账户 ✓
lemo.account.isTempAddress(address) 是否是临时账户 ✓
lemo.account.isContractAddress(address) 是否是合约账户 ✓
lemo.tx.send(txConfig, privateKey) 发送交易 ✓ ✓
lemo.tx.waitConfirm(txHash) 等待交易上链 ✓ ✓
lemo.tx.watchTx(filterTxConfig, callback) 监听过滤区块的交易 ✓
lemo.tx.stopWatchTx(subscribeId) 停止指定交易 ✓
lemo.tx.watchPendingTx(callback) 监听新的 pending 交易
lemo.stopWatch() 停止所有轮询 ✓
lemo.isWatching() 是否正在轮询 ✓
类属性 描述
LemoCore.SDK_VERSION js SDK 版本号
LemoCore.TxType 交易类型枚举
LemoCore.ChangeLogType 修改记录类型枚举
LemoCore.BigNumber 大数处理三方库

协议

以 json 格式收发数据，遵循JSON-RPC2.0标准
方便起见，所有数字都需要转换为字符串，以避免数值溢出的情况

POST 请求

{
    "jsonrpc": "2.0",
    "method": "chain_getBlockByHeight",
    "params": [1, false],
    "id": 1
}
  • jsonrpc - (string) 固定为2.0
  • method - (string) API 模块名和方法名，以下划线连接
  • params - (Array) API 方法参数列表，直接以对象形式传递参数
  • id - (number) 递增的请求 id

正常回包

{
    "jsonrpc": "2.0",
    "result": {...},
    "id": 1
}
  • jsonrpc - (string) 固定为2.0
  • result - (*) 返回的数据，可以是任意类型
  • id - (number) 对应的请求 id

异常回包

{
    "jsonrpc": "2.0",
    "error": {"code": -32601, "message": "Method not found"},
    "id": 1
}
  • jsonrpc - (string) 固定为2.0
  • error - (object) 异常信息，包含一个负数code和一个描述字符串message
  • id - (number) 对应的请求 id

数据结构

block

{
    "header": {},
    "transactions": [],
    "changeLogs": [],
    "confirms": [],
    "events": [],
    "deputyNodes": []
}
  • header 区块头
  • transactions 该块中打包的所有交易列表
  • changeLogs 该块对链上数据的修改记录列表
  • confirms 各共识节点验证区块通过后，对该块 hash 的签名列表
  • events 该块中所有交易产生的合约事件列表
  • deputyNodes 如果该块是一个快照块，则这里保存新一代共识节点信息的列表。否则为空

header

区块头

{
    "hash": "0x11d9153b14adb92a14c16b66c3524d62b4742c0e7d375025525e2f131de37a8b",
    "height": "0",
    "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "miner": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG",
    "signData": "0x",
    "timestamp": "1535630400",
    "gasLimit": "105000000",
    "gasUsed": "0",
    "eventBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "changeLogRoot": "0x93273cebb4f0728991811d5d7c57ae8f88a83524eedb0af48b3061ed2e8017b8",
    "deputyRoot": "0x49b613bbdf76be3fe761fd60d1ade6d2835315047c53d6e8199737898b8d9b47",
    "eventRoot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
    "transactionRoot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
    "versionRoot": "0x1e78c4779248d3d8d3cd9b77bf7b67b4c759ec87d45d52a3e79c928290773f4c",
    "extraData": ""
}
  • hash 区块 hash
  • height 区块高度
  • parentHash 上一个区块的 hash
  • miner 出块者的账户地址
  • signData 出块者对区块 hash 的签名
  • timestamp 出块时间戳，单位为秒
  • gasLimit 该块中打包的交易消耗的总 gas 上限
  • gasUsed 该块中打包的交易消耗的实际 gas
  • eventBloom 对区块中的events计算出的 Bloom 过滤器，用来快速查询合约事件
  • changeLogRoot 将区块中的changeLogs以 Merkle 树的形式组织起来，得到的根节点 hash
  • deputyRoot 将区块中的deputyNodes以 Merkle 树的形式组织起来，得到的根节点 hash
  • eventRoot 将区块中的events以 Merkle 树的形式组织起来，得到的根节点 hash
  • transactionRoot 将区块中的transactions以 Merkle 树的形式组织起来，得到的根节点 hash
  • versionRoot 该块打包时全局账户版本树的根节点 hash
  • extraData (可选) 出块者向区块中添加的自定义信息

transaction

交易

{
    "type": "1",
    "chainID": "1",
    "version": "1",
    "from": "Lemo836BQKCBZ8Z7B7N4G4N4SNGBT24ZZSJQD24D",
    "to": "Lemo83JW7TBPA7P2P6AR9ZC2WCQJYRNHZ4NJD4CY",
    "gasPayer": "",
    "toName": "",
    "amount": "100",
    "data": "0x",
    "expirationTime": 1541566996,
    "gasLimit": 2000000,
    "gasPrice": "3000000000",
    "hash": "0x6d3062a9f5d4400b2002b436bc69485449891c83e23bf9e27229234da5b25dcf",
    "message": "",
    "sigs": ["0xd9a9f9f41ea020185a6480fe6938d776f0a675d89057c071fc890e09742a4dd96edb9d48c9978c2f12fbde0d0445f2ff5f08a448b91469511c663567d0b015f601"],
    "gasPayerSigs": ["0x800be6a0cf31ab9e86d547fb8cf964339276233a2b260ad8a4b4c93b39a48d6b1761e125f601bc6953e30eaad3e698c12add332a5740f1618915c12432dc610601"]
}
  • type 交易类型
  • chainID LemoChain的ID
  • version 当前交易版本，介于0-128之间
  • from 交易发送者的账户地址
  • to 交易接收者的账户地址
  • gasPayer 代付gas的账户地址
  • toName (可选) 交易接收者的账户名，会与账户地址进行比对校验。类似银行转账时填写的姓名与卡号的关系。最大长度为100字符
  • amount 交易金额，BigNumber对象，单位mo。1LEMO=1000000000000000000mo=1e18mo
  • data (可选) 交易附带的数据，可用于调用智能合约。根据交易类型也会有不同的作用
  • expirationTime 交易过期时间戳，单位为秒。如果交易过期时间在半小时以后，则可能不会被打包，这取决于节点交易池的配置
  • gasLimit 交易消耗的 gas 上限。如果超过这个限制还没运行结束，则交易失败，并且 gas 费用不退还
  • gasPrice 交易消耗 gas 的单价，BigNumber对象，单位为mo。单价越高越优先被打包
  • hash 交易 hash
  • message (可选) 交易附带的文本消息。最大长度为1024字符
  • sigs 交易签名数组，每个字段长度为65个字节
  • gasPayerSigs 代付 gas 交易签名数组，每个字段长度为65个字节

交易类型 数值 说明
lemo.TxType.ORDINARY 0 普通转账交易或合约执行交易
lemo.TxType.CREATE_CONTRACT 1 创建智能合约交易
lemo.TxType.VOTE 2 设置投票对象
lemo.TxType.CANDIDATE 3 注册或修改候选人信息
lemo.TxType.CREATE_ASSET 4 创建资产信息
lemo.TxType.ISSUE_ASSET 5 发行资产
lemo.TxType.REPLENISH_ASSET 6 增发资产交易
lemo.TxType.MODIFY_ASSET 7 修改资产交易
lemo.TxType.TRANSFER_ASSET 8 交易资产
lemo.TxType.MODIFY_SIGNER 9 修改多重签名
lemo.TxType.BOX_TX 10 箱子交易，打包多笔交易，事务性地运行它们
chainID 说明
1 LemoChain 主网
100 LemoChain 测试网

asset

资产信息

{
    "category": "1",
    "decimal": 18,
    "totalSupply": "15000000000000000000",
    "isReplenishable": true,
    "isDivisible": true,
    "issuer": "Lemo83GWNWJQ3DQFN6F24WFZF5TGQ39A696GJ7Z3",
    "profile": {
        "name": "Demo Asset",
        "symbol": "DT",
        "description": "this is a asset information",
        "suggestedGasLimit": "60000",
        "freeze": "false"
    }
}
  • category 资产类型
  • decimal 发行资产的小数位，表示将总数细化到小数点后多少位，默认为18位
  • totalSupply 发行的资产总量，当资产在增发和销毁时发行的资产总量会实时变化，发行资产总量为发行量*10^decimal
  • isReplenishable 该资产是否可增发，在创建资产时设置，设置后不可再次修改，默认为true
  • isDivisible 该资产是否可分割，在创建资产时设置，设置后不可再次修改，默认为true
  • issuer 发行者地址，根据创建资产时的签名字段得到
  • profile 资产的其他信息，此部分内容可以再次修改
    • name 创建该资产时的资产名称
    • symbol 资产标识
    • description 资产基本信息
    • suggestedGasLimit 交易消耗的gas上限，和gasLimit相同用法，创建资产时由用户自己设置，默认为60000
    • freeze 是否冻结资产，默认为false，将其设置为true可以停止该资产除查询以外的一切操作

category 说明
1 通证资产，和以太坊的ERC20代币类似，发行时可以设置是否允许今后增发，用户收到币后可以任意分割转账
2 非同质化资产，和以太坊的ERC721代币类似，可以携带少量资产信息，并且不可分割
3 通用资产，更加灵活的数字资产，适用于更加复杂的场景，以上两种资产都由通用资产特化而来

equity

记录资产持有者的资产信息，保存在持有者的账户中

{
    "assetCode": "0xd0befd3850c574b7f6ad6f7943fe19b212affb90162978adc2193a035ced8884",
    "assetId": "0x34b04e018488f37f449193af2f24feb3b034c994cde95d30e3181403ac76528a",
    "balance": "15000000000000000000"
}
  • assetCode 资产码，创建资产时得到
  • assetId 资产Id，发行资产时得到，如果资产类型为1，则 assetCode 和 assetId 相同
  • balance 资产余额，单位是mo

changeLog

交易对链上数据的修改记录

{
    "address": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG",
    "extra": "",
    "newValue": "0x8c052b7d2dcc80cd2e40000000",
    "type": "BalanceLog",
    "version": 1
}
  • address 产生了数据变化的账号地址
  • version 账户数据的版本号，每种type的数据版本号彼此独立
  • 根据type的不同，newValue和extra内保存的数据也不同

type 数值 功能 newValue extra
lemo.ChangeLogType.BalanceLog 1 账户余额变化 新的余额 -
lemo.ChangeLogType.StorageLog 2 合约账户存储数据变化 value key
lemo.ChangeLogType.StorageRootLog 3 合约账户存储树的根节点变化 存储树的根节点hash -
lemo.ChangeLogType.AssetCodeLog 4 创建资产类型信息 完整的资产类型信息 资产code
lemo.ChangeLogType.AssetCodeStateLog 5 修改资产类型信息中的字段 字段值 资产code和字段key
lemo.ChangeLogType.AssetCodeRootLog 6 账户创建的资产类型信息的树的根节点变化 资产类型信息树的根节点hash -
lemo.ChangeLogType.AssetCodeTotalSupplyLog 7 发行、增发或销毁资产 资产总量 资产code
lemo.ChangeLogType.AssetIdLog 8 发行资产通证或修改其metadata 资产通证中的metadata 资产id
lemo.ChangeLogType.AssetIdRootLog 9 账户发行的资产通证信息的树的根节点变化 资产通证信息树的根节点hash -
lemo.ChangeLogType.EquityLog 10 账户持有资产的余额变化 资产余额信息 资产id
lemo.ChangeLogType.EquityRootLog 11 账户持有资产的余额树的根节点变化 资产余额树的根节点hash -
lemo.ChangeLogType.CandidateLog 12 创建或修改竞选信息 竞选信息对象 -
lemo.ChangeLogType.CandidateStateLog 13 账户竞选信息的某字段变化 字段值 字段key
lemo.ChangeLogType.CodeLog 14 创建合约账户 合约 code -
lemo.ChangeLogType.AddEventLog 15 产生一条合约日志 合约日志 -
lemo.ChangeLogType.SuicideLog 16 销毁合约账户 - -
lemo.ChangeLogType.VoteForLog 17 修改投票对象账号地址 新的投票对象地址 -
lemo.ChangeLogType.VotesLog 18 候选者收到的票数变化 新的票数 -
lemo.ChangeLogType.SignersLog 19 多重签名账户的变化 多重签名对象 -

confirm

共识节点验证区块通过后，对该块 hash 的签名

0x1234

event

合约事件

{
    "address": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG"
}

deputyNode

共识节点的信息

{
    "minerAddress": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG",
    "nodeID": "0x5e3600755f9b512a65603b38e30885c98cbac70259c3235c9b3f42ee563b480edea351ba0ff5748a638fe0aeff5d845bf37a3b437831871b48fd32f33cd9a3c0",
    "host": "127.0.0.1",
    "port": "7001",
    "votes": "50000"
}
  • minerAddress 节点的挖矿收益账号地址
  • nodeID 节点的 ID，即节点对区块签名时的私钥对应的公钥。长度为130个字符，需要加0x
  • host 节点的 IP 地址或域名。最大长度为128字符
  • port 与其它节点连接用的端口号
  • votes 节点的总票数

account

账户信息

{
    "address": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG",
    "assetCodeRoot": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "assetIdRoot": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "balance": "1599999999999999999999999900",
    "records": {
        "BalanceLog": {
            "version": 3,
            "height": 1
        }
    },
    "codeHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "equityRoot": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "root": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "txCount": 0,
    "voteFor": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG",
    "candidate": {
        "votes": "1599999000",
        "profile": {
            "host": "www.lemochain.com",
            "isCandidate": "true",
            "minerAddress": "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG",
            "nodeID": "0x5e3600755f9b512a65603b38e30885c98cbac70259c3235c9b3f42ee563b480edea351ba0ff5748a638fe0aeff5d845bf37a3b437831871b48fd32f33cd9a3c0",
            "port": "7001"
        }
    },
    "signers": [{"address": "Lemo83JW7TBPA7P2P6AR9ZC2WCQJYRNHZ4NJD4CY","weight": "60"}, {"address": "Lemo842BJZ4DKCC764C63Y6A943775JH6NQ3Z33Y", "weight":  "50"}]
}
  • address 账户地址
  • assetCodeRoot 创建过的资产树的根节点 hash
  • assetIdRoot 发行过的资产树的根节点 hash
  • balance 账户余额，BigNumber对象，并且有toMoney()方法可以输出格式化金额
  • records 账户数据的修改记录对象。其中 key 是ChangeLog的类型，value 是该类型对应最新的那一条ChangeLog的版本号和所在的区块高度
  • codeHash 合约账户的代码 hash
  • equityRoot 资产余额树的根节点hash
  • root 合约账户的存储树根节点 hash
  • txCount 账户收到或发送的交易数量
  • voteFor 投票对象的账户地址
  • candidate 如果是候选者账户，则该字段不为空
    • votes 候选者收到的总票数
    • profile 候选者信息
      • host 候选者的节点服务器连接地址，可以是IP或域名
      • isCandidate 该账户是否是候选者。用来取消候选者身份
      • minerAddress 节点的挖矿收益账号地址
      • nodeID 节点的 ID，即节点对区块签名时的私钥对应的公钥。长度为130个字符，需要加0x
      • port 候选者的节点服务器端口号
  • signers 多签账户的签名者列表。若不为空，则需要集齐权重总和超过100的多位签名者的签名才可以发送交易
    • address 签名者的账户地址
    • weight 签名者的权重

构造函数

lemo = new LemoCore({
    chainID: 1, 
    host: 'http://127.0.0.1:8001'
})
  • chainID 区块链的 ID，默认值为1，即 LemoChain 主链
  • host LemoChain 节点的 HTTP 连接地址。默认值http://127.0.0.1:8001

    注意: 如果连接后出现跨域问题，则需要用参数--rpccorsdomain http://sdk所在web的域名:端口号的方式启动 LemoChain 节点

chain 模块 API

lemo.getBlock

lemo.getBlock(heightOrHash [, withBody])

根据高度或 hash 获取区块

Parameters
  1. number|string - 区块高度或 hash 字符串。如果是高度，则只能获取稳定块（经过多数共识节点签名确认的区块）
  2. boolean - (可选) 是否获取交易列表等区块体内容。默认为false
Returns

Promise - 通过then可以获取到区块对象

Example
lemo.getBlock(0).then(function(block) {
    console.log(block.header.hash) // "0x11d9153b14adb92a14c16b66c3524d62b4742c0e7d375025525e2f131de37a8b"
})

lemo.getNewestBlock

lemo.getNewestBlock([withBody])

获取最新的块

Parameters
  1. boolean - (可选) 是否获取交易列表等区块体内容。默认为false
Returns

Promise - 通过then可以获取到区块对象

Example
lemo.getNewestBlock(true).then(function(block) {
    console.log(block.header.miner) // "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG"
})

lemo.getNewestUnstableBlock

lemo.getNewestUnstableBlock()

获取最新不稳定的块，可能没有足够的共识节点确认

Parameters

无

Returns

Promise - 通过then可以获取到区块对象，包括区块体

Example
lemo.getNewestUnstableBlock().then(function(block) {
    console.log(block.header.miner) // "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG"
})

lemo.getNewestHeight

lemo.getNewestHeight([stable])

获取最新块高度

Parameters

无

Returns

Promise - 通过then可以获取到当前区块高度

Example
lemo.getNewestHeight().then(function(height) {
    console.log(height) // "100"
})

lemo.getNewestUnstableHeight

lemo.getNewestUnstableHeight()

获取最新不稳定块高度

Parameters

无

Returns

Promise - 通过then可以获取到当前区块高度

Example
lemo.getNewestUnstableHeight().then(function(height) {
    console.log(height) // "100"
})

lemo.getGenesis

lemo.getGenesis()

获取创世区块

Parameters

无

Returns

Promise - 通过then可以获取到区块对象

Example
lemo.getGenesis().then(function(block) {
    console.log(block.header.parentHash) // "0x0000000000000000000000000000000000000000000000000000000000000000"
})

lemo.getChainID

lemo.getChainID()

获取 LemoChain 节点的当前链 ID

Parameters

无

Returns

Promise - 通过then可以获取到当前 chainID

Example
lemo.getChainID().then(function(chainID) {
    console.log(chainID) // "1"
})

lemo.getCandidateTop30

lemo.getCandidateTop30()

获取排名前30的候选节点列表

Parameters

无

Returns

Promise - 通过then可以获取到候选人信息对象的数组。这里的候选人信息与账户信息中的candidate对象一致，只是在这个候选人信息中增加了一个address字段，表示账户地址

Example
lemo.getCandidateTop30().then(function(candidateList) {
    console.log(candidateList.length) // 1
    console.log(candidateList[0].address) // Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG
    console.log(JSON.stringify(candidateList)) // [{"address":"Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG","profile":{"host":"127.0.0.1","isCandidate":true,"minerAddress":"Lemobw","nodeID":"0x5e3600755f9b512a65603b38e30885c98cbac70259c3235c9b3f42ee563b480edea351ba0ff5748a638fe0aeff5d845bf37a3b437831871b48fd32f33cd9a3c0","port":7001},"votes":"1599999000"}]
})

lemo.getDeputyNodeList

lemo.getDeputyNodeList(onlyBlockSigner)

获取当前所有共识节点的信息

Parameters
  1. boolean - （可选）若为true则获取当前可对区块进行签名的共识节点信息，false则获取当前已当选的共识节点信息
Returns

Promise - 通过then可以获取当前所有共识节点的信息列表
minerAddress - (string)节点出块账号 incomeAddress - (string)节点收益账号 nodeID - (string)节点ID，由节点签名区块时用的私钥得来。以0x开头，长度为130个字符 rank - (number)出块节点所在的排名 votes - (string)节点所得票数 host - (string)节点域名或IP port - (number)端口号 depositAmount - (string)质押金额 introduction - (string)节点简介 p2pUri - (string)LemoChain节点的连接地址。该地址可用于连接节点

Example
lemo.getDeputyNodeList(true).then(function(nodeList) {
    console.log(nodeList.length) // 1
    console.log(JSON.stringify(nodeList[0]))
// "{"minerAddress":"Lemo83DZ5J99JSK5ZH89TCW7T6ZZCWJ8H7FDGA7W","incomeAddress":"Lemo83DZ5J99JSK5ZH89TCW7T6ZZCWJ8H7FDGA7W","nodeID":"0x0e7dcd418dbe7717eb0e83162f8810a3c7725e0d386b324dc5f3ef5a27a2a83e393a193f6ab53d3a51b490adeee362357676f50eed3d188824ef1fb3af02b2d0","rank":0,"votes":"50000","host":"127.0.0.1","port":8080,"depositAmount":"5000000000000000000000000","introduction":"ddf","p2pUri":"0e7dcd418dbe7717eb0e83162f8810a3c7725e0d386b324dc5f3ef5a27a2a83e393a193f6ab53d3a51b490adeee362357676f50eed3d188824ef1fb3af02b2d0@127.0.0.1:8080"}"
    lemo.net.connect(nodeList[0].p2pUri)
})

lemo.getTermReward

lemo.getTermReward(height)

获取换届奖励信息

Parameters
  1. number - 区块高度，将根据该高度找到这一届中发放奖励的区块
Returns

object - 换届奖励信息，包括： term - (number)届数，从0开始 value - (string)发放奖励的总量，单位为mo rewardHeight - (number)发放奖励区块的高度

Example
lemo.getTermReward(1001).then(function(result){
console.log(JSON.stringify(result)) // {"term":0,"value":"1000000000","rewardHeight":10001}
})

lemo.getAllRewardValue

lemo.getAllRewardValue()

获取当前链所有的矿工收益信息

Parameters

无

Returns

object - 矿工的奖励信息，包括： term - (number)届数，从0开始 value - (string)该届设置的奖励金额 times - (number)这届奖励金额的修改次数，修改次数为1或2

Example
lemo.getAllRewardValue().then(function(result){
console.log(result) // { 0: { term: '1', value: '1000000001', times: '1' } }
})

lemo.getNodeVersion

lemo.getNodeVersion()

获取 LemoChain 节点版本号

Parameters

无

Returns

Promise - 通过then可以获取到 LemoChain 节点版本号

Example
lemo.getNodeVersion().then(function(version) {
    console.log(version) // "1.0.0"
})

lemo.watchBlock

lemo.watchBlock(withBody, callback)

监听新的区块。在调用时会直接返回当前最新的区块。之后会等到产生了新的稳定块再回调

Parameters
  1. boolean - 是否获取交易列表等区块体内容。默认为false
  2. Function - 每次回调会传入区块对象
Returns

number - subscribeId，可用于取消监听

Example
lemo.watchBlock(true, function(block) {
    const d = new Date(1000 * parseInt(block.header.timestamp, 10))
    console.log(d.toUTCString()) // "Thu, 30 Aug 2018 12:00:00 GMT"
})

lemo.stopWatchBlock

lemo.stopWatchBlock(subscribeId)

停止监听区块

Parameters
  1. number - watchBlock返回的subscribeId
Returns

无

Example
const subscribeId = lemo.watchBlock(false, function(newBlock) {
    console.log(newBlock)
})
lemo.stopWatchBlock(subscribeId)

net 模块 API

lemo.net.connect

lemo.net.connect(nodeAddr)

连接到指定的 LemoChain 节点

Parameters
  1. string - 节点 ID 和 IP 地址
Returns

Promise - 无返回数据

Example
lemo.net.connect('5e3600755f9b512a65603b38e30885c98cbac70259c3235c9b3f42ee563b480edea351ba0ff5748a638fe0aeff5d845bf37a3b437831871b48fd32f33cd9a3c0@127.0.0.1:60002')

lemo.net.disconnect

lemo.net.disconnect(nodeAddr)

断开与指定 LemoChain 节点的连接

Parameters
  1. string - ip 地址
Returns

Promise - 通过then可以获取到断开连接是否成功

Example
lemo.net.disconnect('127.0.0.1:60002').then(function(success) {
    console.log(sucess ? 'success' : 'fail')
})

lemo.net.getConnections

lemo.net.getConnections()

获取已建立的连接信息

Parameters

无

Returns

Promise - 通过then可以获取到连接信息列表

Example
lemo.net.getConnections().then(function(connections) {
    console.log(connections)
    // [{
    //   localAddress: "127.0.0.1:50825",
    //   nodeID: "0xddb5fc36c415799e4c0cf7046ddde04aad6de8395d777db4f46ebdf258e55ee1d698fdd6f81a950f00b78bb0ea562e4f7de38cb0adf475c5026bb885ce74afb0",
    //   remoteAddress: "127.0.0.1:60002"
    // }]
})

lemo.net.getConnectionsCount

lemo.net.getConnectionsCount()

获取已建立的连接数

Parameters

无

Returns

Promise - 通过then可以获取到连接数

Example
lemo.net.getConnectionsCount().then(function(count) {
    console.log(count) // "1"
})

lemo.net.getInfo

lemo.net.getInfo()

获取本节点信息

Parameters

无

Returns

Promise - 通过then可以获取到节点信息

Example
lemo.net.getInfo().then(function(info) {
    console.log(info.nodeName) // "Lemo"
    console.log(info.nodeVersion) // "1.0.0"
    console.log(info.os) // "windows-amd64"
    console.log(info.port) // "60001"
    console.log(info.runtime) // "go1.10.1"
})

lemo.net.getNodeID

lemo.net.getNodeID()

获取当前节点nodeID

Parameters

无

Returns

Promise - 通过then可以获取到当前节点的nodeID

Example
lemo.net.getNodeID().then(function(info) {
    console.log(info) // "0x0e7dcd418dbe7717eb0e83162f8810a3c7725e0d386b324dc5f3ef5a27a2a83e393a193f6ab53d3a51b490adeee362357676f50eed3d188824ef1fb3af02b2d0"
})

lemo.net.broadcastConfirm

lemo.net.broadcastConfirm(hash)

广播确认包

Parameters
  1. string - 区块hash
Returns

无

Example
lemo.net.broadcastConfirm('0x6d3062a9f5d4400b2002b436bc69485449891c83e23bf9e27229234da5b25dcf')

lemo.net.fetchConfirm

lemo.net.fetchConfirm(height)

拉取指定高度区块的确认包

Parameters
  1. number - 区块高度
Returns

无

Example
lemo.net.fetchConfirm(1001)

mine 模块 API

lemo.mine.start

lemo.mine.start()

开启挖矿

Parameters

无

Returns

Promise - 无返回数据

Example
lemo.mine.start()

lemo.mine.stop

lemo.mine.stop()

停止挖矿

Parameters

无

Returns

Promise - 无返回数据

Example
lemo.mine.stop()

lemo.mine.getMining

lemo.mine.getMining()

是否正在挖矿

Parameters

无

Returns

Promise - 通过then可以获取到是否正在挖矿

Example
lemo.mine.getMining().then(function(isMining) {
    console.log(isMining ? 'mining' : 'not mining')
})

lemo.mine.getMiner

lemo.mine.getMiner()

获取当前共识节点的记账收益地址，即用于接收交易 gas 的账户地址

Parameters

无

Returns

Promise - 通过then可以获取到账号地址

Example
lemo.mine.getMiner().then(function(miner) {
    console.log(miner) // "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG"
})

account 模块 API

lemo.account.newKeyPair

lemo.account.newKeyPair()

创建新的账户地址和私钥

Parameters

无

Returns

Promise - 通过then可以获取到私钥，账号公钥和账号地址

Example
const result = lemo.account.newKeyPair()
console.log(result.privateKey) // "0xfdbd9978910ce9e1ed276a75132aacb0a12e6c517d9bd0311a736c57a228ee52"
console.log(result.address) // "Lemo83BYKZJ4RN4TKC9C78RFW7YHW6S87TPRSH34"

lemo.account.getBalance

lemo.account.getBalance(address)

获取账户余额

Parameters
  1. string - 账户地址
Returns

Promise - 通过then可以获取到余额的BigNumber对象

Example
lemo.account.getBalance('Lemo83BYKZJ4RN4TKC9C78RFW7YHW6S87TPRSH34').then(function(balance) {
    console.log(balance.toString(10)) // "1600000000000000000000000000"
})

lemo.account.getAccount

lemo.account.getAccount(address)

获取账户信息

Parameters
  1. string - 账户地址
Returns

Promise - 通过then可以获取到账户信息

Example
lemo.account.getAccount('Lemo83BYKZJ4RN4TKC9C78RFW7YHW6S87TPRSH34').then(function(account) {
    console.log(account.balance.toMoney()) // "1600000000 LEMO"
})

lemo.account.getCandidateInfo

lemo.account.getCandidateInfo(address)

获取候选人信息

Parameters
  1. string - 候选人账户地址
Returns

Promise - 通过then可以获取到候选人信息，即账户中的candidate字段

Example
lemo.account.getCandidateInfo('Lemo83BYKZJ4RN4TKC9C78RFW7YHW6S87TPRSH34')
    .then(function(candidate) {
        console.log(candidate.votes); // "1599999000"
    })

lemo.account.getVoteFor

lemo.account.getVoteFor(address)

获取当前账户的投票地址

Parameters
  1. string - 账户地址
Returns

promise - 返回一个投票目标地址

Example
lemo.account.getVoteFor('Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG')
    .then(function(info) {
        console.log(info); // "Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG"
    })

lemo.account.getEquity

lemo.account.getEquity(address, assetId)

获取账号的收益情况

Parameters
  1. string - 账户地址
  2. string - 资产id
Returns

Promise - 通过then可以获取到当前资产的信息，包括： assetCode - (string)资产code assetId - (string)资产id equity - (string)资产金额

Example
lemo.account.getEquity('Lemo836BQKCBZ8Z7B7N4G4N4SNGBT24ZZSJQD24D', '0x34b04e018488f37f449193af2f24feb3b034c994cde95d30e3181403ac76528a')
    .then(function(info) {
        console.log(info.assetCode); // "0xd0befd3850c574b7f6ad6f7943fe19b212affb90162978adc2193a035ced8884"
    })

lemo.account.createTempAddress

lemo.account.createTempAddress(from, userId)

创建临时账户

Parameters
  1. string - 创建者地址
  2. string - 自定义的用户ID，必须是一个10字节以内的十六进制字符串
Returns

string - 临时账户地址

Example
const userId = '1110000000000000000'
const result = lemo.account.createTempAddress('Lemo836BQKCBZ8Z7B7N4G4N4SNGBT24ZZSJQD24D', userId)
console.log(result) // Lemo85SY56SGRTQQ63A2Y43KYA8C7QAZB37P3KY5

lemo.account.isTempAddress

lemo.account.isTempAddress(address)

校验地址是否为临时账户

Parameters
  1. string - 账户地址
Returns

boolean - 是否是临时账户

Example
const result = lemo.account.isTempAddress('Lemo85SY56SGRTQQ63A2Y43KYA8C7QAZB37P3KY5')
console.log(result) // true

lemo.account.isContractAddress

lemo.account.isContractAddress(address)

校验地址是否为合约账户

Parameters
  1. string - 账户地址
Returns

boolean - 是否是合约账户

Example
const result = lemo.account.isContractAddress('Lemo836BQKCBZ8Z7B7N4G4N4SNGBT24ZZSJQD24D')
console.log(result) // false

tx 模块 API

lemo.tx.send

lemo.tx.send(txConfig, privateKey)

发送交易

Parameters
  1. LemoTx|object|string - 签过名或未签名的交易信息，可以是LemoTx对象形式也可以是lemo.tx.sign返回的字符串形式
  2. string - (可选) 交易发送者的账户私钥，若存在，则会为交易签名
Returns

Promise - 通过then可以获取到交易 hash

Example
const txConfig = {from: 'Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG', to: 'Lemo83BYKZJ4RN4TKC9C78RFW7YHW6S87TPRSH34', amount: 100}
lemo.tx.send(txConfig, '0xc21b6b2fbf230f665b936194d14da67187732bf9d28768aef1a3cbb26608f8aa').then(function(txHash) {
    console.log(txHash) // 0x03fea27a8d140574dc648e1cb1a198f5ade450a347095cff7f3d961a11dac505
})
const tx = new LemoTx({chainID: 100, from: 'Lemo83GN72GYH2NZ8BA729Z9TCT7KQ5FC3CR6DJG', to: 'Lemo83BYKZJ4RN4TKC9C78RFW7YHW6S87TPRSH34', amount: 100})
tx.signWith('0xc21b6b2fbf230f665b936194d14da67187732bf9d28768aef1a3cbb26608f8aa')
lemo.tx.send(tx).then(function(txHash) {
    console.log(txHash) // 0x03fea27a8d140574dc648e1cb1a198f5ade450a347095cff7f3d961a11dac505
})

lemo.tx.waitConfirm

lemo.tx.waitConfirm(txHash)

等待交易上链

Parameters
  1. string - 交易hash
Returns

Promise - 通过then可以获取到交易信息

Example
lemo.tx.waitConfirm(0xe71cd6d98b1e48ddccf36ed655700478971a8514abf7c4d2173512201222c6c0).then(function(result) {
  console.log(JSON.stringify(result))
  // {"blockHash":"0x425f4ca99da879aa97bd6feaef0d491096ff3437934a139f423fecf06f9fd5ab","height":"100","time":"1541649535","tx":{"chainID":200,"version":"1","type":"0","to":"Lemo846Q4NQCKJ2YWY6GHTSQHC7K24JDC7CPCWYH","toName":"aa","gasPrice":"2","gasLimit":"100","amount":"1","data":"0x0c","expirationTime":"1544584596","message":"aaa","from":"Lemo836BQKCBZ8Z7B7N4G4N4SNGBT24ZZSJQD24D","sigs":["0x8c0499083cb3d27bead4f21994aeebf8e75fa11df6bfe01c71cad583fc9a3c70778a437607d072540719a866adb630001fabbfb6b032d1a8dfbffac7daed8f0201"]}}
})

lemo.tx.watchTx

lemo.tx.watchTx(filterTxConfig, callback)

监听过滤区块中的交易，返回一个带有此信息的一个数组对象，得到subscribeId

Parameters
  1. object - 交易筛选条件，可输入多个属性
  2. function - 每次回调会传入过滤出来的交易数组
Returns

number - subscribeId，可用于取消监听

Example
lemo.tx.watchTx({to:'Lemo83JW7TBPA7P2P6AR9ZC2WCQJYRNHZ4NJD4CY'}, function(transactions) {
    console.log(transactions[0].version)
}); //"1"

lemo.tx.watchTx({to:'Lemo83JW7TBPA7P2P6AR9ZC2WCQJYRNHZ4NJD4CY', from:'Lemo836BQKCBZ8Z7B7N4G4N4SNGBT24ZZSJQD24D'}, function(transactions) {
    console.log(transactions[0].version)
}); //"1"

lemo.tx.watchPendingTx

lemo.tx.watchPendingTx(callback)

监听新的交易。在调用时会直接返回当前待打包的交易。之后会等到节点接收到新的交易再回调（1.0.0 版未实现）

Parameters
  1. Function - 每次回调会传入交易对象列表
Returns

number - subscribeId，可用于取消监听

Example
lemo.watchPendingTx(true, function(transactions) {
    console.log(transactions.length)
})

lemo.tx.stopWatchTx

lemo.tx.stopWatchTx(subscribeId)

停止监听区块中的交易

Parameters
  1. number - watchTx或watchPendingTx返回的subscribeId
Returns

无

Example
const subscribeId = lemo.tx.watchTx({to:'Lemo83JW7TBPA7P2P6AR9ZC2WCQJYRNHZ4NJD4CY'}, function(transactions) {
    console.log(transactions[0].version)
}); 
lemo.tx.stopWatchTx(subscribeId)

lemo.stopWatch

lemo.stopWatch()

停止所有轮询

Parameters

无

Returns

无

Example
lemo.stopWatch()

lemo.isWatching

lemo.isWatching()

是否正在轮询

Parameters

无

Returns

boolean - 是否正在轮询

Example
console.log(lemo.isWatching() ? 'watching' : 'not watching')

其它 API

LemoCore.SDK_VERSION

LemoCore.SDK_VERSION

string - SDK 版本号字符串

Example
console.log(LemoCore.SDK_VERSION) // "1.0.0"

LemoCore.TxType

LemoCore.TxType

交易类型枚举类型，其中的值都是number类型

Example
console.log(LemoCore.TxType.VOTE) // 1

LemoCore.ChangeLogType

LemoCore.ChangeLogType

修改记录类型枚举类型，其中的值都是number类型

Example
console.log(LemoCore.ChangeLogType.BalanceLog) // 1

开发

依赖

  • Node.js
  • yarn
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install yarn

编译

yarn build

测试

yarn test

开源协议

LGPL-3.0