比特币RPC API中文文档

比特币节点提供了基于JSON RPC的二次开发接口,可供应用开发者使用 各种开发语言例如JavaScript、Java、C#、Php、Python等访问比特币的功能, 是在应用中集成比特币支付能力的理想实现途径。

比特币JSON RPC API中文文档 由汇智网基于比特币核心项目的官网资料翻译整理而成,转载请标明出处。

API目录

区块链相关API:

  • GetBestBlockHash: 返回最优链上最近区块的哈希
  • GetBlock: 返回具有指定哈希的区块
  • GetBlockChainInfo: 返回区块链当前状态信息
  • GetBlockCount: 返回本地最优链上的区块数量
  • GetBlockHash: 返回本地最有区块链上指定高度区块的哈希
  • GetBlockHeader: 返回指定区块头
  • GetChainTips: 返回每个本地区块链的最高位区块(tip)信息
  • GetDifficulty: 返回POW难度
  • GetMemPoolAncestors: 返回交易池内指定交易的所有祖先
  • GetMemPoolDescendants: 返回交易池内指定交易的所有后代
  • GetMemPoolEntry: 返回交易池内指定交易的池数据
  • GetMemPoolInfo: 返回交易池信息
  • GetRawMemPool: 返回交易池内的所有交易
  • GetTxOut: 返回指定交易输出的详细信息
  • GetTxOutProof: 返回一个或多个交易的证明数据
  • GetTxOutSetInfo: 返回UTXO集合的统计信息
  • PreciousBlock:
  • PruneBlockChain: 对区块链执行剪枝操作
  • VerifyChain: 验证本地区块链的每个记录
  • VerifyTxOutProof: 验证交易输出证明

节点控制API:

  • GetInfo: 返回节点和网络信息
  • Help: 返回所有可用的RPC命令,或返回指定命令的帮助信息
  • Stop: 安全关闭bitcoin core的节点服务

出块相关API:

  • Generate: 生成区块
  • GenerateToAddress: 生成区块并将新生成的比特币转入指定地址

挖矿相关API:

  • GetBlockTemplate: 返回节点模板
  • GetMiningInfo: 返回挖矿相关信息
  • GetNetworkHashPS: 返回估算的全网哈希速率
  • PrioritiseTransaction: 交易优先权

网络相关API:

  • AddNode: 添加节点
  • ClearBanned: 清理禁止的节点
  • DisconnectNode: 断开与指定节点旳连接
  • GetAddedNodeInfo: 返回新增节点的信息
  • GetConnectionCount: 返回与其他节点旳连接总数量
  • GetNetTotals: 返回网络流量统计信息
  • GetNetworkInfo: 返回节点的网络连接信息
  • GetPeerInfo: 返回所连接其他节点旳信息
  • ListBanned: 返回所有被禁止的IP或子网
  • Ping: 向所有连接的节点发送p2p的pin报文
  • SetBan: 管理禁止访问清单
  • SetNetworkActive: 禁止/启用P2P网络

裸交易相关API:

  • CreateRawTransaction: 创建未签名的序列化交易
  • FundRawTransaction: 向裸交易添加新的UTXO
  • DecodeRawTransaction: 解码指定的裸交易
  • DecodeScript: 解码指定的P2SH赎回脚本
  • GetRawTransaction: 返回指定的裸交易
  • SendRawTransaction: 验证并发送裸交易到P2P网络
  • SignRawTransaction: 签名裸交易

工具类API:

  • CreateMultiSig: 创建P2SH多重签名地址
  • EstimateFee: 估算交易费率
  • EstimatePriority: 估算交易的优先级
  • GetMemoryInfo: 返回内存使用情况
  • ValidateAddress: 验证指定的地址
  • VerifyMessage: 验证签名的消息

