跳转至

java-tron gRPC API

java-tron 节点对外提供 gRPC 接口。本目录按业务分类列出 82 个常用 gRPC 方法的简要文档。

服务与默认端口

服务 默认端口 说明 源码
protocol.Wallet 50051 FullNode 全功能服务(含写交易) framework/src/main/java/org/tron/core/services/RpcApiService.java
FullNode 上的 protocol.WalletSolidity 50061 已固化数据的只读视图,启用 node.rpc.solidityEnable 后可用 framework/src/main/java/org/tron/core/services/interfaceOnSolidity/RpcApiServiceOnSolidity.java
独立 SolidityNode 上的 protocol.WalletSolidity 50051 在节点的主 gRPC 端口提供只读服务 framework/src/main/java/org/tron/core/services/RpcApiService.java

主 gRPC 端口由 node.rpc.port 配置(默认 50051)。FullNode 启用额外的固化数据视图后,使用 node.rpc.solidityPort(默认 50061);独立 SolidityNode 则在 node.rpc.port 上提供 WalletSolidity 服务。参见节点配置。

proto 定义位于 protocol/src/main/protos/api/api.proto。

调用方式

gRPC 通过 protobuf 服务名区分 Wallet 和 WalletSolidity,端口取决于节点运行模式和配置:

# Wallet
grpc://<host>:50051   protocol.Wallet/<Method>

# FullNode 上的 WalletSolidity(只读;node.rpc.solidityEnable=true)
grpc://<host>:50061   protocol.WalletSolidity/<Method>

# 独立 SolidityNode 上的 WalletSolidity(只读)
grpc://<host>:50051   protocol.WalletSolidity/<Method>

每个方法文档包含:

  • 方法名(一级标题,PascalCase,与 proto 完全一致)
  • 功能描述
  • 服务支持情况(Wallet / WalletSolidity / 二者皆支持)
  • 对应 protobuf 签名

账户

方法 描述
GetAccount 按地址查询账户
GetAccountBalance 查询账户在指定区块的余额
GetAccountNet 查询账户带宽资源
GetAccountResource 查询账户带宽+能量+TronPower
CreateAccount2 构造创建账户的交易;执行时会额外收取由 getCreateNewAccountFeeInSystemContract 决定的账户创建费用(当前主网值为 1,000,000 sun,即 1 TRX)。
UpdateAccount2 修改账户名
AccountPermissionUpdate 配置多签权限

区块 / 交易查询

方法 描述
GetNowBlock2 当前最新区块
GetBlock 通用区块查询(按 num/hash)
GetBlockByNum2 按高度查询区块
GetBlockById 按 hash 查询区块
GetBlockByLimitNext2 按区间查询区块
GetBlockByLatestNum2 查询最近 N 个区块
GetBlockBalanceTrace 查询区块的账户余额变更
GetTransactionCountByBlockNum 区块内交易数
GetTransactionById 按 txid 查询交易
GetTransactionInfoById 按 txid 查询交易回执
GetTransactionInfoByBlockNum 按区块查询交易回执
GetPendingSize 待打包交易池大小
GetTransactionFromPending 查询单条 pending 交易
GetTransactionListFromPending 全部 pending 交易 ID

交易构造 / 广播

方法 描述
CreateTransaction2 构造 TRX 转账交易
GetTransactionSignWeight 查询多签当前权重
GetTransactionApprovedList 所有签名验证通过后,返回签名地址列表
BroadcastTransaction 广播签名后的 protobuf Transaction

TRC-10 资产

方法 描述
CreateAssetIssue2 发行 TRC-10 通证
UpdateAsset2 修改 TRC-10 描述/URL/限额
TransferAsset2 转账 TRC-10
ParticipateAssetIssue2 参与 TRC-10 募资
UnfreezeAsset2 解锁发行方冻结的 TRC-10
GetAssetIssueById 按 id 查询 TRC-10(推荐)
GetAssetIssueByName 按名查询 TRC-10(重名报错)
GetAssetIssueListByName 同名 TRC-10 列表
GetAssetIssueByAccount 账户发行的 TRC-10
GetAssetIssueList 全网 TRC-10 列表
GetPaginatedAssetIssueList 分页 TRC-10 列表

智能合约

方法 描述
DeployContract 部署合约
TriggerContract 触发合约(写)
TriggerConstantContract 只读调用合约
EstimateEnergy 预估调用能量消耗
GetContract 查询合约元信息
GetContractInfo 查询合约完整运行信息
ClearContractABI 清空合约 ABI
UpdateSetting 修改用户能量百分比
UpdateEnergyLimit 修改部署者能量上限

超级代表 / 治理

方法 描述
CreateWitness2 申请成为 SR 候选人
UpdateWitness2 修改 SR URL
ListWitnesses 所有 SR 候选人列表
GetPaginatedNowWitnessList 分页 SR 列表
VoteWitnessAccount2 给 SR 投票
GetBrokerageInfo SR 当前佣金比例
UpdateBrokerage SR 修改佣金
GetRewardInfo 查询账户可领取的奖励总额,单位为 sun。
WithdrawBalance2 提取出块奖励/分红
ProposalCreate 创建链参数提案
ProposalApprove SR 对提案投票
ProposalDelete 撤销自己的提案
ListProposals 提案列表
GetProposalById 按 ID 查询提案
GetPaginatedProposalList 分页提案列表
GetChainParameters 链参数当前值
GetNextMaintenanceTime 下次维护期时间

质押 1.0(仅保留解冻与查询)

提案 #70 UNFREEZE_DELAY_DAYS 通过后(主网已生效),新的 V1 冻结会被链拒绝;解冻与查询方法保留,用于处理存量仓位。

文件名末尾的 2(如 FreezeBalance2)是 proto 历史命名后缀(返回 TransactionExtention 的 V1 方法),与质押 2.0 的 FreezeBalanceV2 不是同一个方法。

方法 描述
FreezeBalance2 冻结 TRX 获取资源(V1,链已拒绝新请求)
UnfreezeBalance2 解冻已到期资源(V1,仍可用于存量解冻)
GetDelegatedResource 查询代理记录(V1,只读)
GetDelegatedResourceAccountIndex 查询代理对手地址(V1,只读)

质押 2.0

方法 描述
FreezeBalanceV2 冻结 TRX 获取资源
UnfreezeBalanceV2 发起解冻;等待期由 UNFREEZE_DELAY_DAYS 决定(当前主网值为 14 天)。
WithdrawExpireUnfreeze 提取已到期解冻
CancelAllUnfreezeV2 取消所有未到期解冻
DelegateResource 资源代理给他人
UnDelegateResource 撤销资源代理
GetDelegatedResourceV2 查询代理记录
GetDelegatedResourceAccountIndexV2 查询代理对手地址
GetCanDelegatedMaxSize 当前可代理上限
GetAvailableUnfreezeCount 剩余可解冻次数
GetCanWithdrawUnfreezeAmount 指定时间可提取金额

节点 / 价格 / 工具

方法 描述
GetNodeInfo 节点状态
ListNodes 已知对等节点
GetEnergyPrices 能量历史单价
GetBandwidthPrices 带宽历史单价
GetBurnTrx 累计销毁 TRX