LTC链常用接口使用

注：以下rpc接口测试均在开发网络完成

区块链API

• getblockcount 获取最新区块高度
• getblockhash 获取指定高度区块的哈希
• getblock 获取指定哈希的区块信息

挖矿类API

• generatetoaddress 挖矿

裸交易API

• getrawtransaction 获取指定裸交易
• decoderawtransaction 解码裸交易

钱包类API

• getnewaddress 获取新地址
• getbalance 查看钱包中全部bch可用余额
• getbalances 查看钱包中全部bch中所有余额
• listaddressgroupings 显示bch钱包中所有地址余额
• sendtoaddress 发送金额至指定地址
• gettransaction 获取钱包内交易的详细信息
• listreceivedbyaddress 查询钱包内某个地址收入交易列表
• settxfee 设置bch交易手续费率
• dumpwallet 导出钱包文件为文本

getblockcount

获取最新区块高度

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 getblockcount

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockcount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

getblockhash

获取指定高度区块的哈希

• 请求参数

1.BlockHeight：区块高度

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 getblockhash 100

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockhash", "params": [100] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

1.getblockhash：返回指定区块高度的区块哈希值

getblock

获取指定哈希的区块信息

• 请求参数

1.HeaderHash：区块哈希
2.Format：结果格式，可选项为：0：串流格式；1：json格式（默认为1）；2：json格式，同时解码区块中的交易

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 getblock f06107f9db1f93fdad058d3d1caf9897eb2607e98ae4c4e505fd5446dd1a5be3

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": ["f06107f9db1f93fdad058d3d1caf9897eb2607e98ae4c4e505fd5446dd1a5be3"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

getblock调用根据参数Format的不同返回值有所区别。

1.如果Format是0，那么返回的就是16进制字符串表示的序列化交易。
2.如果Format是1，那么返回的就是JSON对象，包括区块哈希，确认数，区块字节数等
3.如果Format是2，那么返回的JSON对象中tx数组成员是解码的交易对象

generatetoaddress

将挖矿之后的奖励发送至某个地址

• 请求参数