钱包相关API:

  • AbandonTransaction: 放弃指定交易
  • AddWitnessAddress: 添加见证地址
  • AddMultiSigAddress: 添加P2SH多重签名地址
  • BackupWallet: 备份钱包
  • BumpFee: 替换未确认交易并提升手续费
  • DumpPrivKey: 导出指定私钥
  • DumpWallet: 导出钱包
  • EncryptWallet: 加密钱包
  • GetAccountAddress: 返回指定账户的当前地址
  • GetAccount: 返回指定地址关联的账户
  • GetAddressesByAccount: 按账户分组列出地址
  • GetBalance: 返回钱包账户余额
  • GetNewAddress: 返回一个新的地址用于接收支付
  • GetRawChangeAddress: 返回新的找零地址
  • GetReceivedByAccount: 返回指定账户的收入情况
  • GetReceivedByAddress: 返回指定地址的收入情况
  • GetTransaction: 返回指定的钱包交易的详情
  • GetUnconfirmedBalance: 返回钱包全部未确认收入总额
  • GetWalletInfo: 返回钱包信息
  • ImportAddress: 导入地址或公钥脚本
  • ImportMulti: 导入多个地址或公钥脚本
  • ImportPrunedFunds:
  • ImportPrivKey: 导入私钥
  • ImportWallet: 导入钱包
  • KeyPoolRefill: 密钥池填充
  • ListAccounts: 返回钱包内账户及对应余额
  • ListAddressGroupings: 按地址列出余额
  • ListLockUnspent: 列出锁定的UTXO
  • ListReceivedByAccount: 按账户列出收到的比特币
  • ListReceivedByAddress: 列地址列出收到的比特币
  • ListSinceBlock: 列出指定区块之后发生的与钱包有关的交易
  • ListTransactions: 列出最近指定数量的与钱包有关的交易
  • ListUnspent: 返回钱包内的UTXO
  • LockUnspent: 暂时性锁定/解锁指定的UTXO
  • Move: 链下转账
  • RemovePrunedFunds:
  • SendFrom: 使用指定的本地账户向指定的比特币地址转账
  • SendMany: 创建并广播一个包含多个输出的交易
  • SendToAddress: 向指定地址发送比特币
  • SetAccount: 将指定地址与账户关联
  • SetTxFee: 设置千字节交易费率
  • SignMessage: 签名消息
  • SignMessageWithPrivKey: 使用指定私钥签名消息
  • WalletLock: 锁定钱包
  • WalletPassphrase: 输入钱包口令
  • WalletPassphraseChange: 修改钱包口令

比特币节点提供了基于JSON RPC的二次开发接口,可供应用开发者使用 各种开发语言例如JavaScript、Java、C#、Php、Python等访问比特币的功能, 是在应用中集成比特币支付能力的理想实现途径。

比特币JSON RPC API中文文档 由汇智网基于比特币核心项目的官网资料翻译整理而成,转载请标明出处。

API目录

区块链相关API:

  • GetBestBlockHash: 返回最优链上最近区块的哈希
  • GetBlock: 返回具有指定哈希的区块
  • GetBlockChainInfo: 返回区块链当前状态信息
  • GetBlockCount: 返回本地最优链上的区块数量
  • GetBlockHash: 返回本地最有区块链上指定高度区块的哈希
  • GetBlockHeader: 返回指定区块头
  • GetChainTips: 返回每个本地区块链的最高位区块(tip)信息
  • GetDifficulty: 返回POW难度
  • GetMemPoolAncestors: 返回交易池内指定交易的所有祖先
  • GetMemPoolDescendants: 返回交易池内指定交易的所有后代
  • GetMemPoolEntry: 返回交易池内指定交易的池数据
  • GetMemPoolInfo: 返回交易池信息
  • GetRawMemPool: 返回交易池内的所有交易
  • GetTxOut: 返回指定交易输出的详细信息
  • GetTxOutProof: 返回一个或多个交易的证明数据
  • GetTxOutSetInfo: 返回UTXO集合的统计信息
  • PreciousBlock:
  • PruneBlockChain: 对区块链执行剪枝操作
  • VerifyChain: 验证本地区块链的每个记录
  • VerifyTxOutProof: 验证交易输出证明

节点控制API:

  • GetInfo: 返回节点和网络信息
  • Help: 返回所有可用的RPC命令,或返回指定命令的帮助信息
  • Stop: 安全关闭bitcoin core的节点服务

出块相关API:

  • Generate: 生成区块
  • GenerateToAddress: 生成区块并将新生成的比特币转入指定地址

挖矿相关API:

  • GetBlockTemplate: 返回节点模板
  • GetMiningInfo: 返回挖矿相关信息
  • GetNetworkHashPS: 返回估算的全网哈希速率
  • PrioritiseTransaction: 交易优先权

网络相关API:

  • AddNode: 添加节点
  • ClearBanned: 清理禁止的节点
  • DisconnectNode: 断开与指定节点旳连接
  • GetAddedNodeInfo: 返回新增节点的信息
  • GetConnectionCount: 返回与其他节点旳连接总数量
  • GetNetTotals: 返回网络流量统计信息
  • GetNetworkInfo: 返回节点的网络连接信息
  • GetPeerInfo: 返回所连接其他节点旳信息
  • ListBanned: 返回所有被禁止的IP或子网
  • Ping: 向所有连接的节点发送p2p的pin报文
  • SetBan: 管理禁止访问清单
  • SetNetworkActive: 禁止/启用P2P网络

裸交易相关API:

  • CreateRawTransaction: 创建未签名的序列化交易
  • FundRawTransaction: 向裸交易添加新的UTXO
  • DecodeRawTransaction: 解码指定的裸交易
  • DecodeScript: 解码指定的P2SH赎回脚本
  • GetRawTransaction: 返回指定的裸交易
  • SendRawTransaction: 验证并发送裸交易到P2P网络
  • SignRawTransaction: 签名裸交易

工具类API:

  • CreateMultiSig: 创建P2SH多重签名地址
  • EstimateFee: 估算交易费率
  • EstimatePriority: 估算交易的优先级
  • GetMemoryInfo: 返回内存使用情况
  • ValidateAddress: 验证指定的地址
  • VerifyMessage: 验证签名的消息

钱包相关API:

  • AbandonTransaction: 放弃指定交易
  • AddWitnessAddress: 添加见证地址
  • AddMultiSigAddress: 添加P2SH多重签名地址
  • BackupWallet: 备份钱包
  • BumpFee: 替换未确认交易并提升手续费
  • DumpPrivKey: 导出指定私钥
  • DumpWallet: 导出钱包
  • EncryptWallet: 加密钱包
  • GetAccountAddress: 返回指定账户的当前地址
  • GetAccount: 返回指定地址关联的账户
  • GetAddressesByAccount: 按账户分组列出地址
  • GetBalance: 返回钱包账户余额
  • GetNewAddress: 返回一个新的地址用于接收支付
  • GetRawChangeAddress: 返回新的找零地址
  • GetReceivedByAccount: 返回指定账户的收入情况
  • GetReceivedByAddress: 返回指定地址的收入情况
  • GetTransaction: 返回指定的钱包交易的详情
  • GetUnconfirmedBalance: 返回钱包全部未确认收入总额
  • GetWalletInfo: 返回钱包信息
  • ImportAddress: 导入地址或公钥脚本
  • ImportMulti: 导入多个地址或公钥脚本
  • ImportPrunedFunds:
  • ImportPrivKey: 导入私钥
  • ImportWallet: 导入钱包
  • KeyPoolRefill: 密钥池填充
  • ListAccounts: 返回钱包内账户及对应余额
  • ListAddressGroupings: 按地址列出余额
  • ListLockUnspent: 列出锁定的UTXO
  • ListReceivedByAccount: 按账户列出收到的比特币
  • ListReceivedByAddress: 列地址列出收到的比特币
  • ListSinceBlock: 列出指定区块之后发生的与钱包有关的交易
  • ListTransactions: 列出最近指定数量的与钱包有关的交易
  • ListUnspent: 返回钱包内的UTXO
  • LockUnspent: 暂时性锁定/解锁指定的UTXO
  • Move: 链下转账
  • RemovePrunedFunds:
  • SendFrom: 使用指定的本地账户向指定的比特币地址转账
  • SendMany: 创建并广播一个包含多个输出的交易
  • SendToAddress: 向指定地址发送比特币
  • SetAccount: 将指定地址与账户关联
  • SetTxFee: 设置千字节交易费率
  • SignMessage: 签名消息
  • SignMessageWithPrivKey: 使用指定私钥签名消息
  • WalletLock: 锁定钱包
  • WalletPassphrase: 输入钱包口令
  • WalletPassphraseChange: 修改钱包口令

======================================================================

分享一个交互式的在线编程实战, php比特币开发教程,本课程面向初学者,内容即涵盖比特币的核心概念,例如区块链存储、去中心化共识机制、密钥与脚本、交易与UTXO等,同时也详细讲解如何在Php代码中集成比特币支持功能,例如创建地址、管理钱包、构造裸交易等,是Php工程师不可多得的比特币开发学习课程。

  • EOS教程,本课程帮助你快速入门EOS区块链去中心化应用的开发,内容涵盖EOS工具链、账户与钱包、发行代币、智能合约开发与部署、使用代码与智能合约交互等核心知识点,最后综合运用各知识点完成一个便签DApp的开发。
  • web3j教程,主要是针对java和android程序员进行区块链以太坊开发的web3j详解。
  • 以太坊教程,主要介绍智能合约与dapp应用开发,适合入门。
  • 以太坊开发,主要是介绍使用node.js、mongodb、区块链、ipfs实现去中心化电商DApp实战,适合进阶。
  • python以太坊,主要是针对python工程师使用web3.py进行区块链以太坊开发的详解。
  • php以太坊,主要是介绍使用php进行智能合约开发交互,进行账号创建、交易、转账、代币开发以及过滤器和事件等内容。
  • C#以太坊,主要讲解如何使用C#开发基于.Net的以太坊应用,包括账户管理、状态与交易、智能合约开发与交互、过滤器和事件等。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容