1.Blocks：出块数量
2.Address：接收奖励的比特币的地址
3.Maxtries：最大重试次数，默认：1000000

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 generatetoaddress 1 QgjwzncVc5MrSFnyoWxYi66zf9h1vxaXPG

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "generatetoaddress", "params": [1,"QdkBjWvoYgn158ew4GWhWBvMpCmA6TK6zn"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

1.区块哈希：调用返回生成的区块头哈希数组

getrawtransaction

获取指定裸交易

• 请求参数

1.TXID：要提取裸交易的交易ID
2.Format：返回格式，序列化字符串或JSON对象，false：返回序列化字符串（默认为false），true：返回解码后的JSON对象

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 getrawtransaction 1ce113d2e3c6882940db81402f4647518b30d1b5059280369b57d7e9d07b2b7a true

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawtransaction", "params": ["1ce113d2e3c6882940db81402f4647518b30d1b5059280369b57d7e9d07b2b7a",true] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

当参数Format的值为true时，返回的交易对象结构如下：
1.hex：序列化字符串
2.blockhash：所在区块的哈希值
3.confirmations：所在区块的确认数
4.time：所在区块的出块时间
5.blocktime：所在区块的出块时间，同上

decoderawtransaction

解码裸交易

• 请求参数

1.SerializedTransaction：要解码的裸交易字符串

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 decoderawtransaction 020000000001015c8d9852cd745aa71e6ff971a402e04a8cf303bf24d7962588758910f00610f20000000017160014e8c474ac01c222237396830fa803cbc56c81e6f7feffffff0200ca9a3b0000000017a914bc072b6c18bf66e411e4e292ade233f8a74153948784216bee0000000017a9147d03cb0b61a56e6e99bb79da11457e7274081ff68702473044022075456d4e6cfb1153f2350e06bb1c91433bbe109ed0bd9dd0403fab5948cc50b002205835a0b22fec9e59946e4141a253c06c8b34b49bce84adde5bcc7f119d0749d3012102329cb9c5091882cef27992561161162917af847b2195d07c178fbe8a64c128df67000000

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decoderawtransaction", "params": ["020000000001015c8d9852cd745aa71e6ff971a402e04a8cf303bf24d7962588758910f00610f20000000017160014e8c474ac01c222237396830fa803cbc56c81e6f7feffffff0200ca9a3b0000000017a914bc072b6c18bf66e411e4e292ade233f8a74153948784216bee0000000017a9147d03cb0b61a56e6e99bb79da11457e7274081ff68702473044022075456d4e6cfb1153f2350e06bb1c91433bbe109ed0bd9dd0403fab5948cc50b002205835a0b22fec9e59946e4141a253c06c8b34b49bce84adde5bcc7f119d0749d3012102329cb9c5091882cef27992561161162917af847b2195d07c178fbe8a64c128df67000000"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

成功解码后，decoderawtransaction返回一个JSON对象，否则返回null

getnewaddress

获取新地址

• 请求参数

1.Account：新地址所属账户，可选，默认值：""
2.AddressType：地址类型，可以是legacy、p2sh-segwit和bech32，可以 使用-addresstype设置默认地址类型

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 getnewaddress test 
QgjwzncVc5MrSFnyoWxYi66zf9h1vxaXPG

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnewaddress", "params": ["test2"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/
{"result":"QdkBjWvoYgn158ew4GWhWBvMpCmA6TK6zn","error":null,"id":"curltest"}

• 返回参数

1.getnewaddress：返回一个新的地址

getbalance

查看钱包中全部bsv可用余额

• 请求参数

Confirmations: 可计入余额的UTXO所需要的最小确认数，可选，默认值：6
WatchOnlyIncl: 是否包含那些仅用于监测的地址，可选，默认值：true

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 getbalance

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回示例

1.返回以ltc为单位的钱包总余额

listaddressgroupings

显示bsv钱包中所有地址余额

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 listaddressgroupings

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressgroupings", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

1.Address：地址
2.Balance：地址余额，不包含未确认收入
3.Account：地址关联的账户

sendtoaddress

发送金额至指定地址

• 请求参数

1.ToAddress：接收地址
2.Amount：发送的比特币数量
3.Comment：备注文本，可选
4.CommentTo：备注接收人，可选
5.AutoFeeSubtract：是否自动扣除手续费，默认值：false

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 sendtoaddress QdkBjWvoYgn158ew4GWhWBvMpCmA6TK6zn 5
6ec4adbcdcd1a01d3e1a70ac17e937a189858730db36505b0d96ce73f0d067cc

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendtoaddress", "params": ["QdkBjWvoYgn158ew4GWhWBvMpCmA6TK6zn",10] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/
{"result":"1ce113d2e3c6882940db81402f4647518b30d1b5059280369b57d7e9d07b2b7a","error":null,"id":"curltest"}

• 返回参数

返回该笔交易ID

gettransaction

获取钱包内交易的详细信息

• 请求参数

TXID：要查看详情的交易ID
WatchOnlyIncl：是否包含watch-only地址

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 gettransaction 6ec4adbcdcd1a01d3e1a70ac17e937a189858730db36505b0d96ce73f0d067cc

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction", "params": ["1ce113d2e3c6882940db81402f4647518b30d1b5059280369b57d7e9d07b2b7a"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

1.amount：交易金额，正数表示该交易增加钱包余额，负数表示该交易减少钱包余额
2.fee：交易手续费，仅针对转出交易
3.confirmations：交易确认数，0表示未确认，-1表示存在冲突
4.generated：币基交易则该值为true
5.blockhash：交易所在区块的哈希
6.blockindex：交易所在区块的编号
7.blocktime：交易所在区块的unix时间
8.txid：交易ID
9.walletconflicts：冲突交易数组，成员为冲突交易的ID
10.timereceived：节点收到交易的unix时间
11.bip125-replacable：是否可替换交易
12.comment： 保存在钱包中的交易备注，
13.to：保存在钱包中的交易目标备注
14.details：输入输出详情数组，包括：send，receive，amount，fee
15.hex：串行序列化字符串

listreceivedbyaddress

获取各地址收到的莱特币数量

• 请求参数

Confirmations：计入统计结果的交易所需的最小确认数，默认值：1
IncludeEmpty：是否包含从未有收入的账户，可选，默认值：false
IncludeWatchOnly：是否包含watch-only地址，可选，默认值：false，详情可参见importaddress

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 listreceivedbyaddress 6 true true QdkBjWvoYgn158ew4GWhWBvMpCmA6TK6zn

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaddress", "params": [6,true,true,"QdkBjWvoYgn158ew4GWhWBvMpCmA6TK6zn"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/（被检测地址，）

• 返回参数

1.nvolvesWatchOnly：是否是watch-only地址
2.address：地址
3.account：关联账户
4.amount：收到比特币总数量
5.confirmations：该地址最后一个交易的确认数
6.label：地址关联的账户
7.txids：向该地址支付过的交易数组，成员为交易ID

settxfee

settxfee 为钱包设置每kB的交易费用，将覆盖全局的-paytxfee命令行参数

• 请求参数

1.FeePerKB：每千字节的手续费
注意：LTC节点的手续费不能低于钱包最小费用(0.00010000 LTC/kB)

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 settxfee 0.0001

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "settxfee", "params": ["0.0002"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

1.调用在成功时返回true。

dumpwallet

导出钱包文件为文本

• 请求参数

1.Filename：带有路径的文件名

• 请求示例

litecoin-cli -rpcuser=admin -rpcpassword=123456 -rpcport=19443 dumpwallet /opt/wallet.txt

curl --user admin:123456 --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpwallet", "params": ["/opt/wallet.txt"] }' -H 'content-type: text/plain;' http://127.0.0.1:19443/

• 返回参数

返回带有完整绝对路径的文件名