diff --git a/docs/api/index.md b/docs/api/index.md index 43e8f38e..bce3a190 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -22,3 +22,4 @@ java-tron 节点对外暴露三套 API。它们底层能力大体一致，区别 - [HTTP 接口参考](http/index.md) —— `/wallet/*` 与 `/walletsolidity/*`（部分支持）下的端点，按功能模块组织 - [JSON-RPC 接口参考](json-rpc/index.md) —— `eth_*` / `net_*` / `web3_*` 方法以及 Tron 专属的 `buildTransaction`，按功能模块组织 - [gRPC 接口参考](rpc/index.md) —— `protocol.Wallet` / `protocol.WalletSolidity`（部分支持）方法，按功能模块组织 +- [机器可读 API 定义](interface-definitions.md) —— HTTP 的 OpenAPI 定义以及 JSON-RPC 的 OpenRPC 定义 diff --git a/docs/api/interface-definitions.md b/docs/api/interface-definitions.md new file mode 100644 index 00000000..669719fe --- /dev/null +++ b/docs/api/interface-definitions.md @@ -0,0 +1,17 @@ +# 机器可读 API 定义 + +本仓库发布机器可读 API 定义，便于工具集成、SDK 生成和 AI agent 使用： + +| API 类型 | 格式 | 文件 | +|---|---|---| +| HTTP API | OpenAPI 3.1 | [`openapi.yaml`](openapi.yaml) | +| JSON-RPC API | OpenRPC 1.2.6 | [`openrpc.json`](openrpc.json) | + +每个接口对应的片段也会保留，方便审阅： + +| API 类型 | 片段目录 | +|---|---| +| HTTP API | [`specs/http/`](https://github.com/tronprotocol/documentation-zh/tree/master/docs/api/specs/http) | +| JSON-RPC API | [`specs/json-rpc/`](https://github.com/tronprotocol/documentation-zh/tree/master/docs/api/specs/json-rpc) | + +发布的定义来自 java-tron API 行为，并附带指向相应人类可读 API 文档的链接。顶层 `openapi.yaml` 和 `openrpc.json` 由各接口片段汇总生成，方便工具直接消费一个标准文件。 diff --git a/docs/api/openapi.yaml b/docs/api/openapi.yaml new file mode 100644 index 00000000..67b9a331 --- /dev/null +++ b/docs/api/openapi.yaml @@ -0,0 +1,10419 @@ +"openapi": "3.1.0" +"info": + "title": "java-tron HTTP API" + "version": "1.0.0" + "description": "Machine-readable definition generated from java-tron source code, with human-facing metadata linked to the markdown API documentation." + "x-java-tron-source": + "repo": "tronprotocol/java-tron" + "commit": "a79693e4508c05650cc474f23e7f97451d2861ec" + "version": "GreatVoyage-v4.8.1.1" +"servers": + - + "url": "https://nile.trongrid.io" + "description": "Nile testnet TronGrid" + - + "url": "http://127.0.0.1:8090" + "description": "Local FullNode HTTP API" +"tags": + - + "name": "Account" + "description": "Account lookup and account resource query endpoints." + - + "name": "Block / transaction query" + "description": "Block, transaction, and transaction-info query endpoints." + - + "name": "Transaction build / broadcast" + "description": "Transaction creation, signing, permission, and broadcast endpoints." + - + "name": "TRC10 asset" + "description": "TRC10 asset issuance and asset query endpoints." + - + "name": "Smart contract" + "description": "Smart contract deployment, trigger, and contract metadata endpoints." + - + "name": "Witness / governance" + "description": "Witness, brokerage, reward, proposal, and governance endpoints." + - + "name": "Stake 1.0 (unfreeze and query only)" + "description": "Stake 1.0 unfreeze and related query endpoints." + - + "name": "Stake 2.0" + "description": "Stake 2.0 resource delegation, unfreeze, and withdrawal endpoints." + - + "name": "Node / pricing / tools" + "description": "Node status, chain pricing, and utility endpoints." +"paths": + "/wallet/getaccount": + "get": + "tags": + - "Account" + "summary": "Query an account by address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccount.md` for examples and detailed behavior." + "operationId": "wallet_getaccount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Account" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getaccount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAccountOnSolidityServlet" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "post": + "tags": + - "Account" + "summary": "Query an account by address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccount.md` for examples and detailed behavior." + "operationId": "wallet_getaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Account" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getaccount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAccountOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountRequest" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "/wallet/getaccountbalance": + "post": + "tags": + - "Account" + "summary": "Query an account's balance at a specific block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountbalance.md` for examples and detailed behavior." + "operationId": "wallet_getaccountbalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountbalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountBalanceResponse" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/AccountBalanceRequestRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountBalanceServlet.java" + - "protocol/src/main/protos/core/contract/balance_contract.proto#AccountBalanceRequest" + "/wallet/getaccountnet": + "get": + "tags": + - "Account" + "summary": "Query an account's bandwidth resources" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountnet.md` for examples and detailed behavior." + "operationId": "wallet_getaccountnet_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountnet.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountNetMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountNetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountNetServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "post": + "tags": + - "Account" + "summary": "Query an account's bandwidth resources" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountnet.md` for examples and detailed behavior." + "operationId": "wallet_getaccountnet_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountnet.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountNetMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountNetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountRequest" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountNetServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "/wallet/getaccountresource": + "get": + "tags": + - "Account" + "summary": "Query bandwidth + energy + TronPower" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountresource.md` for examples and detailed behavior." + "operationId": "wallet_getaccountresource_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountResourceMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Account" + "summary": "Query bandwidth + energy + TronPower" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountresource.md` for examples and detailed behavior." + "operationId": "wallet_getaccountresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountResourceMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountResourceServlet.java" + "/wallet/createaccount": + "post": + "tags": + - "Account" + "summary": "Create an on-chain account (costs 1 TRX)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/createaccount.md` for examples and detailed behavior." + "operationId": "wallet_createaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/createaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CreateAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountCreateContractRequest" + "required": + - "owner_address" + - "account_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/CreateAccountActuator.java#validate" + - "protocol/src/main/protos/core/contract/account_contract.proto#AccountCreateContract" + "/wallet/updateaccount": + "post": + "tags": + - "Account" + "summary": "Update an account's name" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/updateaccount.md` for examples and detailed behavior." + "operationId": "wallet_updateaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/updateaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountUpdateContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateAccountActuator.java#validate" + - "protocol/src/main/protos/core/contract/account_contract.proto#AccountUpdateContract" + "/wallet/accountpermissionupdate": + "post": + "tags": + - "Account" + "summary": "Configure multi-sig permissions" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/accountpermissionupdate.md` for examples and detailed behavior." + "operationId": "wallet_accountpermissionupdate_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/accountpermissionupdate.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "AccountPermissionUpdateServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountPermissionUpdateContractRequest" + "required": + - "owner_address" + - "owner" + - "actives" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/AccountPermissionUpdateActuator.java#validate" + - "protocol/src/main/protos/core/contract/account_contract.proto#AccountPermissionUpdateContract" + "/wallet/validateaddress": + "get": + "tags": + - "Account" + "summary": "Validate an address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/validateaddress.md` for examples and detailed behavior." + "operationId": "wallet_validateaddress_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/validateaddress.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "message": + "type": "string" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ValidateAddressServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ValidateAddressServlet.java" + "post": + "tags": + - "Account" + "summary": "Validate an address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/validateaddress.md` for examples and detailed behavior." + "operationId": "wallet_validateaddress_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/validateaddress.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "message": + "type": "string" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ValidateAddressServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ValidateAddressServlet.java" + "/wallet/getnowblock": + "get": + "tags": + - "Block / transaction query" + "summary": "Latest block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getnowblock.md` for examples and detailed behavior." + "operationId": "wallet_getnowblock_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getnowblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNowBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnowblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNowBlockOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNowBlockServlet.java" + "post": + "tags": + - "Block / transaction query" + "summary": "Latest block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getnowblock.md` for examples and detailed behavior." + "operationId": "wallet_getnowblock_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getnowblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNowBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnowblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNowBlockOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNowBlockServlet.java" + "/wallet/getblock": + "get": + "tags": + - "Block / transaction query" + "summary": "Generic block query (by num or hash)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblock.md` for examples and detailed behavior." + "operationId": "wallet_getblock_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockOnSolidityServlet" + "parameters": + - + "name": "id_or_num" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Block id or block number." + "x-source-derived": true + - + "name": "detail" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "Whether to return detailed block information." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockServlet.java" + - "protocol/src/main/protos/api/api.proto#BlockReq" + "post": + "tags": + - "Block / transaction query" + "summary": "Generic block query (by num or hash)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblock.md` for examples and detailed behavior." + "operationId": "wallet_getblock_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/BlockReqRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockServlet.java" + - "protocol/src/main/protos/api/api.proto#BlockReq" + "/wallet/getblockbynum": + "get": + "tags": + - "Block / transaction query" + "summary": "Block by height" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbynum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbynum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbynum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbynum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": false + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Block by height" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbynum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbynum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbynum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbynum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/NumberMessageRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "/wallet/getblockbyid": + "get": + "tags": + - "Block / transaction query" + "summary": "Block by hash" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbyid.md` for examples and detailed behavior." + "operationId": "wallet_getblockbyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Block by hash" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbyid.md` for examples and detailed behavior." + "operationId": "wallet_getblockbyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/getblockbylimitnext": + "get": + "tags": + - "Block / transaction query" + "summary": "Blocks in a range" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylimitnext.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylimitnext_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylimitnext.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLimitNextServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylimitnext" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLimitNextOnSolidityServlet" + "parameters": + - + "name": "startNum" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Starting block number for the query range." + "x-source-derived": true + - + "name": "endNum" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Ending block number for the query range." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "Blocks in a range" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylimitnext.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylimitnext_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylimitnext.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLimitNextServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylimitnext" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLimitNextOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BlockLimitRequest" + "required": + - "endNum" + - "startNum" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByLimitNextServlet.java" + - "protocol/src/main/protos/api/api.proto#BlockLimit" + "/wallet/getblockbylatestnum": + "get": + "tags": + - "Block / transaction query" + "summary": "The most recent N blocks" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylatestnum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylatestnum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylatestnum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLatestNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylatestnum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLatestNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "The most recent N blocks" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylatestnum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylatestnum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylatestnum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLatestNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylatestnum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLatestNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/NumberMessageRequest" + "required": + - "num" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByLatestNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "/wallet/getblockbalance": + "post": + "tags": + - "Block / transaction query" + "summary": "Per-account balance changes within a block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbalance.md` for examples and detailed behavior." + "operationId": "wallet_getblockbalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockBalanceTrace" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/BlockIdentifierRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockBalanceServlet.java" + - "protocol/src/main/protos/core/contract/balance_contract.proto#BlockIdentifier" + "/wallet/gettransactioncountbyblocknum": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction count in a block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioncountbyblocknum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "count": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GettransactioncountbyblocknumGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionCountByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioncountbyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionCountByBlockNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionCountByBlockNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction count in a block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioncountbyblocknum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "count": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GettransactioncountbyblocknumPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionCountByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioncountbyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionCountByBlockNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/NumberMessageRequest" + "required": + - "num" + "/wallet/gettransactionbyid": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionbyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionbyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactionbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionbyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionbyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactionbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/gettransactioninfobyid": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction receipt by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction receipt by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/gettransactioninfobyblocknum": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction receipts by block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyblocknum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionInfo" + "x-java-response": "Array of TransactionInfo rendered by printTransactionInfoList" + "title": "GettransactioninfobyblocknumGetResultArray1" + - + "type": "object" + "additionalProperties": false + "maxProperties": 0 + "x-java-response": "Empty object returned when num is not positive" + "title": "GettransactioninfobyblocknumGetResultEmpty2" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByBlockNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByBlockNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction receipts by block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyblocknum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionInfo" + "x-java-response": "Array of TransactionInfo rendered by printTransactionInfoList" + "title": "GettransactioninfobyblocknumPostResultArray1" + - + "type": "object" + "additionalProperties": false + "maxProperties": 0 + "x-java-response": "Empty object returned when num is not positive" + "title": "GettransactioninfobyblocknumPostResultEmpty2" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByBlockNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/NumberMessageRequest" + "required": + - "num" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByBlockNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "/wallet/getpendingsize": + "get": + "tags": + - "Block / transaction query" + "summary": "Pending pool size" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getpendingsize.md` for examples and detailed behavior." + "operationId": "wallet_getpendingsize_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getpendingsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "pendingSize": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetpendingsizeGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPendingSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPendingSizeServlet.java" + "post": + "tags": + - "Block / transaction query" + "summary": "Pending pool size" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getpendingsize.md` for examples and detailed behavior." + "operationId": "wallet_getpendingsize_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getpendingsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "pendingSize": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetpendingsizePostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPendingSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPendingSizeServlet.java" + "/wallet/gettransactionfrompending": + "get": + "tags": + - "Block / transaction query" + "summary": "Single pending transaction" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionfrompending_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "Single pending transaction" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionfrompending_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionFromPendingServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/gettransactionlistfrompending": + "get": + "tags": + - "Block / transaction query" + "summary": "All pending transaction IDs" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionlistfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionlistfrompending_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionlistfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionIdList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionListFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "All pending transaction IDs" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionlistfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionlistfrompending_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionlistfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionIdList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionListFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionListFromPendingServlet.java" + - "protocol/src/main/protos/api/api.proto#TransactionIdList" + "/wallet/createtransaction": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Build a TRX transfer transaction" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/createtransaction.md` for examples and detailed behavior." + "operationId": "wallet_createtransaction_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/createtransaction.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TransferServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransferContractRequest" + "required": + - "owner_address" + - "to_address" + - "amount" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/TransferActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#TransferContract" + "/wallet/getsignweight": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Current multi-sig weight" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/getsignweight.md` for examples and detailed behavior." + "operationId": "wallet_getsignweight_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/getsignweight.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionSignWeight" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionSignWeightServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransactionRequest" + "required": + - "raw_data" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionSignWeightServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + - "protocol/src/main/protos/core/Tron.proto#Transaction" + "/wallet/getapprovedlist": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Addresses that have already signed" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/getapprovedlist.md` for examples and detailed behavior." + "operationId": "wallet_getapprovedlist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/getapprovedlist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionApprovedList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionApprovedListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransactionRequest" + "required": + - "raw_data" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionApprovedListServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + - "protocol/src/main/protos/core/Tron.proto#Transaction" + "/wallet/broadcasttransaction": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Broadcast a signed transaction (JSON)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/broadcasttransaction.md` for examples and detailed behavior." + "operationId": "wallet_broadcasttransaction_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/broadcasttransaction.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "message": + "type": "string" + "txid": + "type": "string" + "x-java-response": "Return/GrpcAPI.Return plus transaction id fields" + "not": + "required": + - "Error" + "title": "BroadcasttransactionPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "BroadcastServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransactionRequest" + "required": + - "raw_data" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/BroadcastServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + - "protocol/src/main/protos/core/Tron.proto#Transaction" + "/wallet/broadcasthex": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Broadcast a signed transaction (hex)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/broadcasthex.md` for examples and detailed behavior." + "operationId": "wallet_broadcasthex_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/broadcasthex.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "message": + "type": "string" + "txid": + "type": "string" + "transaction": + "type": "string" + "x-java-response": "Return/GrpcAPI.Return plus transaction id fields" + "not": + "required": + - "Error" + "title": "BroadcasthexPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "BroadcastHexServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "transaction": + "type": "string" + "description": "Transaction object." + "required": + - "transaction" + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/BroadcastHexServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + "/wallet/createassetissue": + "post": + "tags": + - "TRC10 asset" + "summary": "Issue a TRC10 token" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/createassetissue.md` for examples and detailed behavior." + "operationId": "wallet_createassetissue_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/createassetissue.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CreateAssetIssueServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AssetIssueContractRequest" + "required": + - "owner_address" + - "name" + - "total_supply" + - "trx_num" + - "num" + - "start_time" + - "end_time" + - "url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/AssetIssueActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#AssetIssueContract" + "/wallet/updateasset": + "post": + "tags": + - "TRC10 asset" + "summary": "Update a TRC10's description / URL / limits" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/updateasset.md` for examples and detailed behavior." + "operationId": "wallet_updateasset_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/updateasset.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateAssetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateAssetContractRequest" + "required": + - "owner_address" + - "url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateAssetActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#UpdateAssetContract" + "/wallet/transferasset": + "post": + "tags": + - "TRC10 asset" + "summary": "Transfer TRC10" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/transferasset.md` for examples and detailed behavior." + "operationId": "wallet_transferasset_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/transferasset.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TransferAssetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransferAssetContractRequest" + "required": + - "asset_name" + - "owner_address" + - "to_address" + - "amount" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/TransferAssetActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#TransferAssetContract" + "/wallet/participateassetissue": + "post": + "tags": + - "TRC10 asset" + "summary": "Participate in a TRC10 fundraising" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/participateassetissue.md` for examples and detailed behavior." + "operationId": "wallet_participateassetissue_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/participateassetissue.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ParticipateAssetIssueServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ParticipateAssetIssueContractRequest" + "required": + - "owner_address" + - "to_address" + - "asset_name" + - "amount" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ParticipateAssetIssueActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#ParticipateAssetIssueContract" + "/wallet/unfreezeasset": + "post": + "tags": + - "TRC10 asset" + "summary": "Unfreeze TRC10 frozen by the issuer" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/unfreezeasset.md` for examples and detailed behavior." + "operationId": "wallet_unfreezeasset_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/unfreezeasset.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnFreezeAssetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnfreezeAssetContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnfreezeAssetActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#UnfreezeAssetContract" + "/wallet/getassetissuebyid": + "get": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by id (recommended)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyid.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByIdServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by id (recommended)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyid.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByIdServlet.java" + "/wallet/getassetissuebyname": + "get": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by name (errors on duplicates)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyname_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByNameOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByNameServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by name (errors on duplicates)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyname_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByNameOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByNameServlet.java" + "/wallet/getassetissuelistbyname": + "get": + "tags": + - "TRC10 asset" + "summary": "All TRC10s with a given name" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelistbyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelistbyname_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelistbyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelistbyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListByNameOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListByNameServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "All TRC10s with a given name" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelistbyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelistbyname_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelistbyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelistbyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListByNameOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListByNameServlet.java" + "/wallet/getassetissuebyaccount": + "get": + "tags": + - "TRC10 asset" + "summary": "TRC10s issued by an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyaccount.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyaccount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "post": + "tags": + - "TRC10 asset" + "summary": "TRC10s issued by an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyaccount.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountRequest" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "/wallet/getassetissuelist": + "get": + "tags": + - "TRC10 asset" + "summary": "All TRC10s on the network" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "All TRC10s on the network" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListServlet.java" + "/wallet/getpaginatedassetissuelist": + "get": + "tags": + - "TRC10 asset" + "summary": "Paginated TRC10 list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getpaginatedassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedassetissuelist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getpaginatedassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatedassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedAssetIssueListOnSolidityServlet" + "parameters": + - + "name": "offset" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "x-source-derived": true + - + "name": "limit" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedAssetIssueListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "post": + "tags": + - "TRC10 asset" + "summary": "Paginated TRC10 list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getpaginatedassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedassetissuelist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getpaginatedassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatedassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedAssetIssueListOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/PaginatedMessageRequest" + "required": + - "limit" + - "offset" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedAssetIssueListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "/wallet/deploycontract": + "post": + "tags": + - "Smart contract" + "summary": "Deploy a contract" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/deploycontract.md` for examples and detailed behavior." + "operationId": "wallet_deploycontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/deploycontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "DeployContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CreateSmartContractRequest" + "required": + - "owner_address" + - "bytecode" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/VMActuator.java#validate" + - "framework/src/main/java/org/tron/core/services/http/DeployContractServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#CreateSmartContract" + - "protocol/src/main/protos/core/contract/smart_contract.proto#message ABI" + "/wallet/triggersmartcontract": + "post": + "tags": + - "Smart contract" + "summary": "Trigger a contract (write)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/triggersmartcontract.md` for examples and detailed behavior." + "operationId": "wallet_triggersmartcontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/triggersmartcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/TransactionExtention" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TriggerSmartContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TriggerSmartContractRequest" + "required": + - "owner_address" + - "contract_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/VMActuator.java#validate" + - "framework/src/main/java/org/tron/core/services/http/TriggerSmartContractServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#TriggerSmartContract" + "/wallet/triggerconstantcontract": + "post": + "tags": + - "Smart contract" + "summary": "Read-only contract call" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/triggerconstantcontract.md` for examples and detailed behavior." + "operationId": "wallet_triggerconstantcontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/triggerconstantcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/TransactionExtention" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TriggerConstantContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/triggerconstantcontract" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "TriggerConstantContractOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TriggerSmartContractRequest" + "required": + - "owner_address" + "anyOf": + - + "required": + - "contract_address" + "title": "TriggerconstantcontractPostRequestRequiresContractAddress1" + - + "required": + - "data" + "title": "TriggerconstantcontractPostRequestRequiresData2" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/TriggerConstantContractServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#TriggerSmartContract" + "/wallet/estimateenergy": + "post": + "tags": + - "Smart contract" + "summary": "Estimate energy usage of a call" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/estimateenergy.md` for examples and detailed behavior." + "operationId": "wallet_estimateenergy_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/estimateenergy.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "message": + "type": "string" + "energy_required": + "type": "integer" + "format": "int64" + "x-java-response": "EstimateEnergyMessage rendered by Util.printEstimateEnergyMessage" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "EstimateEnergyServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/estimateenergy" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "EstimateEnergyOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TriggerSmartContractRequest" + "required": + - "owner_address" + "anyOf": + - + "required": + - "contract_address" + "title": "EstimateenergyPostRequestRequiresContractAddress1" + - + "required": + - "data" + "title": "EstimateenergyPostRequestRequiresData2" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/EstimateEnergyServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#TriggerSmartContract" + "/wallet/getcontract": + "get": + "tags": + - "Smart contract" + "summary": "Contract metadata" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontract.md` for examples and detailed behavior." + "operationId": "wallet_getcontract_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Smart contract" + "summary": "Contract metadata" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontract.md` for examples and detailed behavior." + "operationId": "wallet_getcontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/getcontractinfo": + "get": + "tags": + - "Smart contract" + "summary": "Full contract runtime info" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontractinfo.md` for examples and detailed behavior." + "operationId": "wallet_getcontractinfo_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontractinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContractDataWrapper" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractInfoServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Smart contract" + "summary": "Full contract runtime info" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontractinfo.md` for examples and detailed behavior." + "operationId": "wallet_getcontractinfo_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontractinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContractDataWrapper" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractInfoServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/clearabi": + "post": + "tags": + - "Smart contract" + "summary": "Clear a contract's ABI" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/clearabi.md` for examples and detailed behavior." + "operationId": "wallet_clearabi_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/clearabi.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ClearABIServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ClearABIContractRequest" + "required": + - "owner_address" + - "contract_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ClearABIContractActuator.java#validate" + - "protocol/src/main/protos/core/contract/smart_contract.proto#ClearABIContract" + "/wallet/updatesetting": + "post": + "tags": + - "Smart contract" + "summary": "Change the user-energy percentage" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/updatesetting.md` for examples and detailed behavior." + "operationId": "wallet_updatesetting_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/updatesetting.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateSettingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateSettingContractRequest" + "required": + - "owner_address" + - "contract_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateSettingContractActuator.java#validate" + - "protocol/src/main/protos/core/contract/smart_contract.proto#UpdateSettingContract" + "/wallet/updateenergylimit": + "post": + "tags": + - "Smart contract" + "summary": "Change the deployer's energy limit" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/updateenergylimit.md` for examples and detailed behavior." + "operationId": "wallet_updateenergylimit_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/updateenergylimit.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateEnergyLimitServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateEnergyLimitContractRequest" + "required": + - "owner_address" + - "contract_address" + - "origin_energy_limit" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateEnergyLimitContractActuator.java#validate" + - "protocol/src/main/protos/core/contract/smart_contract.proto#UpdateEnergyLimitContract" + "/wallet/createwitness": + "post": + "tags": + - "Witness / governance" + "summary": "Apply to become an SR candidate" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/createwitness.md` for examples and detailed behavior." + "operationId": "wallet_createwitness_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/createwitness.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CreateWitnessServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WitnessCreateContractRequest" + "required": + - "owner_address" + - "url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WitnessCreateActuator.java#validate" + - "protocol/src/main/protos/core/contract/witness_contract.proto#WitnessCreateContract" + "/wallet/updatewitness": + "post": + "tags": + - "Witness / governance" + "summary": "Update an SR's URL" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/updatewitness.md` for examples and detailed behavior." + "operationId": "wallet_updatewitness_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/updatewitness.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateWitnessServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WitnessUpdateContractRequest" + "required": + - "owner_address" + - "update_url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WitnessUpdateActuator.java#validate" + - "protocol/src/main/protos/core/contract/witness_contract.proto#WitnessUpdateContract" + "/wallet/listwitnesses": + "get": + "tags": + - "Witness / governance" + "summary": "All SR candidates" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listwitnesses.md` for examples and detailed behavior." + "operationId": "wallet_listwitnesses_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listwitnesses.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListWitnessesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/listwitnesses" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "ListWitnessesOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListWitnessesServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "All SR candidates" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listwitnesses.md` for examples and detailed behavior." + "operationId": "wallet_listwitnesses_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listwitnesses.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListWitnessesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/listwitnesses" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "ListWitnessesOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListWitnessesServlet.java" + "/wallet/getpaginatednowwitnesslist": + "get": + "tags": + - "Witness / governance" + "summary": "Paginated SR list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatednowwitnesslist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedNowWitnessListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatednowwitnesslist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedNowWitnessListOnSolidityServlet" + "parameters": + - + "name": "offset" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "x-source-derived": true + - + "name": "limit" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedNowWitnessListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "post": + "tags": + - "Witness / governance" + "summary": "Paginated SR list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatednowwitnesslist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedNowWitnessListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatednowwitnesslist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedNowWitnessListOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/PaginatedMessageRequest" + "required": + - "limit" + - "offset" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedNowWitnessListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "/wallet/votewitnessaccount": + "post": + "tags": + - "Witness / governance" + "summary": "Vote for SRs" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/votewitnessaccount.md` for examples and detailed behavior." + "operationId": "wallet_votewitnessaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/votewitnessaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "VoteWitnessAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/VoteWitnessContractRequest" + "required": + - "owner_address" + - "votes" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/VoteWitnessActuator.java#validate" + - "protocol/src/main/protos/core/contract/witness_contract.proto#VoteWitnessContract" + "/wallet/getBrokerage": + "get": + "tags": + - "Witness / governance" + "summary": "An SR's current brokerage rate" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getBrokerage.md` for examples and detailed behavior." + "operationId": "wallet_getBrokerage_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getBrokerage.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "brokerage": + "type": "integer" + "format": "int32" + "description": "Witness brokerage percentage, from 0 to 100." + "Error": + "type": "string" + "not": + "required": + - "Error" + "title": "GetBrokerageGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBrokerageServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getBrokerage" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBrokerageOnSolidityServlet" + "parameters": + - + "name": "address" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBrokerageServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "An SR's current brokerage rate" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getBrokerage.md` for examples and detailed behavior." + "operationId": "wallet_getBrokerage_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getBrokerage.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "brokerage": + "type": "integer" + "format": "int32" + "description": "Witness brokerage percentage, from 0 to 100." + "Error": + "type": "string" + "not": + "required": + - "Error" + "title": "GetBrokeragePostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBrokerageServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getBrokerage" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBrokerageOnSolidityServlet" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBrokerageServlet.java" + "requestBody": + "required": false + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-json-body" + "x-java-unknown-fields": "ignored-by-servlet-helper" + "application/x-www-form-urlencoded": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-form-body" + "/wallet/updateBrokerage": + "post": + "tags": + - "Witness / governance" + "summary": "Update an SR's brokerage" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/updateBrokerage.md` for examples and detailed behavior." + "operationId": "wallet_updateBrokerage_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/updateBrokerage.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateBrokerageServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateBrokerageContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateBrokerageActuator.java#validate" + - "protocol/src/main/protos/core/contract/storage_contract.proto#UpdateBrokerageContract" + "/wallet/getReward": + "get": + "tags": + - "Witness / governance" + "summary": "Claimable rewards for an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getReward.md` for examples and detailed behavior." + "operationId": "wallet_getReward_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getReward.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "reward": + "type": "integer" + "format": "int64" + "Error": + "type": "string" + "required": + - "reward" + "not": + "required": + - "Error" + "title": "GetRewardGetResultRequiresReward1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetRewardServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getReward" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetRewardOnSolidityServlet" + "parameters": + - + "name": "address" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetRewardServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Claimable rewards for an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getReward.md` for examples and detailed behavior." + "operationId": "wallet_getReward_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getReward.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "reward": + "type": "integer" + "format": "int64" + "Error": + "type": "string" + "required": + - "reward" + "not": + "required": + - "Error" + "title": "GetRewardPostResultRequiresReward1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetRewardServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getReward" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetRewardOnSolidityServlet" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetRewardServlet.java" + "requestBody": + "required": false + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-json-body" + "x-java-unknown-fields": "ignored-by-servlet-helper" + "application/x-www-form-urlencoded": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-form-body" + "/wallet/withdrawbalance": + "post": + "tags": + - "Witness / governance" + "summary": "Withdraw block production rewards / dividends" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/withdrawbalance.md` for examples and detailed behavior." + "operationId": "wallet_withdrawbalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/withdrawbalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "WithdrawBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WithdrawBalanceContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WithdrawBalanceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#WithdrawBalanceContract" + "/wallet/proposalcreate": + "post": + "tags": + - "Witness / governance" + "summary": "Create a chain-parameter proposal" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/proposalcreate.md` for examples and detailed behavior." + "operationId": "wallet_proposalcreate_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/proposalcreate.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ProposalCreateServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ProposalCreateContractRequest" + "required": + - "owner_address" + - "parameters" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ProposalCreateActuator.java#validate" + - "protocol/src/main/protos/core/contract/proposal_contract.proto#ProposalCreateContract" + "/wallet/proposalapprove": + "post": + "tags": + - "Witness / governance" + "summary": "Vote on a proposal as an SR" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/proposalapprove.md` for examples and detailed behavior." + "operationId": "wallet_proposalapprove_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/proposalapprove.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ProposalApproveServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ProposalApproveContractRequest" + "required": + - "owner_address" + - "proposal_id" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ProposalApproveActuator.java#validate" + - "protocol/src/main/protos/core/contract/proposal_contract.proto#ProposalApproveContract" + "/wallet/proposaldelete": + "post": + "tags": + - "Witness / governance" + "summary": "Withdraw your own proposal" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/proposaldelete.md` for examples and detailed behavior." + "operationId": "wallet_proposaldelete_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/proposaldelete.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ProposalDeleteServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ProposalDeleteContractRequest" + "required": + - "owner_address" + - "proposal_id" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ProposalDeleteActuator.java#validate" + - "protocol/src/main/protos/core/contract/proposal_contract.proto#ProposalDeleteContract" + "/wallet/listproposals": + "get": + "tags": + - "Witness / governance" + "summary": "List of proposals" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listproposals.md` for examples and detailed behavior." + "operationId": "wallet_listproposals_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listproposals.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListProposalsServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListProposalsServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "List of proposals" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listproposals.md` for examples and detailed behavior." + "operationId": "wallet_listproposals_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listproposals.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListProposalsServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListProposalsServlet.java" + "/wallet/getproposalbyid": + "get": + "tags": + - "Witness / governance" + "summary": "Proposal by ID" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getproposalbyid.md` for examples and detailed behavior." + "operationId": "wallet_getproposalbyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getproposalbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Proposal" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetProposalByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "id" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetProposalByIdServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Proposal by ID" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getproposalbyid.md` for examples and detailed behavior." + "operationId": "wallet_getproposalbyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getproposalbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Proposal" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetProposalByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "id": + "type": "integer" + "description": "Proposal id." + "format": "int64" + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "required": + - "id" + "x-java-unknown-fields": "ignored-by-jsonformat" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetProposalByIdServlet.java" + "/wallet/getpaginatedproposallist": + "get": + "tags": + - "Witness / governance" + "summary": "Paginated proposal list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatedproposallist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedproposallist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatedproposallist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedProposalListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "offset" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "x-source-derived": true + - + "name": "limit" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedProposalListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "post": + "tags": + - "Witness / governance" + "summary": "Paginated proposal list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatedproposallist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedproposallist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatedproposallist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedProposalListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/PaginatedMessageRequest" + "required": + - "limit" + - "offset" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedProposalListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "/wallet/getchainparameters": + "get": + "tags": + - "Witness / governance" + "summary": "Current chain parameters" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getchainparameters.md` for examples and detailed behavior." + "operationId": "wallet_getchainparameters_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getchainparameters.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ChainParameters" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetChainParametersServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetChainParametersServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Current chain parameters" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getchainparameters.md` for examples and detailed behavior." + "operationId": "wallet_getchainparameters_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getchainparameters.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ChainParameters" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetChainParametersServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetChainParametersServlet.java" + "/wallet/getnextmaintenancetime": + "get": + "tags": + - "Witness / governance" + "summary": "Next maintenance period time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getnextmaintenancetime.md` for examples and detailed behavior." + "operationId": "wallet_getnextmaintenancetime_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getnextmaintenancetime.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NumberMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNextMaintenanceTimeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNextMaintenanceTimeServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Next maintenance period time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getnextmaintenancetime.md` for examples and detailed behavior." + "operationId": "wallet_getnextmaintenancetime_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getnextmaintenancetime.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NumberMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNextMaintenanceTimeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNextMaintenanceTimeServlet.java" + "/wallet/freezebalance": + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Freeze TRX for resources (V1, chain rejects new requests)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/freezebalance.md` for examples and detailed behavior." + "operationId": "wallet_freezebalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/freezebalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "FreezeBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/FreezeBalanceContractRequest" + "required": + - "owner_address" + - "frozen_balance" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/FreezeBalanceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#FreezeBalanceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" + "/wallet/unfreezebalance": + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Unfreeze matured resources (V1, still usable for legacy positions)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/unfreezebalance.md` for examples and detailed behavior." + "operationId": "wallet_unfreezebalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/unfreezebalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnFreezeBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnfreezeBalanceContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnfreezeBalanceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#UnfreezeBalanceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" + "/wallet/getdelegatedresource": + "get": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation records (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresource.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresource_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresource" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceOnSolidityServlet" + "parameters": + - + "name": "fromAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Source account address." + "x-source-derived": true + - + "name": "toAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Destination account address." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation records (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresource.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresource" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/DelegatedResourceMessageRequest" + "required": + - "fromAddress" + - "toAddress" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceServlet.java" + - "protocol/src/main/protos/api/api.proto#DelegatedResourceMessage" + "/wallet/getdelegatedresourceaccountindex": + "get": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation counterparty addresses (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresourceaccountindex.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindex_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresourceaccountindex.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindex" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation counterparty addresses (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresourceaccountindex.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindex_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresourceaccountindex.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindex" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceAccountIndexServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/freezebalancev2": + "post": + "tags": + - "Stake 2.0" + "summary": "Freeze TRX for resources" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/freezebalancev2.md` for examples and detailed behavior." + "operationId": "wallet_freezebalancev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/freezebalancev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "FreezeBalanceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/FreezeBalanceV2ContractRequest" + "required": + - "owner_address" + - "frozen_balance" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/FreezeBalanceV2Actuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#FreezeBalanceV2Contract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" + "/wallet/unfreezebalancev2": + "post": + "tags": + - "Stake 2.0" + "summary": "Initiate unfreeze (14-day waiting period)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/unfreezebalancev2.md` for examples and detailed behavior." + "operationId": "wallet_unfreezebalancev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/unfreezebalancev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnFreezeBalanceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnfreezeBalanceV2ContractRequest" + "required": + - "owner_address" + - "unfreeze_balance" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnfreezeBalanceV2Actuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#UnfreezeBalanceV2Contract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" + "/wallet/withdrawexpireunfreeze": + "post": + "tags": + - "Stake 2.0" + "summary": "Withdraw matured unfreezes" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/withdrawexpireunfreeze.md` for examples and detailed behavior." + "operationId": "wallet_withdrawexpireunfreeze_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/withdrawexpireunfreeze.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "WithdrawExpireUnfreezeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WithdrawExpireUnfreezeContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WithdrawExpireUnfreezeActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#WithdrawExpireUnfreezeContract" + "/wallet/cancelallunfreezev2": + "post": + "tags": + - "Stake 2.0" + "summary": "Cancel all unmatured unfreezes" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/cancelallunfreezev2.md` for examples and detailed behavior." + "operationId": "wallet_cancelallunfreezev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/cancelallunfreezev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CancelAllUnfreezeV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CancelAllUnfreezeV2ContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/CancelAllUnfreezeV2Actuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#CancelAllUnfreezeV2Contract" + "/wallet/delegateresource": + "post": + "tags": + - "Stake 2.0" + "summary": "Delegate resources to another account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/delegateresource.md` for examples and detailed behavior." + "operationId": "wallet_delegateresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/delegateresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "DelegateResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/DelegateResourceContractRequest" + "required": + - "owner_address" + - "balance" + - "receiver_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/DelegateResourceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#DelegateResourceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" + "/wallet/undelegateresource": + "post": + "tags": + - "Stake 2.0" + "summary": "Undelegate resources from another account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/undelegateresource.md` for examples and detailed behavior." + "operationId": "wallet_undelegateresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/undelegateresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnDelegateResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnDelegateResourceContractRequest" + "required": + - "owner_address" + - "balance" + - "receiver_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnDelegateResourceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#UnDelegateResourceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" + "/wallet/getdelegatedresourcev2": + "get": + "tags": + - "Stake 2.0" + "summary": "Query delegation records" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourcev2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourcev2_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourcev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourcev2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceV2OnSolidityServlet" + "parameters": + - + "name": "fromAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Source account address." + "x-source-derived": true + - + "name": "toAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Destination account address." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Query delegation records" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourcev2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourcev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourcev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourcev2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceV2OnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/DelegatedResourceMessageRequest" + "required": + - "fromAddress" + - "toAddress" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceV2Servlet.java" + - "protocol/src/main/protos/api/api.proto#DelegatedResourceMessage" + "/wallet/getdelegatedresourceaccountindexv2": + "get": + "tags": + - "Stake 2.0" + "summary": "Query delegation counterparty addresses" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindexv2_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindexv2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2OnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Query delegation counterparty addresses" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindexv2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindexv2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2OnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceAccountIndexV2Servlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "/wallet/getcandelegatedmaxsize": + "get": + "tags": + - "Stake 2.0" + "summary": "Current maximum delegatable amount" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcandelegatedmaxsize.md` for examples and detailed behavior." + "operationId": "wallet_getcandelegatedmaxsize_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcandelegatedmaxsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanDelegatedMaxSizeResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanDelegatedMaxSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcandelegatedmaxsize" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanDelegatedMaxSizeOnSolidityServlet" + "parameters": + - + "name": "type" + "in": "query" + "required": false + "schema": + "type": "integer" + "format": "int32" + "description": "Account, contract, or resource type." + "x-source-derived": true + - + "name": "owner_address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Current maximum delegatable amount" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcandelegatedmaxsize.md` for examples and detailed behavior." + "operationId": "wallet_getcandelegatedmaxsize_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcandelegatedmaxsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanDelegatedMaxSizeResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanDelegatedMaxSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcandelegatedmaxsize" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanDelegatedMaxSizeOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CanDelegatedMaxSizeRequestMessageRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetCanDelegatedMaxSizeServlet.java" + - "protocol/src/main/protos/api/api.proto#CanDelegatedMaxSizeRequestMessage" + "/wallet/getavailableunfreezecount": + "get": + "tags": + - "Stake 2.0" + "summary": "Remaining unfreeze count" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getavailableunfreezecount.md` for examples and detailed behavior." + "operationId": "wallet_getavailableunfreezecount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getavailableunfreezecount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/GetAvailableUnfreezeCountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAvailableUnfreezeCountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getavailableunfreezecount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAvailableUnfreezeCountOnSolidityServlet" + "parameters": + - + "name": "ownerAddress" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Alias for owner_address. At least one of ownerAddress or owner_address must be provided." + "x-source-derived": true + - + "name": "owner_address" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Address of the account that owns or initiates the request. At least one of ownerAddress or owner_address must be provided." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAvailableUnfreezeCountServlet.java" + "x-query-required-anyOf": + - + - "ownerAddress" + - + - "owner_address" + "post": + "tags": + - "Stake 2.0" + "summary": "Remaining unfreeze count" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getavailableunfreezecount.md` for examples and detailed behavior." + "operationId": "wallet_getavailableunfreezecount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getavailableunfreezecount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/GetAvailableUnfreezeCountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAvailableUnfreezeCountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getavailableunfreezecount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAvailableUnfreezeCountOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/GetAvailableUnfreezeCountRequestMessageRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAvailableUnfreezeCountServlet.java" + - "protocol/src/main/protos/api/api.proto#GetAvailableUnfreezeCountRequestMessage" + "/wallet/getcanwithdrawunfreezeamount": + "get": + "tags": + - "Stake 2.0" + "summary": "Withdrawable unfreeze amount at a given time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md` for examples and detailed behavior." + "operationId": "wallet_getcanwithdrawunfreezeamount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanWithdrawUnfreezeAmountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcanwithdrawunfreezeamount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountOnSolidityServlet" + "parameters": + - + "name": "owner_address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-source-derived": true + - + "name": "timestamp" + "in": "query" + "required": false + "schema": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Withdrawable unfreeze amount at a given time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md` for examples and detailed behavior." + "operationId": "wallet_getcanwithdrawunfreezeamount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanWithdrawUnfreezeAmountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcanwithdrawunfreezeamount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CanWithdrawUnfreezeAmountRequestMessageRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetCanWithdrawUnfreezeAmountServlet.java" + - "protocol/src/main/protos/api/api.proto#CanWithdrawUnfreezeAmountRequestMessage" + "/wallet/getnodeinfo": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Node status (also /monitor/getnodeinfo)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getnodeinfo.md` for examples and detailed behavior." + "operationId": "wallet_getnodeinfo_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getnodeinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNodeInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnodeinfo" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNodeInfoOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNodeInfoServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Node status (also /monitor/getnodeinfo)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getnodeinfo.md` for examples and detailed behavior." + "operationId": "wallet_getnodeinfo_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getnodeinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNodeInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnodeinfo" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNodeInfoOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNodeInfoServlet.java" + "/wallet/listnodes": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Known peers (also /net/listnodes)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/listnodes.md` for examples and detailed behavior." + "operationId": "wallet_listnodes_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/listnodes.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListNodesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListNodesServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Known peers (also /net/listnodes)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/listnodes.md` for examples and detailed behavior." + "operationId": "wallet_listnodes_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/listnodes.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListNodesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "/wallet/getenergyprices": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Historical energy unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getenergyprices.md` for examples and detailed behavior." + "operationId": "wallet_getenergyprices_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getenergyprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetEnergyPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getenergyprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetEnergyPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetEnergyPricesServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Historical energy unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getenergyprices.md` for examples and detailed behavior." + "operationId": "wallet_getenergyprices_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getenergyprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetEnergyPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getenergyprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetEnergyPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetEnergyPricesServlet.java" + "/wallet/getbandwidthprices": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Historical bandwidth unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getbandwidthprices.md` for examples and detailed behavior." + "operationId": "wallet_getbandwidthprices_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getbandwidthprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBandwidthPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getbandwidthprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBandwidthPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBandwidthPricesServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Historical bandwidth unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getbandwidthprices.md` for examples and detailed behavior." + "operationId": "wallet_getbandwidthprices_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getbandwidthprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBandwidthPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getbandwidthprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBandwidthPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBandwidthPricesServlet.java" + "/wallet/getburntrx": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Cumulative burned TRX" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getburntrx.md` for examples and detailed behavior." + "operationId": "wallet_getburntrx_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getburntrx.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "burnTrxAmount": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetburntrxGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBurnTrxServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getburntrx" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBurnTrxOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBurnTrxServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Cumulative burned TRX" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getburntrx.md` for examples and detailed behavior." + "operationId": "wallet_getburntrx_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getburntrx.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "burnTrxAmount": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetburntrxPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBurnTrxServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getburntrx" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBurnTrxOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBurnTrxServlet.java" +"components": + "schemas": + "JavaTronError": + "type": "object" + "additionalProperties": false + "properties": + "Error": + "type": "string" + "required": + - "Error" + "AccountId": + "type": "object" + "additionalProperties": false + "properties": + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-proto-message": "AccountId" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "Authority": + "type": "object" + "additionalProperties": false + "properties": + "account": + "$ref": "#/components/schemas/AccountId" + "permission_name": + "type": "string" + "x-proto-message": "authority" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "AccountCreateContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "account_address": + "type": "string" + "description": "Address of the account to create." + "type": + "type": "string" + "enum": + - "Normal" + - "AssetIssue" + - "Contract" + "description": "Account, contract, or resource type." + "x-proto-message": "AccountCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "Key": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "weight": + "type": "integer" + "format": "int64" + "x-proto-message": "Key" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "Permission": + "type": "object" + "additionalProperties": false + "properties": + "type": + "type": "string" + "enum": + - "Owner" + - "Witness" + - "Active" + "description": "Account, contract, or resource type." + "id": + "type": "integer" + "format": "int32" + "description": "Identifier used by this query." + "permission_name": + "type": "string" + "threshold": + "type": "integer" + "format": "int64" + "parent_id": + "type": "integer" + "format": "int32" + "operations": + "type": "string" + "keys": + "type": "array" + "items": + "$ref": "#/components/schemas/Key" + "x-proto-message": "Permission" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "description": "Owner permission definition." + "AccountPermissionUpdateContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "owner": + "$ref": "#/components/schemas/Permission" + "witness": + "$ref": "#/components/schemas/Permission" + "actives": + "type": "array" + "items": + "$ref": "#/components/schemas/Permission" + "description": "Active permission definitions for account permission update." + "x-proto-message": "AccountPermissionUpdateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "AccountUpdateContract": + "type": "object" + "additionalProperties": false + "properties": + "account_name": + "type": "string" + "description": "New account name encoded as expected by java-tron." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-proto-message": "AccountUpdateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "AssetIssueContractFrozenSupply": + "type": "object" + "additionalProperties": false + "properties": + "frozen_amount": + "type": "integer" + "format": "int64" + "frozen_days": + "type": "integer" + "format": "int64" + "x-proto-message": "AssetIssueContract.FrozenSupply" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "AssetIssueContract": + "type": "object" + "additionalProperties": false + "properties": + "id": + "type": "string" + "description": "Identifier used by this query." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "abbr": + "type": "string" + "description": "Asset abbreviation." + "total_supply": + "type": "integer" + "format": "int64" + "description": "Total asset supply." + "frozen_supply": + "type": "array" + "items": + "$ref": "#/components/schemas/AssetIssueContractFrozenSupply" + "description": "Frozen supply schedules for an asset issue." + "trx_num": + "type": "integer" + "format": "int32" + "description": "TRX amount used in the asset issue exchange ratio." + "precision": + "type": "integer" + "format": "int32" + "description": "Asset precision." + "num": + "type": "integer" + "format": "int32" + "description": "Number of items or blocks to return." + "start_time": + "type": "integer" + "format": "int64" + "description": "Start timestamp in milliseconds." + "end_time": + "type": "integer" + "format": "int64" + "description": "End timestamp in milliseconds." + "order": + "type": "integer" + "format": "int64" + "description": "Sort order." + "vote_score": + "type": "integer" + "format": "int32" + "description": "Vote count or vote weight." + "description": + "type": "string" + "description": "Human-readable description for this object." + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "free_asset_net_limit": + "type": "integer" + "format": "int64" + "description": "Free asset bandwidth limit for each account." + "public_free_asset_net_limit": + "type": "integer" + "format": "int64" + "description": "Public free asset bandwidth limit." + "public_free_asset_net_usage": + "type": "integer" + "format": "int64" + "description": "Public free asset bandwidth usage." + "public_latest_free_net_time": + "type": "integer" + "format": "int64" + "description": "Latest public free bandwidth usage timestamp." + "x-proto-message": "AssetIssueContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "x-java-response": "AssetIssueContract rendered by java-tron JSON printer" + "CancelAllUnfreezeV2Contract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-proto-message": "CancelAllUnfreezeV2Contract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "ClearABIContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "x-proto-message": "ClearABIContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "CreateSmartContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "new_contract": + "$ref": "#/components/schemas/SmartContract" + "call_token_value": + "type": "integer" + "format": "int64" + "description": "TRC10 token amount transferred with the smart contract call." + "token_id": + "type": "integer" + "format": "int64" + "description": "TRC10 token id." + "x-proto-message": "CreateSmartContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "DelegateResourceContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type." + "balance": + "type": "integer" + "format": "int64" + "description": "Resource amount in sun, where 1 TRX equals 1,000,000 sun." + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "lock": + "type": "boolean" + "description": "Whether delegated resources are locked." + "lock_period": + "type": "integer" + "format": "int64" + "description": "Resource delegation lock period." + "x-proto-message": "DelegateResourceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "ExchangeCreateContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "first_token_id": + "type": "string" + "first_token_balance": + "type": "integer" + "format": "int64" + "second_token_id": + "type": "string" + "second_token_balance": + "type": "integer" + "format": "int64" + "x-proto-message": "ExchangeCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/exchange_contract.proto" + "ExchangeInjectContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "exchange_id": + "type": "integer" + "format": "int64" + "token_id": + "type": "string" + "description": "TRC10 token id." + "quant": + "type": "integer" + "format": "int64" + "x-proto-message": "ExchangeInjectContract" + "x-proto-file": "protocol/src/main/protos/core/contract/exchange_contract.proto" + "ExchangeTransactionContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "exchange_id": + "type": "integer" + "format": "int64" + "token_id": + "type": "string" + "description": "TRC10 token id." + "quant": + "type": "integer" + "format": "int64" + "expected": + "type": "integer" + "format": "int64" + "x-proto-message": "ExchangeTransactionContract" + "x-proto-file": "protocol/src/main/protos/core/contract/exchange_contract.proto" + "ExchangeWithdrawContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "exchange_id": + "type": "integer" + "format": "int64" + "token_id": + "type": "string" + "description": "TRC10 token id." + "quant": + "type": "integer" + "format": "int64" + "x-proto-message": "ExchangeWithdrawContract" + "x-proto-file": "protocol/src/main/protos/core/contract/exchange_contract.proto" + "FreezeBalanceContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "frozen_balance": + "type": "integer" + "format": "int64" + "description": "Amount to freeze in sun, where 1 TRX equals 1,000,000 sun." + "frozen_duration": + "type": "integer" + "format": "int64" + "description": "Freeze duration in days." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type." + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "x-proto-message": "FreezeBalanceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "FreezeBalanceV2Contract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "frozen_balance": + "type": "integer" + "format": "int64" + "description": "Amount to freeze in sun, where 1 TRX equals 1,000,000 sun." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type." + "x-proto-message": "FreezeBalanceV2Contract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "MarketCancelOrderContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "order_id": + "type": "string" + "x-proto-message": "MarketCancelOrderContract" + "x-proto-file": "protocol/src/main/protos/core/contract/market_contract.proto" + "MarketSellAssetContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "sell_token_id": + "type": "string" + "sell_token_quantity": + "type": "integer" + "format": "int64" + "buy_token_id": + "type": "string" + "buy_token_quantity": + "type": "integer" + "format": "int64" + "x-proto-message": "MarketSellAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/market_contract.proto" + "ParticipateAssetIssueContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "to_address": + "type": "string" + "description": "Destination account address." + "asset_name": + "type": "string" + "description": "Asset name or token identifier encoded as expected by java-tron." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "x-proto-message": "ParticipateAssetIssueContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "ProposalApproveContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "proposal_id": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "is_add_approval": + "type": "boolean" + "description": "Whether to add approval for the proposal." + "x-proto-message": "ProposalApproveContract" + "x-proto-file": "protocol/src/main/protos/core/contract/proposal_contract.proto" + "ProposalCreateContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "parameters": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "description": "Proposal parameter map." + "x-proto-message": "ProposalCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/proposal_contract.proto" + "ProposalDeleteContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "proposal_id": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "x-proto-message": "ProposalDeleteContract" + "x-proto-file": "protocol/src/main/protos/core/contract/proposal_contract.proto" + "SetAccountIdContract": + "type": "object" + "additionalProperties": false + "properties": + "account_id": + "type": "string" + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-proto-message": "SetAccountIdContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "SpendDescription": + "type": "object" + "additionalProperties": false + "properties": + "value_commitment": + "type": "string" + "anchor": + "type": "string" + "nullifier": + "type": "string" + "rk": + "type": "string" + "zkproof": + "type": "string" + "spend_authority_signature": + "type": "string" + "x-proto-message": "SpendDescription" + "x-proto-file": "protocol/src/main/protos/core/contract/shield_contract.proto" + "ReceiveDescription": + "type": "object" + "additionalProperties": false + "properties": + "value_commitment": + "type": "string" + "note_commitment": + "type": "string" + "epk": + "type": "string" + "c_enc": + "type": "string" + "c_out": + "type": "string" + "zkproof": + "type": "string" + "x-proto-message": "ReceiveDescription" + "x-proto-file": "protocol/src/main/protos/core/contract/shield_contract.proto" + "ShieldedTransferContract": + "type": "object" + "additionalProperties": false + "properties": + "transparent_from_address": + "type": "string" + "from_amount": + "type": "integer" + "format": "int64" + "spend_description": + "type": "array" + "items": + "$ref": "#/components/schemas/SpendDescription" + "receive_description": + "type": "array" + "items": + "$ref": "#/components/schemas/ReceiveDescription" + "binding_signature": + "type": "string" + "transparent_to_address": + "type": "string" + "to_amount": + "type": "integer" + "format": "int64" + "x-proto-message": "ShieldedTransferContract" + "x-proto-file": "protocol/src/main/protos/core/contract/shield_contract.proto" + "TransferAssetContract": + "type": "object" + "additionalProperties": false + "properties": + "asset_name": + "type": "string" + "description": "Asset name or token identifier encoded as expected by java-tron." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "to_address": + "type": "string" + "description": "Destination account address." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "x-proto-message": "TransferAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "TransferContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "to_address": + "type": "string" + "description": "Destination account address." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "x-proto-message": "TransferContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "TriggerSmartContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "call_value": + "type": "integer" + "format": "int64" + "description": "TRX amount in sun transferred with the smart contract call." + "data": + "type": "string" + "description": "Hex-encoded contract call data or transaction data." + "call_token_value": + "type": "integer" + "format": "int64" + "description": "TRC10 token amount transferred with the smart contract call." + "token_id": + "type": "integer" + "format": "int64" + "description": "TRC10 token id." + "x-proto-message": "TriggerSmartContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "UnDelegateResourceContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type." + "balance": + "type": "integer" + "format": "int64" + "description": "Resource amount in sun, where 1 TRX equals 1,000,000 sun." + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "x-proto-message": "UnDelegateResourceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "UnfreezeAssetContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-proto-message": "UnfreezeAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "UnfreezeBalanceContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type." + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "x-proto-message": "UnfreezeBalanceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "UnfreezeBalanceV2Contract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "unfreeze_balance": + "type": "integer" + "format": "int64" + "description": "Amount to unfreeze in sun, where 1 TRX equals 1,000,000 sun." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type." + "x-proto-message": "UnfreezeBalanceV2Contract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "UpdateAssetContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "description": + "type": "string" + "description": "Human-readable description for this object." + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "new_limit": + "type": "integer" + "format": "int64" + "description": "New account resource limit." + "new_public_limit": + "type": "integer" + "format": "int64" + "description": "New public resource limit." + "x-proto-message": "UpdateAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "UpdateBrokerageContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "brokerage": + "type": "integer" + "format": "int32" + "description": "Witness brokerage percentage, from 0 to 100." + "x-proto-message": "UpdateBrokerageContract" + "x-proto-file": "protocol/src/main/protos/core/contract/storage_contract.proto" + "UpdateEnergyLimitContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "origin_energy_limit": + "type": "integer" + "format": "int64" + "description": "Origin energy limit for a deployed smart contract." + "x-proto-message": "UpdateEnergyLimitContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "UpdateSettingContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "consume_user_resource_percent": + "type": "integer" + "format": "int64" + "description": "Percentage of contract execution resource cost paid by the user." + "x-proto-message": "UpdateSettingContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "VoteWitnessContractVote": + "type": "object" + "additionalProperties": false + "properties": + "vote_address": + "type": "string" + "vote_count": + "type": "integer" + "format": "int64" + "x-proto-message": "VoteWitnessContract.Vote" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "VoteWitnessContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "votes": + "type": "array" + "items": + "$ref": "#/components/schemas/VoteWitnessContractVote" + "description": "Witness vote entries." + "support": + "type": "boolean" + "description": "Proposal support flag." + "x-proto-message": "VoteWitnessContract" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "WithdrawBalanceContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-proto-message": "WithdrawBalanceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "WithdrawExpireUnfreezeContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-proto-message": "WithdrawExpireUnfreezeContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "WitnessCreateContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "x-proto-message": "WitnessCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "WitnessUpdateContract": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "update_url": + "type": "string" + "description": "Updated URL encoded as expected by java-tron." + "x-proto-message": "WitnessUpdateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "TransactionContract": + "type": "object" + "additionalProperties": false + "properties": + "type": + "type": "string" + "enum": + - "AccountCreateContract" + - "TransferContract" + - "TransferAssetContract" + - "VoteAssetContract" + - "VoteWitnessContract" + - "WitnessCreateContract" + - "AssetIssueContract" + - "WitnessUpdateContract" + - "ParticipateAssetIssueContract" + - "AccountUpdateContract" + - "FreezeBalanceContract" + - "UnfreezeBalanceContract" + - "WithdrawBalanceContract" + - "UnfreezeAssetContract" + - "UpdateAssetContract" + - "ProposalCreateContract" + - "ProposalApproveContract" + - "ProposalDeleteContract" + - "SetAccountIdContract" + - "CustomContract" + - "CreateSmartContract" + - "TriggerSmartContract" + - "GetContract" + - "UpdateSettingContract" + - "ExchangeCreateContract" + - "ExchangeInjectContract" + - "ExchangeWithdrawContract" + - "ExchangeTransactionContract" + - "UpdateEnergyLimitContract" + - "AccountPermissionUpdateContract" + - "ClearABIContract" + - "UpdateBrokerageContract" + - "ShieldedTransferContract" + - "MarketSellAssetContract" + - "MarketCancelOrderContract" + - "FreezeBalanceV2Contract" + - "UnfreezeBalanceV2Contract" + - "WithdrawExpireUnfreezeContract" + - "DelegateResourceContract" + - "UnDelegateResourceContract" + - "CancelAllUnfreezeV2Contract" + "description": "Account, contract, or resource type." + "parameter": + "type": "object" + "additionalProperties": false + "properties": + "type_url": + "type": "string" + "value": + "oneOf": + - + "$ref": "#/components/schemas/AccountCreateContract" + - + "$ref": "#/components/schemas/AccountPermissionUpdateContract" + - + "$ref": "#/components/schemas/AccountUpdateContract" + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/CancelAllUnfreezeV2Contract" + - + "$ref": "#/components/schemas/ClearABIContract" + - + "$ref": "#/components/schemas/CreateSmartContract" + - + "$ref": "#/components/schemas/DelegateResourceContract" + - + "$ref": "#/components/schemas/ExchangeCreateContract" + - + "$ref": "#/components/schemas/ExchangeInjectContract" + - + "$ref": "#/components/schemas/ExchangeTransactionContract" + - + "$ref": "#/components/schemas/ExchangeWithdrawContract" + - + "$ref": "#/components/schemas/FreezeBalanceContract" + - + "$ref": "#/components/schemas/FreezeBalanceV2Contract" + - + "$ref": "#/components/schemas/MarketCancelOrderContract" + - + "$ref": "#/components/schemas/MarketSellAssetContract" + - + "$ref": "#/components/schemas/ParticipateAssetIssueContract" + - + "$ref": "#/components/schemas/ProposalApproveContract" + - + "$ref": "#/components/schemas/ProposalCreateContract" + - + "$ref": "#/components/schemas/ProposalDeleteContract" + - + "$ref": "#/components/schemas/SetAccountIdContract" + - + "$ref": "#/components/schemas/ShieldedTransferContract" + - + "$ref": "#/components/schemas/TransferAssetContract" + - + "$ref": "#/components/schemas/TransferContract" + - + "$ref": "#/components/schemas/TriggerSmartContract" + - + "$ref": "#/components/schemas/UnDelegateResourceContract" + - + "$ref": "#/components/schemas/UnfreezeAssetContract" + - + "$ref": "#/components/schemas/UnfreezeBalanceContract" + - + "$ref": "#/components/schemas/UnfreezeBalanceV2Contract" + - + "$ref": "#/components/schemas/UpdateAssetContract" + - + "$ref": "#/components/schemas/UpdateBrokerageContract" + - + "$ref": "#/components/schemas/UpdateEnergyLimitContract" + - + "$ref": "#/components/schemas/UpdateSettingContract" + - + "$ref": "#/components/schemas/VoteWitnessContract" + - + "$ref": "#/components/schemas/WithdrawBalanceContract" + - + "$ref": "#/components/schemas/WithdrawExpireUnfreezeContract" + - + "$ref": "#/components/schemas/WitnessCreateContract" + - + "$ref": "#/components/schemas/WitnessUpdateContract" + - + "type": "null" + "title": "TransactionContractNull39" + "description": "Hex string, amount, or value field accepted by this endpoint." + "required": + - "type_url" + - "value" + "x-java-response": "Transaction.Contract.parameter rendered by Util.printTransactionToJSON" + "description": "Contract parameter payload." + "provider": + "type": "string" + "ContractName": + "type": "string" + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "Transaction.Contract" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "TransactionRaw": + "type": "object" + "additionalProperties": false + "properties": + "ref_block_bytes": + "type": "string" + "ref_block_num": + "type": "integer" + "format": "int64" + "ref_block_hash": + "type": "string" + "expiration": + "type": "integer" + "format": "int64" + "auths": + "type": "array" + "items": + "$ref": "#/components/schemas/Authority" + "data": + "type": "string" + "description": "Hex-encoded contract call data or transaction data." + "contract": + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionContract" + "scripts": + "type": "string" + "timestamp": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "fee_limit": + "type": "integer" + "format": "int64" + "description": "Maximum fee in sun for smart contract execution." + "x-proto-message": "Transaction.raw" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "description": "Transaction raw data object." + "Transaction": + "type": "object" + "additionalProperties": false + "properties": + "txID": + "type": "string" + "raw_data": + "$ref": "#/components/schemas/TransactionRaw" + "raw_data_hex": + "type": "string" + "description": "Hex-encoded transaction raw data." + "signature": + "type": "array" + "items": + "type": "string" + "description": "Transaction signatures." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "contract_address": + "type": "string" + "description": "Smart contract address." + "x-java-response": "protocol.Transaction rendered by Util.printCreateTransaction" + "x-source-shape": "transaction-json" + "Return": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "enum": + - "SUCCESS" + - "SIGERROR" + - "CONTRACT_VALIDATE_ERROR" + - "CONTRACT_EXE_ERROR" + - "BANDWITH_ERROR" + - "DUP_TRANSACTION_ERROR" + - "TAPOS_ERROR" + - "TOO_BIG_TRANSACTION_ERROR" + - "TRANSACTION_EXPIRATION_ERROR" + - "SERVER_BUSY" + - "NO_CONNECTION" + - "NOT_ENOUGH_EFFECTIVE_CONNECTION" + - "BLOCK_UNSOLIDIFIED" + - "OTHER_ERROR" + "message": + "type": "string" + "x-proto-message": "Return" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "TransactionInfoLog": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "topics": + "type": "array" + "items": + "type": "string" + "description": "Log topics filter." + "data": + "type": "string" + "description": "Hex-encoded contract call data or transaction data." + "x-proto-message": "TransactionInfo.Log" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "InternalTransactionCallValueInfo": + "type": "object" + "additionalProperties": false + "properties": + "callValue": + "type": "integer" + "format": "int64" + "tokenId": + "type": "string" + "description": "TRC10 token id." + "x-proto-message": "InternalTransaction.CallValueInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "InternalTransaction": + "type": "object" + "additionalProperties": false + "properties": + "hash": + "type": "string" + "description": "Block or transaction hash." + "caller_address": + "type": "string" + "transferTo_address": + "type": "string" + "callValueInfo": + "type": "array" + "items": + "$ref": "#/components/schemas/InternalTransactionCallValueInfo" + "note": + "type": "string" + "rejected": + "type": "boolean" + "extra": + "type": "string" + "x-proto-message": "InternalTransaction" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "TransactionExtention": + "type": "object" + "additionalProperties": false + "properties": + "transaction": + "$ref": "#/components/schemas/Transaction" + "txid": + "type": "string" + "constant_result": + "type": "array" + "items": + "type": "string" + "result": + "$ref": "#/components/schemas/Return" + "energy_used": + "type": "integer" + "format": "int64" + "logs": + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionInfoLog" + "internal_transactions": + "type": "array" + "items": + "$ref": "#/components/schemas/InternalTransaction" + "energy_penalty": + "type": "integer" + "format": "int64" + "x-proto-message": "TransactionExtention" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "TransactionExtention rendered by Util.printTransactionExtention" + "TransactionSignWeightResult": + "type": "object" + "additionalProperties": false + "properties": + "code": + "type": "string" + "enum": + - "ENOUGH_PERMISSION" + - "NOT_ENOUGH_PERMISSION" + - "SIGNATURE_FORMAT_ERROR" + - "COMPUTE_ADDRESS_ERROR" + - "PERMISSION_ERROR" + - "OTHER_ERROR" + "message": + "type": "string" + "x-proto-message": "TransactionSignWeight.Result" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "TransactionSignWeight": + "type": "object" + "additionalProperties": false + "properties": + "permission": + "$ref": "#/components/schemas/Permission" + "approved_list": + "type": "array" + "items": + "type": "string" + "current_weight": + "type": "integer" + "format": "int64" + "result": + "$ref": "#/components/schemas/TransactionSignWeightResult" + "transaction": + "$ref": "#/components/schemas/TransactionExtention" + "x-proto-message": "TransactionSignWeight" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "TransactionSignWeight rendered by Util.printTransactionSignWeight" + "TransactionApprovedListResult": + "type": "object" + "additionalProperties": false + "properties": + "code": + "type": "string" + "enum": + - "SUCCESS" + - "SIGNATURE_FORMAT_ERROR" + - "COMPUTE_ADDRESS_ERROR" + - "OTHER_ERROR" + "message": + "type": "string" + "x-proto-message": "TransactionApprovedList.Result" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "TransactionApprovedList": + "type": "object" + "additionalProperties": false + "properties": + "approved_list": + "type": "array" + "items": + "type": "string" + "result": + "$ref": "#/components/schemas/TransactionApprovedListResult" + "transaction": + "$ref": "#/components/schemas/TransactionExtention" + "x-proto-message": "TransactionApprovedList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "TransactionApprovedList rendered by Util.printTransactionApprovedList" + "Vote": + "type": "object" + "additionalProperties": false + "properties": + "vote_address": + "type": "string" + "vote_count": + "type": "integer" + "format": "int64" + "x-proto-message": "Vote" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "AccountFrozen": + "type": "object" + "additionalProperties": false + "properties": + "frozen_balance": + "type": "integer" + "format": "int64" + "description": "Amount to freeze in sun, where 1 TRX equals 1,000,000 sun." + "expire_time": + "type": "integer" + "format": "int64" + "x-proto-message": "Account.Frozen" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "AccountAccountResource": + "type": "object" + "additionalProperties": false + "properties": + "energy_usage": + "type": "integer" + "format": "int64" + "frozen_balance_for_energy": + "$ref": "#/components/schemas/AccountFrozen" + "latest_consume_time_for_energy": + "type": "integer" + "format": "int64" + "acquired_delegated_frozen_balance_for_energy": + "type": "integer" + "format": "int64" + "delegated_frozen_balance_for_energy": + "type": "integer" + "format": "int64" + "storage_limit": + "type": "integer" + "format": "int64" + "storage_usage": + "type": "integer" + "format": "int64" + "latest_exchange_storage_time": + "type": "integer" + "format": "int64" + "energy_window_size": + "type": "integer" + "format": "int64" + "delegated_frozenV2_balance_for_energy": + "type": "integer" + "format": "int64" + "acquired_delegated_frozenV2_balance_for_energy": + "type": "integer" + "format": "int64" + "energy_window_optimized": + "type": "boolean" + "x-proto-message": "Account.AccountResource" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "AccountFreezeV2": + "type": "object" + "additionalProperties": false + "properties": + "type": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Account, contract, or resource type." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "x-proto-message": "Account.FreezeV2" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "AccountUnFreezeV2": + "type": "object" + "additionalProperties": false + "properties": + "type": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Account, contract, or resource type." + "unfreeze_amount": + "type": "integer" + "format": "int64" + "unfreeze_expire_time": + "type": "integer" + "format": "int64" + "x-proto-message": "Account.UnFreezeV2" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "Account": + "type": "object" + "additionalProperties": false + "properties": + "account_name": + "type": "string" + "description": "New account name encoded as expected by java-tron." + "type": + "type": "string" + "enum": + - "Normal" + - "AssetIssue" + - "Contract" + "description": "Account, contract, or resource type." + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "balance": + "type": "integer" + "format": "int64" + "description": "Resource amount in sun, where 1 TRX equals 1,000,000 sun." + "votes": + "type": "array" + "items": + "$ref": "#/components/schemas/Vote" + "description": "Witness vote entries." + "frozen": + "type": "array" + "items": + "$ref": "#/components/schemas/AccountFrozen" + "net_usage": + "type": "integer" + "format": "int64" + "acquired_delegated_frozen_balance_for_bandwidth": + "type": "integer" + "format": "int64" + "delegated_frozen_balance_for_bandwidth": + "type": "integer" + "format": "int64" + "old_tron_power": + "type": "integer" + "format": "int64" + "tron_power": + "$ref": "#/components/schemas/AccountFrozen" + "asset_optimized": + "type": "boolean" + "create_time": + "type": "integer" + "format": "int64" + "latest_opration_time": + "type": "integer" + "format": "int64" + "allowance": + "type": "integer" + "format": "int64" + "latest_withdraw_time": + "type": "integer" + "format": "int64" + "code": + "type": "string" + "is_witness": + "type": "boolean" + "is_committee": + "type": "boolean" + "frozen_supply": + "type": "array" + "items": + "$ref": "#/components/schemas/AccountFrozen" + "description": "Frozen supply schedules for an asset issue." + "asset_issued_name": + "type": "string" + "asset_issued_ID": + "type": "string" + "free_net_usage": + "type": "integer" + "format": "int64" + "latest_consume_time": + "type": "integer" + "format": "int64" + "latest_consume_free_time": + "type": "integer" + "format": "int64" + "account_id": + "type": "string" + "net_window_size": + "type": "integer" + "format": "int64" + "net_window_optimized": + "type": "boolean" + "account_resource": + "$ref": "#/components/schemas/AccountAccountResource" + "codeHash": + "type": "string" + "owner_permission": + "$ref": "#/components/schemas/Permission" + "witness_permission": + "$ref": "#/components/schemas/Permission" + "active_permission": + "type": "array" + "items": + "$ref": "#/components/schemas/Permission" + "frozenV2": + "type": "array" + "items": + "$ref": "#/components/schemas/AccountFreezeV2" + "unfrozenV2": + "type": "array" + "items": + "$ref": "#/components/schemas/AccountUnFreezeV2" + "delegated_frozenV2_balance_for_bandwidth": + "type": "integer" + "format": "int64" + "acquired_delegated_frozenV2_balance_for_bandwidth": + "type": "integer" + "format": "int64" + "asset": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "assetV2": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "latest_asset_operation_time": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "latest_asset_operation_timeV2": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "free_asset_net_usage": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "free_asset_net_usageV2": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "x-proto-message": "Account" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response": "Account rendered by java-tron JSON printer" + "AccountNetMessage": + "type": "object" + "additionalProperties": false + "properties": + "freeNetUsed": + "type": "integer" + "format": "int64" + "freeNetLimit": + "type": "integer" + "format": "int64" + "NetUsed": + "type": "integer" + "format": "int64" + "NetLimit": + "type": "integer" + "format": "int64" + "TotalNetLimit": + "type": "integer" + "format": "int64" + "TotalNetWeight": + "type": "integer" + "format": "int64" + "assetNetUsed": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "assetNetLimit": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "x-proto-message": "AccountNetMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "AccountNetMessage rendered by java-tron JSON printer" + "AccountResourceMessage": + "type": "object" + "additionalProperties": false + "properties": + "freeNetUsed": + "type": "integer" + "format": "int64" + "freeNetLimit": + "type": "integer" + "format": "int64" + "NetUsed": + "type": "integer" + "format": "int64" + "NetLimit": + "type": "integer" + "format": "int64" + "TotalNetLimit": + "type": "integer" + "format": "int64" + "TotalNetWeight": + "type": "integer" + "format": "int64" + "TotalTronPowerWeight": + "type": "integer" + "format": "int64" + "tronPowerUsed": + "type": "integer" + "format": "int64" + "tronPowerLimit": + "type": "integer" + "format": "int64" + "EnergyUsed": + "type": "integer" + "format": "int64" + "EnergyLimit": + "type": "integer" + "format": "int64" + "TotalEnergyLimit": + "type": "integer" + "format": "int64" + "TotalEnergyWeight": + "type": "integer" + "format": "int64" + "storageUsed": + "type": "integer" + "format": "int64" + "storageLimit": + "type": "integer" + "format": "int64" + "assetNetUsed": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "assetNetLimit": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "x-proto-message": "AccountResourceMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "AccountResourceMessage rendered by java-tron JSON printer" + "AssetIssueList": + "type": "object" + "additionalProperties": false + "properties": + "assetIssue": + "type": "array" + "items": + "$ref": "#/components/schemas/AssetIssueContract" + "x-proto-message": "AssetIssueList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "AssetIssueList rendered by java-tron JSON printer" + "BlockHeaderRaw": + "type": "object" + "additionalProperties": false + "properties": + "timestamp": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "txTrieRoot": + "type": "string" + "parentHash": + "type": "string" + "number": + "type": "integer" + "format": "int64" + "description": "Block number or numeric query value." + "witness_id": + "type": "integer" + "format": "int64" + "witness_address": + "type": "string" + "version": + "type": "integer" + "format": "int32" + "accountStateRoot": + "type": "string" + "x-proto-message": "BlockHeader.raw" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "description": "Transaction raw data object." + "BlockHeader": + "type": "object" + "additionalProperties": false + "properties": + "raw_data": + "$ref": "#/components/schemas/BlockHeaderRaw" + "witness_signature": + "type": "string" + "x-proto-message": "BlockHeader" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "Block": + "type": "object" + "additionalProperties": false + "properties": + "transactions": + "type": "array" + "items": + "$ref": "#/components/schemas/Transaction" + "block_header": + "$ref": "#/components/schemas/BlockHeader" + "blockID": + "type": "string" + "description": "Block id injected by Util.printBlockToJSON." + "x-proto-message": "Block" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response": "Block rendered by java-tron JSON printer" + "BlockList": + "type": "object" + "additionalProperties": false + "properties": + "block": + "type": "array" + "items": + "$ref": "#/components/schemas/Block" + "x-proto-message": "BlockList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "BlockList rendered by java-tron JSON printer" + "DelegatedResourceAccountIndex": + "type": "object" + "additionalProperties": false + "properties": + "account": + "type": "string" + "fromAccounts": + "type": "array" + "items": + "type": "string" + "toAccounts": + "type": "array" + "items": + "type": "string" + "timestamp": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "x-proto-message": "DelegatedResourceAccountIndex" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response": "DelegatedResourceAccountIndex rendered by java-tron JSON printer" + "DelegatedResource": + "type": "object" + "additionalProperties": false + "properties": + "from": + "type": "string" + "description": "Sender account address." + "to": + "type": "string" + "description": "Recipient account or contract address." + "frozen_balance_for_bandwidth": + "type": "integer" + "format": "int64" + "frozen_balance_for_energy": + "type": "integer" + "format": "int64" + "expire_time_for_bandwidth": + "type": "integer" + "format": "int64" + "expire_time_for_energy": + "type": "integer" + "format": "int64" + "x-proto-message": "DelegatedResource" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "DelegatedResourceList": + "type": "object" + "additionalProperties": false + "properties": + "delegatedResource": + "type": "array" + "items": + "$ref": "#/components/schemas/DelegatedResource" + "x-proto-message": "DelegatedResourceList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "DelegatedResourceList rendered by java-tron JSON printer" + "PricesResponseMessage": + "type": "object" + "additionalProperties": false + "properties": + "prices": + "type": "string" + "x-proto-message": "PricesResponseMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "PricesResponseMessage rendered by java-tron JSON printer" + "Proposal": + "type": "object" + "additionalProperties": false + "properties": + "proposal_id": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "proposer_address": + "type": "string" + "expiration_time": + "type": "integer" + "format": "int64" + "create_time": + "type": "integer" + "format": "int64" + "approvals": + "type": "array" + "items": + "type": "string" + "state": + "type": "string" + "enum": + - "PENDING" + - "DISAPPROVED" + - "APPROVED" + - "CANCELED" + "parameters": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "description": "Proposal parameter map." + "x-proto-message": "Proposal" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response": "Proposal rendered by java-tron JSON printer" + "ProposalList": + "type": "object" + "additionalProperties": false + "properties": + "proposals": + "type": "array" + "items": + "$ref": "#/components/schemas/Proposal" + "x-proto-message": "ProposalList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "ProposalList rendered by java-tron JSON printer" + "SmartContractABIEntryParam": + "type": "object" + "additionalProperties": false + "properties": + "indexed": + "type": "boolean" + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "type": + "type": "string" + "description": "Account, contract, or resource type." + "x-proto-message": "SmartContract.ABI.Entry.Param" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "SmartContractABIEntry": + "type": "object" + "additionalProperties": false + "properties": + "anonymous": + "type": "boolean" + "constant": + "type": "boolean" + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "inputs": + "type": "array" + "items": + "$ref": "#/components/schemas/SmartContractABIEntryParam" + "outputs": + "type": "array" + "items": + "$ref": "#/components/schemas/SmartContractABIEntryParam" + "type": + "type": "string" + "enum": + - "UnknownEntryType" + - "Constructor" + - "Function" + - "Event" + - "Fallback" + - "Receive" + - "Error" + "description": "Account, contract, or resource type." + "payable": + "type": "boolean" + "stateMutability": + "type": "string" + "enum": + - "UnknownMutabilityType" + - "Pure" + - "View" + - "Nonpayable" + - "Payable" + "x-proto-message": "SmartContract.ABI.Entry" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "SmartContractABI": + "type": "object" + "additionalProperties": false + "properties": + "entrys": + "type": "array" + "items": + "$ref": "#/components/schemas/SmartContractABIEntry" + "x-proto-message": "SmartContract.ABI" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "description": "Smart contract ABI definition." + "SmartContract": + "type": "object" + "additionalProperties": false + "properties": + "origin_address": + "type": "string" + "contract_address": + "type": "string" + "description": "Smart contract address." + "abi": + "$ref": "#/components/schemas/SmartContractABI" + "bytecode": + "type": "string" + "description": "Compiled smart contract bytecode." + "call_value": + "type": "integer" + "format": "int64" + "description": "TRX amount in sun transferred with the smart contract call." + "consume_user_resource_percent": + "type": "integer" + "format": "int64" + "description": "Percentage of contract execution resource cost paid by the user." + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "origin_energy_limit": + "type": "integer" + "format": "int64" + "description": "Origin energy limit for a deployed smart contract." + "code_hash": + "type": "string" + "trx_hash": + "type": "string" + "version": + "type": "integer" + "format": "int32" + "x-proto-message": "SmartContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-java-response": "SmartContract rendered by java-tron JSON printer" + "ResourceReceipt": + "type": "object" + "additionalProperties": false + "properties": + "energy_usage": + "type": "integer" + "format": "int64" + "energy_fee": + "type": "integer" + "format": "int64" + "origin_energy_usage": + "type": "integer" + "format": "int64" + "energy_usage_total": + "type": "integer" + "format": "int64" + "net_usage": + "type": "integer" + "format": "int64" + "net_fee": + "type": "integer" + "format": "int64" + "result": + "type": "string" + "enum": + - "DEFAULT" + - "SUCCESS" + - "REVERT" + - "BAD_JUMP_DESTINATION" + - "OUT_OF_MEMORY" + - "PRECOMPILED_CONTRACT" + - "STACK_TOO_SMALL" + - "STACK_TOO_LARGE" + - "ILLEGAL_OPERATION" + - "STACK_OVERFLOW" + - "OUT_OF_ENERGY" + - "OUT_OF_TIME" + - "JVM_STACK_OVER_FLOW" + - "UNKNOWN" + - "TRANSFER_FAILED" + - "INVALID_CODE" + "energy_penalty_total": + "type": "integer" + "format": "int64" + "x-proto-message": "ResourceReceipt" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "MarketOrderDetail": + "type": "object" + "additionalProperties": false + "properties": + "makerOrderId": + "type": "string" + "takerOrderId": + "type": "string" + "fillSellQuantity": + "type": "integer" + "format": "int64" + "fillBuyQuantity": + "type": "integer" + "format": "int64" + "x-proto-message": "MarketOrderDetail" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "TransactionInfo": + "type": "object" + "additionalProperties": false + "properties": + "id": + "type": "string" + "description": "Identifier used by this query." + "fee": + "type": "integer" + "format": "int64" + "blockNumber": + "type": "integer" + "format": "int64" + "description": "Hex-encoded block number." + "blockTimeStamp": + "type": "integer" + "format": "int64" + "contractResult": + "type": "array" + "items": + "type": "string" + "contract_address": + "type": "string" + "description": "Smart contract address." + "receipt": + "$ref": "#/components/schemas/ResourceReceipt" + "log": + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionInfoLog" + "result": + "type": "string" + "enum": + - "SUCESS" + - "FAILED" + "resMessage": + "type": "string" + "assetIssueID": + "type": "string" + "withdraw_amount": + "type": "integer" + "format": "int64" + "unfreeze_amount": + "type": "integer" + "format": "int64" + "internal_transactions": + "type": "array" + "items": + "$ref": "#/components/schemas/InternalTransaction" + "exchange_received_amount": + "type": "integer" + "format": "int64" + "exchange_inject_another_amount": + "type": "integer" + "format": "int64" + "exchange_withdraw_another_amount": + "type": "integer" + "format": "int64" + "exchange_id": + "type": "integer" + "format": "int64" + "shielded_transaction_fee": + "type": "integer" + "format": "int64" + "orderId": + "type": "string" + "orderDetails": + "type": "array" + "items": + "$ref": "#/components/schemas/MarketOrderDetail" + "packingFee": + "type": "integer" + "format": "int64" + "withdraw_expire_amount": + "type": "integer" + "format": "int64" + "cancel_unfreezeV2_amount": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "x-proto-message": "TransactionInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response": "TransactionInfo rendered by java-tron JSON printer" + "Witness": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "voteCount": + "type": "integer" + "format": "int64" + "pubKey": + "type": "string" + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "totalProduced": + "type": "integer" + "format": "int64" + "totalMissed": + "type": "integer" + "format": "int64" + "latestBlockNum": + "type": "integer" + "format": "int64" + "latestSlotNum": + "type": "integer" + "format": "int64" + "isJobs": + "type": "boolean" + "x-proto-message": "Witness" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "WitnessList": + "type": "object" + "additionalProperties": false + "properties": + "witnesses": + "type": "array" + "items": + "$ref": "#/components/schemas/Witness" + "x-proto-message": "WitnessList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response": "WitnessList rendered by java-tron JSON printer" + "AccountRequest": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-effective-input" + "x-java-request-type": "org.tron.protos.Protocol.Account" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "address" + "BlockBalanceTraceBlockIdentifier": + "type": "object" + "additionalProperties": false + "properties": + "hash": + "type": "string" + "description": "Block or transaction hash." + "number": + "type": "integer" + "format": "int64" + "description": "Block number or numeric query value." + "x-proto-message": "BlockBalanceTrace.BlockIdentifier" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "description": "Block identifier used by the query." + "AccountBalanceResponse": + "type": "object" + "additionalProperties": false + "properties": + "balance": + "type": "integer" + "format": "int64" + "description": "Resource amount in sun, where 1 TRX equals 1,000,000 sun." + "block_identifier": + "$ref": "#/components/schemas/BlockBalanceTraceBlockIdentifier" + "x-proto-message": "AccountBalanceResponse" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-java-response-type": "BalanceContract.AccountBalanceResponse" + "x-java-response": "AccountBalanceResponse rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "AccountIdentifier": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-proto-message": "AccountIdentifier" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "description": "Account identifier used by the query." + "AccountBalanceRequestRequest": + "type": "object" + "additionalProperties": false + "properties": + "account_identifier": + "$ref": "#/components/schemas/AccountIdentifier" + "block_identifier": + "$ref": "#/components/schemas/BlockBalanceTraceBlockIdentifier" + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "AccountBalanceRequest" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "AccountBalanceRequest" + "x-java-unknown-fields": "ignored-by-jsonformat" + "AccountCreateContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "account_address": + "type": "string" + "description": "Address of the account to create." + "type": + "type": "string" + "enum": + - "Normal" + - "AssetIssue" + - "Contract" + "description": "Account, contract, or resource type." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "AccountCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AccountContract.AccountCreateContract" + "required": + - "owner_address" + - "account_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "AccountUpdateContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "account_name": + "type": "string" + "description": "New account name encoded as expected by java-tron." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "AccountUpdateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AccountContract.AccountUpdateContract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "AccountPermissionUpdateContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "owner": + "$ref": "#/components/schemas/Permission" + "witness": + "$ref": "#/components/schemas/Permission" + "actives": + "type": "array" + "items": + "$ref": "#/components/schemas/Permission" + "description": "Active permission definitions for account permission update." + "minItems": 1 + "maxItems": 8 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "AccountPermissionUpdateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/account_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AccountContract.AccountPermissionUpdateContract" + "required": + - "owner_address" + - "owner" + - "actives" + "x-java-unknown-fields": "ignored-by-jsonformat" + "BlockReqRequest": + "type": "object" + "additionalProperties": false + "properties": + "id_or_num": + "type": "string" + "description": "Block id or block number." + "detail": + "type": "boolean" + "description": "Whether to return detailed block information." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "BlockReq" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.api.GrpcAPI.BlockReq" + "x-java-unknown-fields": "ignored-by-jsonformat" + "NumberMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "num": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "NumberMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.api.GrpcAPI.NumberMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "BytesMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "BytesMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.api.GrpcAPI.BytesMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "BlockLimitRequest": + "type": "object" + "additionalProperties": false + "properties": + "startNum": + "type": "integer" + "format": "int64" + "description": "Starting block number for the query range." + "endNum": + "type": "integer" + "format": "int64" + "description": "Ending block number for the query range." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "BlockLimit" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.api.GrpcAPI.BlockLimit" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "endNum" + - "startNum" + "TransactionBalanceTraceOperation": + "type": "object" + "additionalProperties": false + "properties": + "operation_identifier": + "type": "integer" + "format": "int64" + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "x-proto-message": "TransactionBalanceTrace.Operation" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "TransactionBalanceTrace": + "type": "object" + "additionalProperties": false + "properties": + "transaction_identifier": + "type": "string" + "operation": + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionBalanceTraceOperation" + "type": + "type": "string" + "description": "Account, contract, or resource type." + "status": + "type": "string" + "x-proto-message": "TransactionBalanceTrace" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "BlockBalanceTrace": + "type": "object" + "additionalProperties": false + "properties": + "block_identifier": + "$ref": "#/components/schemas/BlockBalanceTraceBlockIdentifier" + "timestamp": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "transaction_balance_trace": + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionBalanceTrace" + "x-proto-message": "BlockBalanceTrace" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-java-response-type": "org.tron.protos.contract.BalanceContract.BlockBalanceTrace" + "x-java-response": "BlockBalanceTrace rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "BlockIdentifierRequest": + "type": "object" + "additionalProperties": false + "properties": + "hash": + "type": "string" + "description": "Block or transaction hash." + "number": + "type": "integer" + "format": "int64" + "description": "Block number or numeric query value." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "BlockBalanceTrace.BlockIdentifier" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "BlockIdentifier" + "x-java-unknown-fields": "ignored-by-jsonformat" + "TransactionIdList": + "type": "object" + "additionalProperties": false + "properties": + "txId": + "type": "array" + "items": + "type": "string" + "x-proto-message": "TransactionIdList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response-type": "org.tron.api.GrpcAPI.TransactionIdList" + "x-java-response": "TransactionIdList rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "TransferContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "to_address": + "type": "string" + "description": "Destination account address." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "extra_data": + "type": "string" + "description": "Extra transaction data encoded as expected by java-tron." + "x-proto-message": "TransferContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.TransferContract" + "required": + - "owner_address" + - "to_address" + - "amount" + "x-java-unknown-fields": "ignored-by-jsonformat" + "TransactionRequest": + "type": "object" + "additionalProperties": false + "properties": + "raw_data": + "$ref": "#/components/schemas/TransactionRaw" + "raw_data_hex": + "type": "string" + "description": "Hex-encoded transaction raw data." + "signature": + "type": "array" + "items": + "type": "string" + "description": "Transaction signatures." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "pack-transaction-json" + "required": + - "raw_data" + "x-java-required-by": "Util.packTransaction reads raw_data.contract" + "x-java-request-type": "org.tron.protos.Protocol.Transaction" + "x-java-unknown-fields": "ignored-by-jsonformat" + "AssetIssueContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "id": + "type": "string" + "description": "Identifier used by this query." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "abbr": + "type": "string" + "description": "Asset abbreviation." + "total_supply": + "type": "integer" + "format": "int64" + "description": "Total asset supply." + "minimum": 1 + "frozen_supply": + "type": "array" + "items": + "allOf": + - + "$ref": "#/components/schemas/AssetIssueContractFrozenSupply" + "required": + - "frozen_amount" + - "frozen_days" + "description": "Frozen supply schedules for an asset issue." + "trx_num": + "type": "integer" + "format": "int32" + "description": "TRX amount used in the asset issue exchange ratio." + "minimum": 1 + "precision": + "type": "integer" + "format": "int32" + "description": "Asset precision." + "num": + "type": "integer" + "format": "int32" + "description": "Number of items or blocks to return." + "minimum": 1 + "start_time": + "type": "integer" + "format": "int64" + "description": "Start timestamp in milliseconds." + "minimum": 1 + "end_time": + "type": "integer" + "format": "int64" + "description": "End timestamp in milliseconds." + "minimum": 1 + "order": + "type": "integer" + "format": "int64" + "description": "Sort order." + "vote_score": + "type": "integer" + "format": "int32" + "description": "Vote count or vote weight." + "description": + "type": "string" + "description": "Human-readable description for this object." + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "free_asset_net_limit": + "type": "integer" + "format": "int64" + "description": "Free asset bandwidth limit for each account." + "minimum": 0 + "public_free_asset_net_limit": + "type": "integer" + "format": "int64" + "description": "Public free asset bandwidth limit." + "minimum": 0 + "public_free_asset_net_usage": + "type": "integer" + "format": "int64" + "description": "Public free asset bandwidth usage." + "const": 0 + "public_latest_free_net_time": + "type": "integer" + "format": "int64" + "description": "Latest public free bandwidth usage timestamp." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "AssetIssueContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AssetIssueContractOuterClass.AssetIssueContract" + "required": + - "owner_address" + - "name" + - "total_supply" + - "trx_num" + - "num" + - "start_time" + - "end_time" + - "url" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UpdateAssetContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "description": + "type": "string" + "description": "Human-readable description for this object." + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "new_limit": + "type": "integer" + "format": "int64" + "description": "New account resource limit." + "minimum": 0 + "new_public_limit": + "type": "integer" + "format": "int64" + "description": "New public resource limit." + "minimum": 0 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UpdateAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AssetIssueContractOuterClass.UpdateAssetContract" + "required": + - "owner_address" + - "url" + "x-java-unknown-fields": "ignored-by-jsonformat" + "TransferAssetContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "asset_name": + "type": "string" + "description": "Asset name or token identifier encoded as expected by java-tron." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "to_address": + "type": "string" + "description": "Destination account address." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "extra_data": + "type": "string" + "description": "Extra transaction data encoded as expected by java-tron." + "x-proto-message": "TransferAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AssetIssueContractOuterClass.TransferAssetContract" + "required": + - "asset_name" + - "owner_address" + - "to_address" + - "amount" + "x-java-unknown-fields": "ignored-by-jsonformat" + "ParticipateAssetIssueContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "to_address": + "type": "string" + "description": "Destination account address." + "asset_name": + "type": "string" + "description": "Asset name or token identifier encoded as expected by java-tron." + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "ParticipateAssetIssueContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AssetIssueContractOuterClass.ParticipateAssetIssueContract" + "required": + - "owner_address" + - "to_address" + - "asset_name" + - "amount" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UnfreezeAssetContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UnfreezeAssetContract" + "x-proto-file": "protocol/src/main/protos/core/contract/asset_issue_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.AssetIssueContractOuterClass.UnfreezeAssetContract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "PaginatedMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "offset": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "limit": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "PaginatedMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.api.GrpcAPI.PaginatedMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "limit" + - "offset" + "CreateSmartContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "call_token_value": + "type": "integer" + "format": "int64" + "description": "TRC10 token amount transferred with the smart contract call." + "token_id": + "type": "integer" + "format": "int64" + "description": "TRC10 token id." + "abi": + "type": "array" + "description": "Smart contract ABI definition." + "items": + "type": "object" + "additionalProperties": false + "properties": + "anonymous": + "type": "boolean" + "constant": + "type": "boolean" + "name": + "type": "string" + "inputs": + "type": "array" + "items": + "type": "object" + "additionalProperties": false + "properties": + "indexed": + "type": "boolean" + "name": + "type": "string" + "type": + "type": "string" + "outputs": + "type": "array" + "items": + "type": "object" + "additionalProperties": false + "properties": + "indexed": + "type": "boolean" + "name": + "type": "string" + "type": + "type": "string" + "type": + "type": "string" + "enum": + - "UnknownEntryType" + - "Constructor" + - "Function" + - "Event" + - "Fallback" + - "Receive" + - "Error" + "payable": + "type": "boolean" + "stateMutability": + "type": "string" + "enum": + - "UnknownMutabilityType" + - "Pure" + - "View" + - "Nonpayable" + - "Payable" + "bytecode": + "type": "string" + "description": "Compiled smart contract bytecode." + "parameter": + "type": "string" + "description": "Contract parameter payload." + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "call_value": + "type": "integer" + "format": "int64" + "description": "TRX amount in sun transferred with the smart contract call." + "consume_user_resource_percent": + "type": "integer" + "format": "int64" + "description": "Percentage of contract execution resource cost paid by the user." + "origin_energy_limit": + "type": "integer" + "format": "int64" + "description": "Origin energy limit for a deployed smart contract." + "fee_limit": + "type": "integer" + "format": "int64" + "description": "Maximum fee in sun for smart contract execution." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "CreateSmartContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.SmartContractOuterClass.CreateSmartContract" + "required": + - "owner_address" + - "bytecode" + "x-java-unknown-fields": "ignored-by-jsonformat" + "TriggerSmartContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "call_value": + "type": "integer" + "format": "int64" + "description": "TRX amount in sun transferred with the smart contract call." + "data": + "type": "string" + "description": "Hex-encoded contract call data or transaction data." + "call_token_value": + "type": "integer" + "format": "int64" + "description": "TRC10 token amount transferred with the smart contract call." + "token_id": + "type": "integer" + "format": "int64" + "description": "TRC10 token id." + "fee_limit": + "type": "integer" + "format": "int64" + "description": "Maximum fee in sun for smart contract execution." + "function_selector": + "type": "string" + "description": "Smart contract function selector, for example transfer(address,uint256)." + "parameter": + "type": "string" + "description": "Contract parameter payload." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "TriggerSmartContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.SmartContractOuterClass.TriggerSmartContract" + "required": + - "owner_address" + - "contract_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "ContractState": + "type": "object" + "additionalProperties": false + "properties": + "energy_usage": + "type": "integer" + "format": "int64" + "energy_factor": + "type": "integer" + "format": "int64" + "update_cycle": + "type": "integer" + "format": "int64" + "x-proto-message": "ContractState" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "SmartContractDataWrapper": + "type": "object" + "additionalProperties": false + "properties": + "smart_contract": + "$ref": "#/components/schemas/SmartContract" + "runtimecode": + "type": "string" + "contract_state": + "$ref": "#/components/schemas/ContractState" + "x-proto-message": "SmartContractDataWrapper" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-java-response-type": "org.tron.protos.contract.SmartContractOuterClass.SmartContractDataWrapper" + "x-java-response": "SmartContractDataWrapper rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "ClearABIContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "ClearABIContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.SmartContractOuterClass.ClearABIContract" + "required": + - "owner_address" + - "contract_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UpdateSettingContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "consume_user_resource_percent": + "type": "integer" + "format": "int64" + "description": "Percentage of contract execution resource cost paid by the user." + "minimum": 0 + "maximum": 100 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UpdateSettingContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.SmartContractOuterClass.UpdateSettingContract" + "required": + - "owner_address" + - "contract_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UpdateEnergyLimitContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "contract_address": + "type": "string" + "description": "Smart contract address." + "origin_energy_limit": + "type": "integer" + "format": "int64" + "description": "Origin energy limit for a deployed smart contract." + "minimum": 1 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UpdateEnergyLimitContract" + "x-proto-file": "protocol/src/main/protos/core/contract/smart_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.SmartContractOuterClass.UpdateEnergyLimitContract" + "required": + - "owner_address" + - "contract_address" + - "origin_energy_limit" + "x-java-unknown-fields": "ignored-by-jsonformat" + "WitnessCreateContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "url": + "type": "string" + "description": "URL encoded as expected by java-tron." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "WitnessCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.WitnessContract.WitnessCreateContract" + "required": + - "owner_address" + - "url" + "x-java-unknown-fields": "ignored-by-jsonformat" + "WitnessUpdateContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "update_url": + "type": "string" + "description": "Updated URL encoded as expected by java-tron." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "WitnessUpdateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.WitnessContract.WitnessUpdateContract" + "required": + - "owner_address" + - "update_url" + "x-java-unknown-fields": "ignored-by-jsonformat" + "VoteWitnessContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "votes": + "type": "array" + "items": + "$ref": "#/components/schemas/VoteWitnessContractVote" + "description": "Witness vote entries." + "minItems": 1 + "support": + "type": "boolean" + "description": "Proposal support flag." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "VoteWitnessContract" + "x-proto-file": "protocol/src/main/protos/core/contract/witness_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.WitnessContract.VoteWitnessContract" + "required": + - "owner_address" + - "votes" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UpdateBrokerageContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "brokerage": + "type": "integer" + "format": "int32" + "description": "Witness brokerage percentage, from 0 to 100." + "minimum": 0 + "maximum": 100 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UpdateBrokerageContract" + "x-proto-file": "protocol/src/main/protos/core/contract/storage_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.StorageContract.UpdateBrokerageContract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "WithdrawBalanceContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "WithdrawBalanceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.WithdrawBalanceContract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "ProposalCreateContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "parameters": + "type": "object" + "additionalProperties": + "type": "integer" + "format": "int64" + "description": "Proposal parameter map." + "minProperties": 1 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "ProposalCreateContract" + "x-proto-file": "protocol/src/main/protos/core/contract/proposal_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.ProposalContract.ProposalCreateContract" + "required": + - "owner_address" + - "parameters" + "x-java-unknown-fields": "ignored-by-jsonformat" + "ProposalApproveContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "proposal_id": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "minimum": 1 + "is_add_approval": + "type": "boolean" + "description": "Whether to add approval for the proposal." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "ProposalApproveContract" + "x-proto-file": "protocol/src/main/protos/core/contract/proposal_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.ProposalContract.ProposalApproveContract" + "required": + - "owner_address" + - "proposal_id" + "x-java-unknown-fields": "ignored-by-jsonformat" + "ProposalDeleteContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "proposal_id": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "minimum": 1 + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "ProposalDeleteContract" + "x-proto-file": "protocol/src/main/protos/core/contract/proposal_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.ProposalContract.ProposalDeleteContract" + "required": + - "owner_address" + - "proposal_id" + "x-java-unknown-fields": "ignored-by-jsonformat" + "ChainParametersChainParameter": + "type": "object" + "additionalProperties": false + "properties": + "key": + "type": "string" + "value": + "type": "integer" + "format": "int64" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-proto-message": "ChainParameters.ChainParameter" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "ChainParameters": + "type": "object" + "additionalProperties": false + "properties": + "chainParameter": + "type": "array" + "items": + "$ref": "#/components/schemas/ChainParametersChainParameter" + "x-proto-message": "ChainParameters" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response": "ChainParameters rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "NumberMessage": + "type": "object" + "additionalProperties": false + "properties": + "num": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-proto-message": "NumberMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response-type": "org.tron.api.GrpcAPI.NumberMessage" + "x-java-response": "NumberMessage rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "FreezeBalanceContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "frozen_balance": + "type": "integer" + "format": "int64" + "description": "Amount to freeze in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1000000 + "frozen_duration": + "type": "integer" + "format": "int64" + "description": "Freeze duration in days." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type to freeze. TRON_POWER is accepted only when the chain supports the new resource model (`supportAllowNewResourceModel()`)." + "x-chain-condition": + "TRON_POWER": "Requires DynamicPropertiesStore.supportAllowNewResourceModel()" + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "FreezeBalanceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.FreezeBalanceContract" + "required": + - "owner_address" + - "frozen_balance" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UnfreezeBalanceContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type to unfreeze. TRON_POWER is accepted only when the chain supports the new resource model (`supportAllowNewResourceModel()`)." + "x-chain-condition": + "TRON_POWER": "Requires DynamicPropertiesStore.supportAllowNewResourceModel()" + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UnfreezeBalanceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.UnfreezeBalanceContract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "DelegatedResourceMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "fromAddress": + "type": "string" + "description": "Source account address." + "toAddress": + "type": "string" + "description": "Destination account address." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "DelegatedResourceMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.api.GrpcAPI.DelegatedResourceMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "fromAddress" + - "toAddress" + "FreezeBalanceV2ContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "frozen_balance": + "type": "integer" + "format": "int64" + "description": "Amount to freeze in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1000000 + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type to freeze. TRON_POWER is accepted only when the chain supports the new resource model (`supportAllowNewResourceModel()`)." + "x-chain-condition": + "TRON_POWER": "Requires DynamicPropertiesStore.supportAllowNewResourceModel()" + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "FreezeBalanceV2Contract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.FreezeBalanceV2Contract" + "required": + - "owner_address" + - "frozen_balance" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UnfreezeBalanceV2ContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "unfreeze_balance": + "type": "integer" + "format": "int64" + "description": "Amount to unfreeze in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1 + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + - "TRON_POWER" + "description": "Resource type to unfreeze. TRON_POWER is accepted only when the chain supports the new resource model (`supportAllowNewResourceModel()`)." + "x-chain-condition": + "TRON_POWER": "Requires DynamicPropertiesStore.supportAllowNewResourceModel()" + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UnfreezeBalanceV2Contract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.UnfreezeBalanceV2Contract" + "required": + - "owner_address" + - "unfreeze_balance" + "x-java-unknown-fields": "ignored-by-jsonformat" + "WithdrawExpireUnfreezeContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "WithdrawExpireUnfreezeContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.WithdrawExpireUnfreezeContract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "CancelAllUnfreezeV2ContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "CancelAllUnfreezeV2Contract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.CancelAllUnfreezeV2Contract" + "required": + - "owner_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "DelegateResourceContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + "description": "Resource type." + "balance": + "type": "integer" + "format": "int64" + "description": "Resource amount in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1000000 + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "lock": + "type": "boolean" + "description": "Whether delegated resources are locked." + "lock_period": + "type": "integer" + "format": "int64" + "description": "Resource delegation lock period." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "DelegateResourceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.DelegateResourceContract" + "required": + - "owner_address" + - "balance" + - "receiver_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "UnDelegateResourceContractRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "resource": + "type": "string" + "enum": + - "BANDWIDTH" + - "ENERGY" + "description": "Resource type." + "balance": + "type": "integer" + "format": "int64" + "description": "Resource amount in sun, where 1 TRX equals 1,000,000 sun." + "minimum": 1 + "receiver_address": + "type": "string" + "description": "Address of the account receiving resources or funds." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "Permission_id": + "type": "integer" + "format": "int32" + "description": "Permission id used to sign the transaction with a non-owner account permission." + "x-proto-message": "UnDelegateResourceContract" + "x-proto-file": "protocol/src/main/protos/core/contract/balance_contract.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "org.tron.protos.contract.BalanceContract.UnDelegateResourceContract" + "required": + - "owner_address" + - "balance" + - "receiver_address" + "x-java-unknown-fields": "ignored-by-jsonformat" + "CanDelegatedMaxSizeResponseMessage": + "type": "object" + "additionalProperties": false + "properties": + "max_size": + "type": "integer" + "format": "int64" + "x-proto-message": "CanDelegatedMaxSizeResponseMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response-type": "GrpcAPI.CanDelegatedMaxSizeResponseMessage" + "x-java-response": "CanDelegatedMaxSizeResponseMessage rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "CanDelegatedMaxSizeRequestMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "type": + "type": "integer" + "format": "int32" + "description": "Account, contract, or resource type." + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "CanDelegatedMaxSizeRequestMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "CanDelegatedMaxSizeRequestMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "owner_address" + "GetAvailableUnfreezeCountResponseMessage": + "type": "object" + "additionalProperties": false + "properties": + "count": + "type": "integer" + "format": "int64" + "x-proto-message": "GetAvailableUnfreezeCountResponseMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response-type": "GrpcAPI.GetAvailableUnfreezeCountResponseMessage" + "x-java-response": "GetAvailableUnfreezeCountResponseMessage rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "GetAvailableUnfreezeCountRequestMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "GetAvailableUnfreezeCountRequestMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "GetAvailableUnfreezeCountRequestMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "CanWithdrawUnfreezeAmountResponseMessage": + "type": "object" + "additionalProperties": false + "properties": + "amount": + "type": "integer" + "format": "int64" + "description": "Amount in sun, where 1 TRX equals 1,000,000 sun." + "x-proto-message": "CanWithdrawUnfreezeAmountResponseMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response-type": "GrpcAPI.CanWithdrawUnfreezeAmountResponseMessage" + "x-java-response": "CanWithdrawUnfreezeAmountResponseMessage rendered by java-tron JSON printer" + "not": + "required": + - "Error" + "CanWithdrawUnfreezeAmountRequestMessageRequest": + "type": "object" + "additionalProperties": false + "properties": + "owner_address": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "timestamp": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-proto-message": "CanWithdrawUnfreezeAmountRequestMessage" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-source-shape": "protobuf-json-plus-servlet-fields" + "x-java-request-type": "CanWithdrawUnfreezeAmountRequestMessage" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "owner_address" + "NodeInfoConfigNodeInfo": + "type": "object" + "additionalProperties": false + "properties": + "codeVersion": + "type": "string" + "p2pVersion": + "type": "string" + "listenPort": + "type": "integer" + "format": "int32" + "discoverEnable": + "type": "boolean" + "activeNodeSize": + "type": "integer" + "format": "int32" + "passiveNodeSize": + "type": "integer" + "format": "int32" + "sendNodeSize": + "type": "integer" + "format": "int32" + "maxConnectCount": + "type": "integer" + "format": "int32" + "sameIpMaxConnectCount": + "type": "integer" + "format": "int32" + "backupListenPort": + "type": "integer" + "format": "int32" + "backupMemberSize": + "type": "integer" + "format": "int32" + "backupPriority": + "type": "integer" + "format": "int32" + "dbVersion": + "type": "integer" + "format": "int32" + "minParticipationRate": + "type": "integer" + "format": "int32" + "supportConstant": + "type": "boolean" + "minTimeRatio": + "type": "number" + "maxTimeRatio": + "type": "number" + "allowCreationOfContracts": + "type": "integer" + "format": "int64" + "allowAdaptiveEnergy": + "type": "integer" + "format": "int64" + "versionNum": + "type": "string" + "x-proto-message": "NodeInfo.ConfigNodeInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "NodeInfoMachineInfoMemoryDescInfo": + "type": "object" + "additionalProperties": false + "properties": + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "initSize": + "type": "integer" + "format": "int64" + "useSize": + "type": "integer" + "format": "int64" + "maxSize": + "type": "integer" + "format": "int64" + "useRate": + "type": "number" + "x-proto-message": "NodeInfo.MachineInfo.MemoryDescInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "NodeInfoMachineInfoDeadLockThreadInfo": + "type": "object" + "additionalProperties": false + "properties": + "name": + "type": "string" + "description": "Name encoded as expected by java-tron." + "lockName": + "type": "string" + "lockOwner": + "type": "string" + "state": + "type": "string" + "blockTime": + "type": "integer" + "format": "int64" + "waitTime": + "type": "integer" + "format": "int64" + "stackTrace": + "type": "string" + "x-proto-message": "NodeInfo.MachineInfo.DeadLockThreadInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "NodeInfoMachineInfo": + "type": "object" + "additionalProperties": false + "properties": + "threadCount": + "type": "integer" + "format": "int32" + "deadLockThreadCount": + "type": "integer" + "format": "int32" + "cpuCount": + "type": "integer" + "format": "int32" + "totalMemory": + "type": "integer" + "format": "int64" + "freeMemory": + "type": "integer" + "format": "int64" + "cpuRate": + "type": "number" + "javaVersion": + "type": "string" + "osName": + "type": "string" + "jvmTotalMemory": + "type": "integer" + "format": "int64" + "jvmFreeMemory": + "type": "integer" + "format": "int64" + "processCpuRate": + "type": "number" + "memoryDescInfoList": + "type": "array" + "items": + "$ref": "#/components/schemas/NodeInfoMachineInfoMemoryDescInfo" + "deadLockThreadInfoList": + "type": "array" + "items": + "$ref": "#/components/schemas/NodeInfoMachineInfoDeadLockThreadInfo" + "x-proto-message": "NodeInfo.MachineInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "NodeInfoPeerInfo": + "type": "object" + "additionalProperties": false + "properties": + "lastSyncBlock": + "type": "string" + "remainNum": + "type": "integer" + "format": "int64" + "lastBlockUpdateTime": + "type": "integer" + "format": "int64" + "syncFlag": + "type": "boolean" + "headBlockTimeWeBothHave": + "type": "integer" + "format": "int64" + "needSyncFromPeer": + "type": "boolean" + "needSyncFromUs": + "type": "boolean" + "host": + "type": "string" + "port": + "type": "integer" + "format": "int32" + "nodeId": + "type": "string" + "connectTime": + "type": "integer" + "format": "int64" + "avgLatency": + "type": "number" + "syncToFetchSize": + "type": "integer" + "format": "int32" + "syncToFetchSizePeekNum": + "type": "integer" + "format": "int64" + "syncBlockRequestedSize": + "type": "integer" + "format": "int32" + "unFetchSynNum": + "type": "integer" + "format": "int64" + "blockInPorcSize": + "type": "integer" + "format": "int32" + "headBlockWeBothHave": + "type": "string" + "score": + "type": "integer" + "format": "int32" + "nodeCount": + "type": "integer" + "format": "int32" + "inFlow": + "type": "integer" + "format": "int64" + "disconnectTimes": + "type": "integer" + "format": "int32" + "localDisconnectReason": + "type": "string" + "remoteDisconnectReason": + "type": "string" + "active": + "type": "boolean" + "x-proto-message": "NodeInfo.PeerInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "NodeInfo": + "type": "object" + "additionalProperties": false + "properties": + "beginSyncNum": + "type": "integer" + "format": "int64" + "block": + "type": "string" + "solidityBlock": + "type": "string" + "currentConnectCount": + "type": "integer" + "format": "int32" + "activeConnectCount": + "type": "integer" + "format": "int32" + "passiveConnectCount": + "type": "integer" + "format": "int32" + "totalFlow": + "type": "integer" + "format": "int64" + "configNodeInfo": + "$ref": "#/components/schemas/NodeInfoConfigNodeInfo" + "machineInfo": + "$ref": "#/components/schemas/NodeInfoMachineInfo" + "cheatWitnessInfoMap": + "type": "object" + "additionalProperties": + "type": "string" + "peerList": + "type": "array" + "items": + "$ref": "#/components/schemas/NodeInfoPeerInfo" + "x-proto-message": "NodeInfo" + "x-proto-file": "protocol/src/main/protos/core/Tron.proto" + "x-java-response-type": "org.tron.common.entity.NodeInfo" + "x-java-response-source": "common/src/main/java/org/tron/common/entity/NodeInfo.java" + "x-java-response": "NodeInfo rendered by JSON.toJSONString(NodeInfo)" + "not": + "required": + - "Error" + "Address": + "type": "object" + "additionalProperties": false + "properties": + "host": + "type": "string" + "port": + "type": "integer" + "format": "int32" + "x-proto-message": "Address" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "description": "Account or contract address accepted by this endpoint." + "Node": + "type": "object" + "additionalProperties": false + "properties": + "address": + "$ref": "#/components/schemas/Address" + "x-proto-message": "Node" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "NodeList": + "type": "object" + "additionalProperties": false + "properties": + "nodes": + "type": "array" + "items": + "$ref": "#/components/schemas/Node" + "x-proto-message": "NodeList" + "x-proto-file": "protocol/src/main/protos/api/api.proto" + "x-java-response-type": "org.tron.api.GrpcAPI.NodeList" + "x-java-response": "NodeList rendered by java-tron JSON printer" + "not": + "required": + - "Error" +"x-tron-rate-limiting": + "source": "framework/src/main/java/org/tron/core/services/http/RateLimiterServlet.java" + "appliesTo": + - "HTTP" + - "JSON-RPC servlet" + "httpStatus": 200 + "errorShape": "JavaTronError for HTTP APIs; servlet-level error body for JSON-RPC" + "message": "lack of computing resources" + "description": "java-tron applies configurable servlet-level rate limiting. When a request is rejected by the rate limiter, RateLimiterServlet writes an error body without setting HTTP 429." diff --git a/docs/api/openrpc.json b/docs/api/openrpc.json new file mode 100644 index 00000000..ed57102f --- /dev/null +++ b/docs/api/openrpc.json @@ -0,0 +1,2672 @@ +{ + "openrpc": "1.2.6", + "info": { + "title": "java-tron JSON-RPC API", + "version": "1.0.0", + "description": "Machine-readable definition generated from java-tron source code, with human-facing metadata linked to the markdown API documentation.", + "x-java-tron-source": { + "repo": "tronprotocol/java-tron", + "commit": "a79693e4508c05650cc474f23e7f97451d2861ec", + "version": "GreatVoyage-v4.8.1.1" + } + }, + "servers": [ + { + "name": "Nile testnet", + "url": "https://nile.trongrid.io/jsonrpc" + }, + { + "name": "Local FullNode", + "url": "http://127.0.0.1:8545/jsonrpc" + }, + { + "name": "Local Solidity", + "url": "http://127.0.0.1:8555/jsonrpc" + } + ], + "methods": [ + { + "name": "web3_clientVersion", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Client version string", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/web3_clientVersion.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/web3_clientVersion.md" + }, + "x-source-derived": true, + "x-java-method": "web3ClientVersion", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#web3_clientVersion", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#web3ClientVersion" + ] + }, + { + "name": "web3_sha3", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Keccak-256 hash", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/web3_sha3.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "data", + "required": true, + "description": "Hex-encoded input data.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/web3_sha3.md" + }, + "x-source-derived": true, + "x-java-method": "web3Sha3", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#web3_sha3", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#web3Sha3" + ] + }, + { + "name": "net_version", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Network ID (same as eth_chainId)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/net_version.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/net_version.md" + }, + "x-source-derived": true, + "x-java-method": "getNetVersion", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#net_version", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getNetVersion" + ] + }, + { + "name": "net_listening", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Whether listening on P2P", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/net_listening.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "boolean", + "x-java-type": "boolean" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/net_listening.md" + }, + "x-source-derived": true, + "x-java-method": "isListening", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#net_listening", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#isListening" + ] + }, + { + "name": "net_peerCount", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Number of peers", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/net_peerCount.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/net_peerCount.md" + }, + "x-source-derived": true, + "x-java-method": "getPeerCount", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#net_peerCount", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getPeerCount" + ] + }, + { + "name": "eth_chainId", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "chainId (last 4 bytes of the genesis block hash)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_chainId.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_chainId.md" + }, + "x-source-derived": true, + "x-java-method": "ethChainId", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_chainId", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethChainId" + ] + }, + { + "name": "eth_protocolVersion", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Protocol version of the current block header", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_protocolVersion.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_protocolVersion.md" + }, + "x-source-derived": true, + "x-java-method": "getProtocolVersion", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_protocolVersion", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getProtocolVersion" + ] + }, + { + "name": "eth_syncing", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Sync status", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_syncing.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "x-java-type": "Object", + "oneOf": [ + { + "type": "boolean", + "const": false, + "title": "EthSyncingResultFalse1" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "startingBlock": { + "type": "string" + }, + "currentBlock": { + "type": "string" + }, + "highestBlock": { + "type": "string" + } + }, + "required": [ + "startingBlock", + "currentBlock", + "highestBlock" + ], + "title": "EthSyncingResultRequiresStartingBlockCurrentBlockHighestBlock2" + } + ] + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_syncing.md" + }, + "x-source-derived": true, + "x-java-method": "getSyncingStatus", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_syncing", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getSyncingStatus", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class SyncingResult" + ] + }, + { + "name": "eth_blockNumber", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Latest block height", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_blockNumber.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_blockNumber.md" + }, + "x-source-derived": true, + "x-java-method": "getLatestBlockNum", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_blockNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getLatestBlockNum" + ] + }, + { + "name": "eth_gasPrice", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Current energy unit price (sun)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_gasPrice.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_gasPrice.md" + }, + "x-source-derived": true, + "x-java-method": "gasPrice", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_gasPrice", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#gasPrice" + ] + }, + { + "name": "eth_getBlockByHash", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a block by hash", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockByHash.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockHash", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte block hash, with or without the 0x prefix." + }, + { + "name": "fullTransactionObjects", + "required": true, + "schema": { + "type": "boolean" + }, + "x-java-type": "Boolean", + "x-position": 1, + "description": "Whether to return full transaction objects instead of transaction hashes." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BlockResult" + }, + { + "type": "null", + "title": "EthGetBlockByHashResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockByHash.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockByHash", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java#class BlockResult", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] + }, + { + "name": "eth_getBlockByNumber", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a block by height / tag", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockByNumber.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "bnOrId", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "", + "latest", + "earliest", + "finalized" + ], + "title": "EthGetBlockByNumberParamString1" + }, + { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "title": "EthGetBlockByNumberParamString2" + } + ] + }, + "x-java-type": "String", + "x-position": 0, + "description": "Hex block number or supported block tag." + }, + { + "name": "fullTransactionObjects", + "required": true, + "schema": { + "type": "boolean" + }, + "x-java-type": "Boolean", + "x-position": 1, + "description": "Whether to return full transaction objects instead of transaction hashes." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BlockResult" + }, + { + "type": "null", + "title": "EthGetBlockByNumberResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockByNumber.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockByNumber", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockByNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockByNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/JsonRpcApiUtil.java#getByJsonBlockId", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java#class BlockResult", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] + }, + { + "name": "eth_getBlockTransactionCountByHash", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Block transaction count (by hash)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByHash.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockHash", + "required": true, + "description": "32-byte block hash, with or without the 0x prefix.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "type": "string", + "x-java-type": "String", + "title": "EthGetBlockTransactionCountByHashResultString1" + }, + { + "type": "null", + "title": "EthGetBlockTransactionCountByHashResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByHash.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockTransactionCountByHash", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockTransactionCountByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockTransactionCountByHash" + ] + }, + { + "name": "eth_getBlockTransactionCountByNumber", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Block transaction count (by height)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByNumber.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "bnOrId", + "required": true, + "description": "Hex block number or supported block tag.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "type": "string", + "x-java-type": "String", + "title": "EthGetBlockTransactionCountByNumberResultString1" + }, + { + "type": "null", + "title": "EthGetBlockTransactionCountByNumberResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByNumber.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockTransactionCountByNumber", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockTransactionCountByNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockTransactionCountByNumber" + ] + }, + { + "name": "eth_getTransactionByHash", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a transaction by txid", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionByHash.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "txId", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte transaction id, with or without the 0x prefix." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionResult" + }, + { + "type": "null", + "title": "EthGetTransactionByHashResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionByHash.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionByHash", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] + }, + { + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a transaction by block hash + index", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockHashAndIndex.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockHash", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte block hash, with or without the 0x prefix." + }, + { + "name": "index", + "required": true, + "schema": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$" + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex-encoded transaction index within the block." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionResult" + }, + { + "type": "null", + "title": "EthGetTransactionByBlockHashAndIndexResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockHashAndIndex.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionByBlockHashAndIndex", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionByBlockHashAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionByBlockHashAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] + }, + { + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a transaction by block height + index", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockNumberAndIndex.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "", + "latest", + "earliest", + "finalized" + ], + "title": "EthGetTransactionByBlockNumberAndIndexParamString1" + }, + { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "title": "EthGetTransactionByBlockNumberAndIndexParamString2" + } + ] + }, + "x-java-type": "String", + "x-position": 0, + "description": "Hex block number or supported block tag." + }, + { + "name": "index", + "required": true, + "schema": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$" + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex-encoded transaction index within the block." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionResult" + }, + { + "type": "null", + "title": "EthGetTransactionByBlockNumberAndIndexResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockNumberAndIndex.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionByBlockNumberAndIndex", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionByBlockNumberAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionByBlockNumberAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] + }, + { + "name": "eth_getTransactionReceipt", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a receipt by txid", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionReceipt.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "txid", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte transaction id, with or without the 0x prefix." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionReceipt" + }, + { + "type": "null", + "title": "EthGetTransactionReceiptResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionReceipt.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionReceipt", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionReceipt", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionReceipt", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionReceipt.java#class TransactionReceipt" + ] + }, + { + "name": "eth_getBlockReceipts", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Receipt list for an entire block", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockReceipts.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockNumOrHashOrTag", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$", + "title": "EthGetBlockReceiptsParamString1" + }, + { + "oneOf": [ + { + "type": "string", + "enum": [ + "", + "latest", + "earliest", + "finalized" + ], + "title": "EthGetBlockReceiptsParamNested1String1" + }, + { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "title": "EthGetBlockReceiptsParamNested1String2" + } + ], + "title": "EthGetBlockReceiptsParamVariant2" + } + ] + }, + "x-java-type": "String", + "x-position": 0, + "description": "Block hash, hex block number, or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionReceipt" + }, + "title": "EthGetBlockReceiptsResultArray1" + }, + { + "type": "null", + "title": "EthGetBlockReceiptsResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockReceipts.md" + }, + "x-source-derived": true, + "x-java-method": "getBlockReceipts", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockReceipts", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getBlockReceipts", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionReceipt.java#class TransactionReceipt" + ] + }, + { + "name": "eth_getBalance", + "tags": [ + { + "name": "Account state" + } + ], + "summary": "Account TRX balance (sun)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/account/eth_getBalance.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "address", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0, + "description": "Account or contract address." + }, + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "type": "string", + "enum": [ + "latest" + ] + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/account/eth_getBalance.md" + }, + "x-source-derived": true, + "x-java-method": "getTrxBalance", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBalance", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTrxBalance" + ] + }, + { + "name": "eth_getStorageAt", + "tags": [ + { + "name": "Account state" + } + ], + "summary": "Contract storage slot", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/account/eth_getStorageAt.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "address", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0, + "description": "Account or contract address." + }, + { + "name": "storageIdx", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 1, + "description": "Storage slot index." + }, + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "type": "string", + "enum": [ + "latest" + ] + }, + "x-java-type": "String", + "x-position": 2, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/account/eth_getStorageAt.md" + }, + "x-source-derived": true, + "x-java-method": "getStorageAt", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getStorageAt", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getStorageAt" + ] + }, + { + "name": "eth_getCode", + "tags": [ + { + "name": "Account state" + } + ], + "summary": "Contract runtime bytecode", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/account/eth_getCode.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "contractAddress", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0, + "description": "Contract address." + }, + { + "name": "bnOrId", + "required": true, + "schema": { + "type": "string", + "enum": [ + "latest" + ] + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/account/eth_getCode.md" + }, + "x-source-derived": true, + "x-java-method": "getABIOfSmartContract", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getCode", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getABIOfSmartContract" + ] + }, + { + "name": "eth_call", + "tags": [ + { + "name": "Smart contract calls" + } + ], + "summary": "Read-only contract call", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/smart-contract/eth_call.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "transactionCall", + "required": true, + "schema": { + "$ref": "#/components/schemas/TransactionCall" + }, + "x-java-type": "CallArguments", + "x-position": 0, + "description": "Transaction call arguments." + }, + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "latest" + ], + "title": "EthCallParamString1" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "blockNumber": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "description": "Hex-encoded block number." + } + }, + "required": [ + "blockNumber" + ], + "title": "EthCallParamRequiresBlockNumber2" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "blockHash": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$", + "description": "32-byte block hash, with or without the 0x prefix." + } + }, + "required": [ + "blockHash" + ], + "title": "EthCallParamRequiresBlockHash3" + } + ] + }, + "x-java-type": "Object", + "x-position": 1, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32600, + "message": "JsonRpcInvalidRequestException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/smart-contract/eth_call.md" + }, + "x-source-derived": true, + "x-java-method": "getCall", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_call", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getCall" + ] + }, + { + "name": "eth_estimateGas", + "tags": [ + { + "name": "Smart contract calls" + } + ], + "summary": "Estimate energy consumption", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/smart-contract/eth_estimateGas.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "args", + "required": true, + "schema": { + "$ref": "#/components/schemas/TransactionCall" + }, + "x-java-type": "CallArguments", + "x-position": 0, + "description": "Transaction call arguments." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32600, + "message": "JsonRpcInvalidRequestException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/smart-contract/eth_estimateGas.md" + }, + "x-source-derived": true, + "x-java-method": "estimateGas", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_estimateGas", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#estimateGas", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/CallArguments.java#class CallArguments" + ] + }, + { + "name": "eth_getLogs", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "One-shot log query", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_getLogs.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "fr", + "required": true, + "schema": { + "$ref": "#/components/schemas/LogFilter" + }, + "x-java-type": "FilterRequest", + "x-position": 0, + "description": "Log filter request." + } + ], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Log" + }, + "x-java-type": "LogFilterElement[]" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32005, + "message": "JsonRpcTooManyResultException" + }, + { + "code": -32000, + "message": "BadItemException" + }, + { + "code": -32000, + "message": "ExecutionException" + }, + { + "code": -32000, + "message": "InterruptedException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_getLogs.md" + }, + "x-source-derived": true, + "x-java-method": "getLogs", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class FilterRequest", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class LogFilterElement" + ] + }, + { + "name": "eth_newFilter", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Register a log filter", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_newFilter.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "fr", + "required": true, + "schema": { + "$ref": "#/components/schemas/LogFilter" + }, + "x-java-type": "FilterRequest", + "x-position": 0, + "description": "Log filter request." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_newFilter.md" + }, + "x-source-derived": true, + "x-java-method": "newFilter", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_newFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#newFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class FilterRequest" + ] + }, + { + "name": "eth_newBlockFilter", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Register a new-block filter", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_newBlockFilter.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32005, + "message": "JsonRpcExceedLimitException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_newBlockFilter.md" + }, + "x-source-derived": true, + "x-java-method": "newBlockFilter", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_newBlockFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#newBlockFilter" + ] + }, + { + "name": "eth_uninstallFilter", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Uninstall a filter", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_uninstallFilter.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "filterId", + "required": true, + "description": "Filter id returned by eth_newFilter or eth_newBlockFilter.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "boolean", + "x-java-type": "boolean" + } + }, + "errors": [ + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_uninstallFilter.md" + }, + "x-source-derived": true, + "x-java-method": "uninstallFilter", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_uninstallFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#uninstallFilter" + ] + }, + { + "name": "eth_getFilterChanges", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Pull and drain filter increments", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_getFilterChanges.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "filterId", + "required": true, + "description": "Filter id returned by eth_newFilter or eth_newBlockFilter.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "x-java-type": "Object[]" + } + }, + "errors": [ + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_getFilterChanges.md" + }, + "x-source-derived": true, + "x-java-method": "getFilterChanges", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getFilterChanges", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getFilterChanges" + ] + }, + { + "name": "eth_getFilterLogs", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Pull a log filter's full set (without draining)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_getFilterLogs.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "filterId", + "required": true, + "description": "Filter id returned by eth_newFilter or eth_newBlockFilter.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Log" + }, + "x-java-type": "LogFilterElement[]" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32005, + "message": "JsonRpcTooManyResultException" + }, + { + "code": -32000, + "message": "BadItemException" + }, + { + "code": -32000, + "message": "ExecutionException" + }, + { + "code": -32000, + "message": "InterruptedException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_getFilterLogs.md" + }, + "x-source-derived": true, + "x-java-method": "getFilterLogs", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getFilterLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getFilterLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class LogFilterElement" + ] + }, + { + "name": "buildTransaction", + "tags": [ + { + "name": "Transaction build" + } + ], + "summary": "Build an unsigned transaction (FullNode only; TRX transfer / TRC10 transfer / contract deploy / contract trigger)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/tx-build/buildTransaction.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "args", + "required": true, + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "from": { + "type": "string", + "description": "Sender account address." + }, + "to": { + "type": "string", + "description": "Recipient account or contract address." + }, + "gas": { + "type": "string", + "description": "Gas limit encoded as a hex quantity." + }, + "gasPrice": { + "type": "string", + "description": "Gas price encoded as a hex quantity." + }, + "value": { + "type": "string", + "description": "Hex string, amount, or value field accepted by this endpoint." + }, + "data": { + "type": "string", + "description": "Hex-encoded contract call data or transaction data." + }, + "nonce": { + "type": "string", + "description": "Transaction nonce encoded as a hex quantity." + }, + "tokenId": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "TRC10 token id." + }, + "tokenValue": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "TRC10 token amount." + }, + "abi": { + "type": "string", + "description": "Smart contract ABI definition." + }, + "consumeUserResourcePercent": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Percentage of contract execution resource cost paid by the user." + }, + "originEnergyLimit": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Origin energy limit for a deployed smart contract." + }, + "name": { + "type": "string", + "description": "Name encoded as expected by java-tron." + }, + "permissionId": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Permission id used to sign the transaction with a non-owner account permission." + }, + "extraData": { + "type": "string", + "description": "Extra transaction data encoded as expected by java-tron." + }, + "visible": { + "type": "boolean", + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + } + } + }, + "x-java-type": "BuildArguments", + "x-position": 0, + "description": "Transaction call arguments." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionJson" + }, + { + "type": "null", + "title": "BuildTransactionResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32600, + "message": "JsonRpcInvalidRequestException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/tx-build/buildTransaction.md" + }, + "x-source-derived": true, + "x-java-method": "buildTransaction", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 only (the Solidity port throws -32601)", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#buildTransaction", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#buildTransaction", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class TransactionJson", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/BuildArguments.java#class BuildArguments" + ] + }, + { + "name": "eth_coinbase", + "tags": [ + { + "name": "Compatibility stub methods" + } + ], + "summary": "The configured etherbase address", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/stub/eth_coinbase.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/stub/eth_coinbase.md" + }, + "x-source-derived": true, + "x-java-method": "getCoinbase", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_coinbase", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getCoinbase" + ] + }, + { + "name": "eth_accounts", + "tags": [ + { + "name": "Compatibility stub methods" + } + ], + "summary": "[]", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/stub/eth_accounts.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "x-java-type": "String[]" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/stub/eth_accounts.md" + }, + "x-source-derived": true, + "x-java-method": "getAccounts", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_accounts", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getAccounts" + ] + }, + { + "name": "eth_getWork", + "tags": [ + { + "name": "Compatibility stub methods" + } + ], + "summary": "[blockHash, null, null]", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/stub/eth_getWork.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "x-java-type": "List" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/stub/eth_getWork.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetWork", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getWork", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetWork" + ] + } + ], + "x-tron-rate-limiting": { + "source": "framework/src/main/java/org/tron/core/services/http/RateLimiterServlet.java", + "appliesTo": [ + "HTTP", + "JSON-RPC servlet" + ], + "httpStatus": 200, + "errorShape": "JavaTronError for HTTP APIs; servlet-level error body for JSON-RPC", + "message": "lack of computing resources", + "description": "java-tron applies configurable servlet-level rate limiting. When a request is rejected by the rate limiter, RateLimiterServlet writes an error body without setting HTTP 429." + }, + "components": { + "schemas": { + "TransactionResult": { + "type": "object", + "additionalProperties": false, + "x-java-type": "TransactionResult", + "properties": { + "blockHash": { + "type": "string" + }, + "blockNumber": { + "type": "string" + }, + "from": { + "type": "string" + }, + "gas": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "input": { + "type": "string" + }, + "nonce": { + "type": "string" + }, + "r": { + "type": "string" + }, + "s": { + "type": "string" + }, + "to": { + "type": "string" + }, + "transactionIndex": { + "type": "string" + }, + "type": { + "type": "string" + }, + "v": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "r", + "s", + "to", + "transactionIndex", + "type", + "v", + "value" + ] + }, + "BlockResult": { + "type": "object", + "additionalProperties": false, + "x-java-type": "BlockResult", + "properties": { + "baseFeePerGas": { + "type": "string" + }, + "difficulty": { + "type": "string" + }, + "extraData": { + "type": "string" + }, + "gasLimit": { + "type": "string" + }, + "gasUsed": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "logsBloom": { + "type": "string" + }, + "miner": { + "type": "string" + }, + "mixHash": { + "type": "string" + }, + "nonce": { + "type": "string" + }, + "number": { + "type": "string" + }, + "parentHash": { + "type": "string" + }, + "receiptsRoot": { + "type": "string" + }, + "sha3Uncles": { + "type": "string" + }, + "size": { + "type": "string" + }, + "stateRoot": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "totalDifficulty": { + "type": "string" + }, + "transactions": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string", + "title": "BlockResultTransactionsString1" + }, + { + "$ref": "#/components/schemas/TransactionResult" + } + ] + } + }, + "transactionsRoot": { + "type": "string" + }, + "uncles": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "baseFeePerGas", + "difficulty", + "extraData", + "gasLimit", + "gasUsed", + "hash", + "logsBloom", + "miner", + "mixHash", + "nonce", + "number", + "parentHash", + "receiptsRoot", + "sha3Uncles", + "size", + "stateRoot", + "timestamp", + "totalDifficulty", + "transactions", + "transactionsRoot", + "uncles" + ] + }, + "Log": { + "type": "object", + "additionalProperties": false, + "x-java-type": "TransactionReceipt.TransactionLog", + "properties": { + "address": { + "type": "string" + }, + "blockHash": { + "type": "string" + }, + "blockNumber": { + "type": "string" + }, + "data": { + "type": "string" + }, + "logIndex": { + "type": "string" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/Hash32" + }, + { + "type": "null", + "title": "LogTopicsNull2" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Hash32" + }, + "title": "LogTopicsArray3" + } + ] + } + }, + "transactionHash": { + "type": "string" + }, + "transactionIndex": { + "type": "string" + } + }, + "required": [ + "address", + "blockHash", + "blockNumber", + "data", + "logIndex", + "removed", + "topics", + "transactionHash", + "transactionIndex" + ] + }, + "TransactionReceipt": { + "type": "object", + "additionalProperties": false, + "x-java-type": "TransactionReceipt", + "properties": { + "blockHash": { + "type": "string" + }, + "blockNumber": { + "type": "string" + }, + "contractAddress": { + "oneOf": [ + { + "type": "string", + "title": "TransactionReceiptContractAddressString1" + }, + { + "type": "null", + "title": "TransactionReceiptContractAddressNull2" + } + ] + }, + "cumulativeGasUsed": { + "type": "string" + }, + "effectiveGasPrice": { + "type": "string" + }, + "from": { + "oneOf": [ + { + "type": "string", + "title": "TransactionReceiptFromString1" + }, + { + "type": "null", + "title": "TransactionReceiptFromNull2" + } + ] + }, + "gasUsed": { + "type": "string" + }, + "logs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Log" + } + }, + "logsBloom": { + "type": "string" + }, + "root": { + "type": "string" + }, + "status": { + "type": "string" + }, + "to": { + "oneOf": [ + { + "type": "string", + "title": "TransactionReceiptToString1" + }, + { + "type": "null", + "title": "TransactionReceiptToNull2" + } + ] + }, + "transactionHash": { + "type": "string" + }, + "transactionIndex": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "blockHash", + "blockNumber", + "cumulativeGasUsed", + "effectiveGasPrice", + "gasUsed", + "logs", + "logsBloom", + "transactionHash", + "transactionIndex", + "type" + ] + }, + "TransactionCall": { + "type": "object", + "additionalProperties": false, + "properties": { + "from": { + "type": "string", + "description": "Sender account address." + }, + "to": { + "type": "string", + "description": "Recipient account or contract address." + }, + "gas": { + "type": "string", + "description": "Gas limit encoded as a hex quantity." + }, + "gasPrice": { + "type": "string", + "description": "Gas price encoded as a hex quantity." + }, + "value": { + "type": "string", + "description": "Hex string, amount, or value field accepted by this endpoint." + }, + "data": { + "type": "string", + "description": "Hex-encoded contract call data or transaction data." + }, + "nonce": { + "type": "string", + "description": "Transaction nonce encoded as a hex quantity." + } + }, + "x-java-type": "CallArguments" + }, + "LogFilter": { + "type": "object", + "additionalProperties": false, + "properties": { + "fromBlock": { + "type": "string", + "description": "Start block for a log filter." + }, + "toBlock": { + "type": "string", + "description": "End block for a log filter." + }, + "address": { + "oneOf": [ + { + "type": "string", + "title": "LogFilterAddressString1" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "title": "LogFilterAddressArray2" + } + ], + "description": "Account or contract address accepted by this endpoint." + }, + "topics": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/Hash32" + }, + { + "type": "null", + "title": "LogFilterTopicsNull2" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Hash32" + }, + "title": "LogFilterTopicsArray3" + } + ] + }, + "description": "Log topics filter." + }, + "blockHash": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$", + "description": "32-byte block hash, with or without the 0x prefix." + } + }, + "x-java-type": "FilterRequest" + }, + "TransactionJson": { + "type": "object", + "additionalProperties": false, + "x-java-type": "TransactionJson", + "properties": { + "transaction": { + "type": "object", + "additionalProperties": false, + "properties": { + "txID": { + "type": "string" + }, + "raw_data": { + "type": "object", + "additionalProperties": false, + "properties": { + "contract": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string" + }, + "Permission_id": { + "type": "integer", + "format": "int32" + }, + "parameter": { + "type": "object", + "additionalProperties": false, + "properties": { + "type_url": { + "type": "string" + }, + "value": { + "type": "object", + "additionalProperties": false, + "properties": { + "owner_address": { + "type": "string" + }, + "to_address": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "asset_name": { + "type": "string" + }, + "contract_address": { + "type": "string" + }, + "data": { + "type": "string" + }, + "call_value": { + "type": "integer", + "format": "int64" + }, + "call_token_value": { + "type": "integer", + "format": "int64" + }, + "token_id": { + "type": "integer", + "format": "int64" + }, + "new_contract": { + "type": "object", + "additionalProperties": false, + "properties": { + "origin_address": { + "type": "string" + }, + "contract_address": { + "type": "string" + }, + "abi": { + "type": "object", + "additionalProperties": false, + "properties": { + "entrys": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "anonymous": { + "type": "boolean" + }, + "constant": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "stateMutability": { + "type": "string" + }, + "inputs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "indexed": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + }, + "outputs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "indexed": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "bytecode": { + "type": "string" + }, + "call_value": { + "type": "integer", + "format": "int64" + }, + "consume_user_resource_percent": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "origin_energy_limit": { + "type": "integer", + "format": "int64" + } + } + } + } + } + }, + "required": [ + "type_url", + "value" + ] + } + } + } + }, + "data": { + "type": "string" + }, + "expiration": { + "type": "integer", + "format": "int64" + }, + "fee_limit": { + "type": "integer", + "format": "int64" + }, + "ref_block_bytes": { + "type": "string" + }, + "ref_block_hash": { + "type": "string" + }, + "timestamp": { + "type": "integer", + "format": "int64" + } + }, + "required": [ + "contract", + "expiration", + "ref_block_bytes", + "ref_block_hash", + "timestamp" + ] + }, + "raw_data_hex": { + "type": "string" + }, + "visible": { + "type": "boolean" + } + }, + "required": [ + "raw_data", + "raw_data_hex", + "txID" + ] + } + }, + "required": [ + "transaction" + ] + }, + "Hash32": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "HexQuantity": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$" + }, + "HexData": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]*$" + } + } + } +} diff --git a/docs/api/specs/http/accountpermissionupdate.yaml b/docs/api/specs/http/accountpermissionupdate.yaml new file mode 100644 index 00000000..f87a2b67 --- /dev/null +++ b/docs/api/specs/http/accountpermissionupdate.yaml @@ -0,0 +1,46 @@ +"/wallet/accountpermissionupdate": + "post": + "tags": + - "Account" + "summary": "Configure multi-sig permissions" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/accountpermissionupdate.md` for examples and detailed behavior." + "operationId": "wallet_accountpermissionupdate_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/accountpermissionupdate.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "AccountPermissionUpdateServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountPermissionUpdateContractRequest" + "required": + - "owner_address" + - "owner" + - "actives" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/AccountPermissionUpdateActuator.java#validate" + - "protocol/src/main/protos/core/contract/account_contract.proto#AccountPermissionUpdateContract" diff --git a/docs/api/specs/http/broadcasthex.yaml b/docs/api/specs/http/broadcasthex.yaml new file mode 100644 index 00000000..d3a75db0 --- /dev/null +++ b/docs/api/specs/http/broadcasthex.yaml @@ -0,0 +1,66 @@ +"/wallet/broadcasthex": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Broadcast a signed transaction (hex)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/broadcasthex.md` for examples and detailed behavior." + "operationId": "wallet_broadcasthex_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/broadcasthex.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "message": + "type": "string" + "txid": + "type": "string" + "transaction": + "type": "string" + "x-java-response": "Return/GrpcAPI.Return plus transaction id fields" + "not": + "required": + - "Error" + "title": "BroadcasthexPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "BroadcastHexServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "transaction": + "type": "string" + "description": "Transaction object." + "required": + - "transaction" + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/BroadcastHexServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" diff --git a/docs/api/specs/http/broadcasttransaction.yaml b/docs/api/specs/http/broadcasttransaction.yaml new file mode 100644 index 00000000..c3edde4c --- /dev/null +++ b/docs/api/specs/http/broadcasttransaction.yaml @@ -0,0 +1,60 @@ +"/wallet/broadcasttransaction": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Broadcast a signed transaction (JSON)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/broadcasttransaction.md` for examples and detailed behavior." + "operationId": "wallet_broadcasttransaction_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/broadcasttransaction.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "message": + "type": "string" + "txid": + "type": "string" + "x-java-response": "Return/GrpcAPI.Return plus transaction id fields" + "not": + "required": + - "Error" + "title": "BroadcasttransactionPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "BroadcastServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransactionRequest" + "required": + - "raw_data" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/BroadcastServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + - "protocol/src/main/protos/core/Tron.proto#Transaction" diff --git a/docs/api/specs/http/cancelallunfreezev2.yaml b/docs/api/specs/http/cancelallunfreezev2.yaml new file mode 100644 index 00000000..1d60a5a6 --- /dev/null +++ b/docs/api/specs/http/cancelallunfreezev2.yaml @@ -0,0 +1,44 @@ +"/wallet/cancelallunfreezev2": + "post": + "tags": + - "Stake 2.0" + "summary": "Cancel all unmatured unfreezes" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/cancelallunfreezev2.md` for examples and detailed behavior." + "operationId": "wallet_cancelallunfreezev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/cancelallunfreezev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CancelAllUnfreezeV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CancelAllUnfreezeV2ContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/CancelAllUnfreezeV2Actuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#CancelAllUnfreezeV2Contract" diff --git a/docs/api/specs/http/clearabi.yaml b/docs/api/specs/http/clearabi.yaml new file mode 100644 index 00000000..a02e36a5 --- /dev/null +++ b/docs/api/specs/http/clearabi.yaml @@ -0,0 +1,45 @@ +"/wallet/clearabi": + "post": + "tags": + - "Smart contract" + "summary": "Clear a contract's ABI" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/clearabi.md` for examples and detailed behavior." + "operationId": "wallet_clearabi_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/clearabi.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ClearABIServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ClearABIContractRequest" + "required": + - "owner_address" + - "contract_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ClearABIContractActuator.java#validate" + - "protocol/src/main/protos/core/contract/smart_contract.proto#ClearABIContract" diff --git a/docs/api/specs/http/createaccount.yaml b/docs/api/specs/http/createaccount.yaml new file mode 100644 index 00000000..d7e1d535 --- /dev/null +++ b/docs/api/specs/http/createaccount.yaml @@ -0,0 +1,45 @@ +"/wallet/createaccount": + "post": + "tags": + - "Account" + "summary": "Create an on-chain account (costs 1 TRX)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/createaccount.md` for examples and detailed behavior." + "operationId": "wallet_createaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/createaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CreateAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountCreateContractRequest" + "required": + - "owner_address" + - "account_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/CreateAccountActuator.java#validate" + - "protocol/src/main/protos/core/contract/account_contract.proto#AccountCreateContract" diff --git a/docs/api/specs/http/createassetissue.yaml b/docs/api/specs/http/createassetissue.yaml new file mode 100644 index 00000000..110cd2a9 --- /dev/null +++ b/docs/api/specs/http/createassetissue.yaml @@ -0,0 +1,51 @@ +"/wallet/createassetissue": + "post": + "tags": + - "TRC10 asset" + "summary": "Issue a TRC10 token" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/createassetissue.md` for examples and detailed behavior." + "operationId": "wallet_createassetissue_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/createassetissue.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CreateAssetIssueServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AssetIssueContractRequest" + "required": + - "owner_address" + - "name" + - "total_supply" + - "trx_num" + - "num" + - "start_time" + - "end_time" + - "url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/AssetIssueActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#AssetIssueContract" diff --git a/docs/api/specs/http/createtransaction.yaml b/docs/api/specs/http/createtransaction.yaml new file mode 100644 index 00000000..a3bf267a --- /dev/null +++ b/docs/api/specs/http/createtransaction.yaml @@ -0,0 +1,46 @@ +"/wallet/createtransaction": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Build a TRX transfer transaction" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/createtransaction.md` for examples and detailed behavior." + "operationId": "wallet_createtransaction_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/createtransaction.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TransferServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransferContractRequest" + "required": + - "owner_address" + - "to_address" + - "amount" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/TransferActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#TransferContract" diff --git a/docs/api/specs/http/createwitness.yaml b/docs/api/specs/http/createwitness.yaml new file mode 100644 index 00000000..7d3d830d --- /dev/null +++ b/docs/api/specs/http/createwitness.yaml @@ -0,0 +1,45 @@ +"/wallet/createwitness": + "post": + "tags": + - "Witness / governance" + "summary": "Apply to become an SR candidate" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/createwitness.md` for examples and detailed behavior." + "operationId": "wallet_createwitness_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/createwitness.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "CreateWitnessServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WitnessCreateContractRequest" + "required": + - "owner_address" + - "url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WitnessCreateActuator.java#validate" + - "protocol/src/main/protos/core/contract/witness_contract.proto#WitnessCreateContract" diff --git a/docs/api/specs/http/delegateresource.yaml b/docs/api/specs/http/delegateresource.yaml new file mode 100644 index 00000000..a863e728 --- /dev/null +++ b/docs/api/specs/http/delegateresource.yaml @@ -0,0 +1,47 @@ +"/wallet/delegateresource": + "post": + "tags": + - "Stake 2.0" + "summary": "Delegate resources to another account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/delegateresource.md` for examples and detailed behavior." + "operationId": "wallet_delegateresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/delegateresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "DelegateResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/DelegateResourceContractRequest" + "required": + - "owner_address" + - "balance" + - "receiver_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/DelegateResourceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#DelegateResourceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" diff --git a/docs/api/specs/http/deploycontract.yaml b/docs/api/specs/http/deploycontract.yaml new file mode 100644 index 00000000..15f85043 --- /dev/null +++ b/docs/api/specs/http/deploycontract.yaml @@ -0,0 +1,47 @@ +"/wallet/deploycontract": + "post": + "tags": + - "Smart contract" + "summary": "Deploy a contract" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/deploycontract.md` for examples and detailed behavior." + "operationId": "wallet_deploycontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/deploycontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "DeployContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CreateSmartContractRequest" + "required": + - "owner_address" + - "bytecode" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/VMActuator.java#validate" + - "framework/src/main/java/org/tron/core/services/http/DeployContractServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#CreateSmartContract" + - "protocol/src/main/protos/core/contract/smart_contract.proto#message ABI" diff --git a/docs/api/specs/http/estimateenergy.yaml b/docs/api/specs/http/estimateenergy.yaml new file mode 100644 index 00000000..fddc41b7 --- /dev/null +++ b/docs/api/specs/http/estimateenergy.yaml @@ -0,0 +1,67 @@ +"/wallet/estimateenergy": + "post": + "tags": + - "Smart contract" + "summary": "Estimate energy usage of a call" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/estimateenergy.md` for examples and detailed behavior." + "operationId": "wallet_estimateenergy_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/estimateenergy.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "code": + "type": "string" + "message": + "type": "string" + "energy_required": + "type": "integer" + "format": "int64" + "x-java-response": "EstimateEnergyMessage rendered by Util.printEstimateEnergyMessage" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "EstimateEnergyServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/estimateenergy" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "EstimateEnergyOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TriggerSmartContractRequest" + "required": + - "owner_address" + "anyOf": + - + "required": + - "contract_address" + "title": "EstimateenergyPostRequestRequiresContractAddress1" + - + "required": + - "data" + "title": "EstimateenergyPostRequestRequiresData2" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/EstimateEnergyServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#TriggerSmartContract" diff --git a/docs/api/specs/http/freezebalance.yaml b/docs/api/specs/http/freezebalance.yaml new file mode 100644 index 00000000..83e9ed98 --- /dev/null +++ b/docs/api/specs/http/freezebalance.yaml @@ -0,0 +1,46 @@ +"/wallet/freezebalance": + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Freeze TRX for resources (V1, chain rejects new requests)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/freezebalance.md` for examples and detailed behavior." + "operationId": "wallet_freezebalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/freezebalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "FreezeBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/FreezeBalanceContractRequest" + "required": + - "owner_address" + - "frozen_balance" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/FreezeBalanceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#FreezeBalanceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" diff --git a/docs/api/specs/http/freezebalancev2.yaml b/docs/api/specs/http/freezebalancev2.yaml new file mode 100644 index 00000000..1cae3614 --- /dev/null +++ b/docs/api/specs/http/freezebalancev2.yaml @@ -0,0 +1,46 @@ +"/wallet/freezebalancev2": + "post": + "tags": + - "Stake 2.0" + "summary": "Freeze TRX for resources" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/freezebalancev2.md` for examples and detailed behavior." + "operationId": "wallet_freezebalancev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/freezebalancev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "FreezeBalanceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/FreezeBalanceV2ContractRequest" + "required": + - "owner_address" + - "frozen_balance" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/FreezeBalanceV2Actuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#FreezeBalanceV2Contract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" diff --git a/docs/api/specs/http/getBrokerage.yaml b/docs/api/specs/http/getBrokerage.yaml new file mode 100644 index 00000000..14b9d800 --- /dev/null +++ b/docs/api/specs/http/getBrokerage.yaml @@ -0,0 +1,132 @@ +"/wallet/getBrokerage": + "get": + "tags": + - "Witness / governance" + "summary": "An SR's current brokerage rate" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getBrokerage.md` for examples and detailed behavior." + "operationId": "wallet_getBrokerage_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getBrokerage.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "brokerage": + "type": "integer" + "format": "int32" + "description": "Witness brokerage percentage, from 0 to 100." + "Error": + "type": "string" + "not": + "required": + - "Error" + "title": "GetBrokerageGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBrokerageServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getBrokerage" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBrokerageOnSolidityServlet" + "parameters": + - + "name": "address" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBrokerageServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "An SR's current brokerage rate" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getBrokerage.md` for examples and detailed behavior." + "operationId": "wallet_getBrokerage_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getBrokerage.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "brokerage": + "type": "integer" + "format": "int32" + "description": "Witness brokerage percentage, from 0 to 100." + "Error": + "type": "string" + "not": + "required": + - "Error" + "title": "GetBrokeragePostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBrokerageServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getBrokerage" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBrokerageOnSolidityServlet" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBrokerageServlet.java" + "requestBody": + "required": false + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-json-body" + "x-java-unknown-fields": "ignored-by-servlet-helper" + "application/x-www-form-urlencoded": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-form-body" diff --git a/docs/api/specs/http/getReward.yaml b/docs/api/specs/http/getReward.yaml new file mode 100644 index 00000000..d8e8049b --- /dev/null +++ b/docs/api/specs/http/getReward.yaml @@ -0,0 +1,134 @@ +"/wallet/getReward": + "get": + "tags": + - "Witness / governance" + "summary": "Claimable rewards for an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getReward.md` for examples and detailed behavior." + "operationId": "wallet_getReward_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getReward.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "reward": + "type": "integer" + "format": "int64" + "Error": + "type": "string" + "required": + - "reward" + "not": + "required": + - "Error" + "title": "GetRewardGetResultRequiresReward1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetRewardServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getReward" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetRewardOnSolidityServlet" + "parameters": + - + "name": "address" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetRewardServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Claimable rewards for an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getReward.md` for examples and detailed behavior." + "operationId": "wallet_getReward_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getReward.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "reward": + "type": "integer" + "format": "int64" + "Error": + "type": "string" + "required": + - "reward" + "not": + "required": + - "Error" + "title": "GetRewardPostResultRequiresReward1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetRewardServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getReward" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetRewardOnSolidityServlet" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetRewardServlet.java" + "requestBody": + "required": false + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-json-body" + "x-java-unknown-fields": "ignored-by-servlet-helper" + "application/x-www-form-urlencoded": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-form-body" diff --git a/docs/api/specs/http/getaccount.yaml b/docs/api/specs/http/getaccount.yaml new file mode 100644 index 00000000..ab349542 --- /dev/null +++ b/docs/api/specs/http/getaccount.yaml @@ -0,0 +1,106 @@ +"/wallet/getaccount": + "get": + "tags": + - "Account" + "summary": "Query an account by address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccount.md` for examples and detailed behavior." + "operationId": "wallet_getaccount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Account" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getaccount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAccountOnSolidityServlet" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "post": + "tags": + - "Account" + "summary": "Query an account by address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccount.md` for examples and detailed behavior." + "operationId": "wallet_getaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Account" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getaccount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAccountOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountRequest" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" diff --git a/docs/api/specs/http/getaccountbalance.yaml b/docs/api/specs/http/getaccountbalance.yaml new file mode 100644 index 00000000..e0459120 --- /dev/null +++ b/docs/api/specs/http/getaccountbalance.yaml @@ -0,0 +1,40 @@ +"/wallet/getaccountbalance": + "post": + "tags": + - "Account" + "summary": "Query an account's balance at a specific block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountbalance.md` for examples and detailed behavior." + "operationId": "wallet_getaccountbalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountbalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountBalanceResponse" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/AccountBalanceRequestRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountBalanceServlet.java" + - "protocol/src/main/protos/core/contract/balance_contract.proto#AccountBalanceRequest" diff --git a/docs/api/specs/http/getaccountnet.yaml b/docs/api/specs/http/getaccountnet.yaml new file mode 100644 index 00000000..1f27dc46 --- /dev/null +++ b/docs/api/specs/http/getaccountnet.yaml @@ -0,0 +1,94 @@ +"/wallet/getaccountnet": + "get": + "tags": + - "Account" + "summary": "Query an account's bandwidth resources" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountnet.md` for examples and detailed behavior." + "operationId": "wallet_getaccountnet_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountnet.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountNetMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountNetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountNetServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "post": + "tags": + - "Account" + "summary": "Query an account's bandwidth resources" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountnet.md` for examples and detailed behavior." + "operationId": "wallet_getaccountnet_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountnet.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountNetMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountNetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountRequest" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountNetServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" diff --git a/docs/api/specs/http/getaccountresource.yaml b/docs/api/specs/http/getaccountresource.yaml new file mode 100644 index 00000000..bde6dc0a --- /dev/null +++ b/docs/api/specs/http/getaccountresource.yaml @@ -0,0 +1,97 @@ +"/wallet/getaccountresource": + "get": + "tags": + - "Account" + "summary": "Query bandwidth + energy + TronPower" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountresource.md` for examples and detailed behavior." + "operationId": "wallet_getaccountresource_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountResourceMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Account" + "summary": "Query bandwidth + energy + TronPower" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/getaccountresource.md` for examples and detailed behavior." + "operationId": "wallet_getaccountresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/getaccountresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AccountResourceMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAccountResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAccountResourceServlet.java" diff --git a/docs/api/specs/http/getapprovedlist.yaml b/docs/api/specs/http/getapprovedlist.yaml new file mode 100644 index 00000000..17542f93 --- /dev/null +++ b/docs/api/specs/http/getapprovedlist.yaml @@ -0,0 +1,45 @@ +"/wallet/getapprovedlist": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Addresses that have already signed" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/getapprovedlist.md` for examples and detailed behavior." + "operationId": "wallet_getapprovedlist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/getapprovedlist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionApprovedList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionApprovedListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransactionRequest" + "required": + - "raw_data" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionApprovedListServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + - "protocol/src/main/protos/core/Tron.proto#Transaction" diff --git a/docs/api/specs/http/getassetissuebyaccount.yaml b/docs/api/specs/http/getassetissuebyaccount.yaml new file mode 100644 index 00000000..566ca546 --- /dev/null +++ b/docs/api/specs/http/getassetissuebyaccount.yaml @@ -0,0 +1,94 @@ +"/wallet/getassetissuebyaccount": + "get": + "tags": + - "TRC10 asset" + "summary": "TRC10s issued by an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyaccount.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyaccount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" + "post": + "tags": + - "TRC10 asset" + "summary": "TRC10s issued by an account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyaccount.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountRequest" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByAccountServlet.java" + - "protocol/src/main/protos/core/Tron.proto#Account" diff --git a/docs/api/specs/http/getassetissuebyid.yaml b/docs/api/specs/http/getassetissuebyid.yaml new file mode 100644 index 00000000..42aae967 --- /dev/null +++ b/docs/api/specs/http/getassetissuebyid.yaml @@ -0,0 +1,112 @@ +"/wallet/getassetissuebyid": + "get": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by id (recommended)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyid.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByIdServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by id (recommended)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyid.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByIdServlet.java" diff --git a/docs/api/specs/http/getassetissuebyname.yaml b/docs/api/specs/http/getassetissuebyname.yaml new file mode 100644 index 00000000..6674720c --- /dev/null +++ b/docs/api/specs/http/getassetissuebyname.yaml @@ -0,0 +1,112 @@ +"/wallet/getassetissuebyname": + "get": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by name (errors on duplicates)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyname_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByNameOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByNameServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "Look up a TRC10 by name (errors on duplicates)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuebyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuebyname_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuebyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuebyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueByNameOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueByNameServlet.java" diff --git a/docs/api/specs/http/getassetissuelist.yaml b/docs/api/specs/http/getassetissuelist.yaml new file mode 100644 index 00000000..10962e52 --- /dev/null +++ b/docs/api/specs/http/getassetissuelist.yaml @@ -0,0 +1,95 @@ +"/wallet/getassetissuelist": + "get": + "tags": + - "TRC10 asset" + "summary": "All TRC10s on the network" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "All TRC10s on the network" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListServlet.java" diff --git a/docs/api/specs/http/getassetissuelistbyname.yaml b/docs/api/specs/http/getassetissuelistbyname.yaml new file mode 100644 index 00000000..9981919e --- /dev/null +++ b/docs/api/specs/http/getassetissuelistbyname.yaml @@ -0,0 +1,112 @@ +"/wallet/getassetissuelistbyname": + "get": + "tags": + - "TRC10 asset" + "summary": "All TRC10s with a given name" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelistbyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelistbyname_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelistbyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelistbyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListByNameOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListByNameServlet.java" + "post": + "tags": + - "TRC10 asset" + "summary": "All TRC10s with a given name" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getassetissuelistbyname.md` for examples and detailed behavior." + "operationId": "wallet_getassetissuelistbyname_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getassetissuelistbyname.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAssetIssueListByNameServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getassetissuelistbyname" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAssetIssueListByNameOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "value": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAssetIssueListByNameServlet.java" diff --git a/docs/api/specs/http/getavailableunfreezecount.yaml b/docs/api/specs/http/getavailableunfreezecount.yaml new file mode 100644 index 00000000..4a6edb9e --- /dev/null +++ b/docs/api/specs/http/getavailableunfreezecount.yaml @@ -0,0 +1,114 @@ +"/wallet/getavailableunfreezecount": + "get": + "tags": + - "Stake 2.0" + "summary": "Remaining unfreeze count" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getavailableunfreezecount.md` for examples and detailed behavior." + "operationId": "wallet_getavailableunfreezecount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getavailableunfreezecount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/GetAvailableUnfreezeCountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAvailableUnfreezeCountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getavailableunfreezecount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAvailableUnfreezeCountOnSolidityServlet" + "parameters": + - + "name": "ownerAddress" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Alias for owner_address. At least one of ownerAddress or owner_address must be provided." + "x-source-derived": true + - + "name": "owner_address" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Address of the account that owns or initiates the request. At least one of ownerAddress or owner_address must be provided." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAvailableUnfreezeCountServlet.java" + "x-query-required-anyOf": + - + - "ownerAddress" + - + - "owner_address" + "post": + "tags": + - "Stake 2.0" + "summary": "Remaining unfreeze count" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getavailableunfreezecount.md` for examples and detailed behavior." + "operationId": "wallet_getavailableunfreezecount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getavailableunfreezecount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/GetAvailableUnfreezeCountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetAvailableUnfreezeCountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getavailableunfreezecount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetAvailableUnfreezeCountOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/GetAvailableUnfreezeCountRequestMessageRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetAvailableUnfreezeCountServlet.java" + - "protocol/src/main/protos/api/api.proto#GetAvailableUnfreezeCountRequestMessage" diff --git a/docs/api/specs/http/getbandwidthprices.yaml b/docs/api/specs/http/getbandwidthprices.yaml new file mode 100644 index 00000000..a2673c09 --- /dev/null +++ b/docs/api/specs/http/getbandwidthprices.yaml @@ -0,0 +1,81 @@ +"/wallet/getbandwidthprices": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Historical bandwidth unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getbandwidthprices.md` for examples and detailed behavior." + "operationId": "wallet_getbandwidthprices_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getbandwidthprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBandwidthPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getbandwidthprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBandwidthPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBandwidthPricesServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Historical bandwidth unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getbandwidthprices.md` for examples and detailed behavior." + "operationId": "wallet_getbandwidthprices_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getbandwidthprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBandwidthPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getbandwidthprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBandwidthPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBandwidthPricesServlet.java" diff --git a/docs/api/specs/http/getblock.yaml b/docs/api/specs/http/getblock.yaml new file mode 100644 index 00000000..2ac1b400 --- /dev/null +++ b/docs/api/specs/http/getblock.yaml @@ -0,0 +1,110 @@ +"/wallet/getblock": + "get": + "tags": + - "Block / transaction query" + "summary": "Generic block query (by num or hash)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblock.md` for examples and detailed behavior." + "operationId": "wallet_getblock_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockOnSolidityServlet" + "parameters": + - + "name": "id_or_num" + "in": "query" + "required": false + "schema": + "type": "string" + "description": "Block id or block number." + "x-source-derived": true + - + "name": "detail" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "Whether to return detailed block information." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockServlet.java" + - "protocol/src/main/protos/api/api.proto#BlockReq" + "post": + "tags": + - "Block / transaction query" + "summary": "Generic block query (by num or hash)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblock.md` for examples and detailed behavior." + "operationId": "wallet_getblock_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/BlockReqRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockServlet.java" + - "protocol/src/main/protos/api/api.proto#BlockReq" diff --git a/docs/api/specs/http/getblockbalance.yaml b/docs/api/specs/http/getblockbalance.yaml new file mode 100644 index 00000000..5d4429be --- /dev/null +++ b/docs/api/specs/http/getblockbalance.yaml @@ -0,0 +1,40 @@ +"/wallet/getblockbalance": + "post": + "tags": + - "Block / transaction query" + "summary": "Per-account balance changes within a block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbalance.md` for examples and detailed behavior." + "operationId": "wallet_getblockbalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockBalanceTrace" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/BlockIdentifierRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockBalanceServlet.java" + - "protocol/src/main/protos/core/contract/balance_contract.proto#BlockIdentifier" diff --git a/docs/api/specs/http/getblockbyid.yaml b/docs/api/specs/http/getblockbyid.yaml new file mode 100644 index 00000000..9cf7a631 --- /dev/null +++ b/docs/api/specs/http/getblockbyid.yaml @@ -0,0 +1,106 @@ +"/wallet/getblockbyid": + "get": + "tags": + - "Block / transaction query" + "summary": "Block by hash" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbyid.md` for examples and detailed behavior." + "operationId": "wallet_getblockbyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Block by hash" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbyid.md` for examples and detailed behavior." + "operationId": "wallet_getblockbyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/getblockbylatestnum.yaml b/docs/api/specs/http/getblockbylatestnum.yaml new file mode 100644 index 00000000..3a45c627 --- /dev/null +++ b/docs/api/specs/http/getblockbylatestnum.yaml @@ -0,0 +1,103 @@ +"/wallet/getblockbylatestnum": + "get": + "tags": + - "Block / transaction query" + "summary": "The most recent N blocks" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylatestnum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylatestnum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylatestnum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLatestNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylatestnum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLatestNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "The most recent N blocks" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylatestnum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylatestnum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylatestnum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLatestNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylatestnum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLatestNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/NumberMessageRequest" + "required": + - "num" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByLatestNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" diff --git a/docs/api/specs/http/getblockbylimitnext.yaml b/docs/api/specs/http/getblockbylimitnext.yaml new file mode 100644 index 00000000..5564b7d7 --- /dev/null +++ b/docs/api/specs/http/getblockbylimitnext.yaml @@ -0,0 +1,113 @@ +"/wallet/getblockbylimitnext": + "get": + "tags": + - "Block / transaction query" + "summary": "Blocks in a range" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylimitnext.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylimitnext_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylimitnext.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLimitNextServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylimitnext" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLimitNextOnSolidityServlet" + "parameters": + - + "name": "startNum" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Starting block number for the query range." + "x-source-derived": true + - + "name": "endNum" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Ending block number for the query range." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "Blocks in a range" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbylimitnext.md` for examples and detailed behavior." + "operationId": "wallet_getblockbylimitnext_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbylimitnext.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/BlockList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByLimitNextServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbylimitnext" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByLimitNextOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BlockLimitRequest" + "required": + - "endNum" + - "startNum" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByLimitNextServlet.java" + - "protocol/src/main/protos/api/api.proto#BlockLimit" diff --git a/docs/api/specs/http/getblockbynum.yaml b/docs/api/specs/http/getblockbynum.yaml new file mode 100644 index 00000000..5ce76826 --- /dev/null +++ b/docs/api/specs/http/getblockbynum.yaml @@ -0,0 +1,103 @@ +"/wallet/getblockbynum": + "get": + "tags": + - "Block / transaction query" + "summary": "Block by height" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbynum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbynum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbynum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbynum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": false + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Block by height" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getblockbynum.md` for examples and detailed behavior." + "operationId": "wallet_getblockbynum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getblockbynum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBlockByNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getblockbynum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBlockByNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/NumberMessageRequest" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBlockByNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" diff --git a/docs/api/specs/http/getburntrx.yaml b/docs/api/specs/http/getburntrx.yaml new file mode 100644 index 00000000..1dc808ee --- /dev/null +++ b/docs/api/specs/http/getburntrx.yaml @@ -0,0 +1,99 @@ +"/wallet/getburntrx": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Cumulative burned TRX" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getburntrx.md` for examples and detailed behavior." + "operationId": "wallet_getburntrx_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getburntrx.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "burnTrxAmount": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetburntrxGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBurnTrxServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getburntrx" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBurnTrxOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBurnTrxServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Cumulative burned TRX" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getburntrx.md` for examples and detailed behavior." + "operationId": "wallet_getburntrx_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getburntrx.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "burnTrxAmount": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetburntrxPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetBurnTrxServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getburntrx" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetBurnTrxOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetBurnTrxServlet.java" diff --git a/docs/api/specs/http/getcandelegatedmaxsize.yaml b/docs/api/specs/http/getcandelegatedmaxsize.yaml new file mode 100644 index 00000000..f699b63e --- /dev/null +++ b/docs/api/specs/http/getcandelegatedmaxsize.yaml @@ -0,0 +1,111 @@ +"/wallet/getcandelegatedmaxsize": + "get": + "tags": + - "Stake 2.0" + "summary": "Current maximum delegatable amount" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcandelegatedmaxsize.md` for examples and detailed behavior." + "operationId": "wallet_getcandelegatedmaxsize_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcandelegatedmaxsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanDelegatedMaxSizeResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanDelegatedMaxSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcandelegatedmaxsize" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanDelegatedMaxSizeOnSolidityServlet" + "parameters": + - + "name": "type" + "in": "query" + "required": false + "schema": + "type": "integer" + "format": "int32" + "description": "Account, contract, or resource type." + "x-source-derived": true + - + "name": "owner_address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Current maximum delegatable amount" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcandelegatedmaxsize.md` for examples and detailed behavior." + "operationId": "wallet_getcandelegatedmaxsize_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcandelegatedmaxsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanDelegatedMaxSizeResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanDelegatedMaxSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcandelegatedmaxsize" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanDelegatedMaxSizeOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CanDelegatedMaxSizeRequestMessageRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetCanDelegatedMaxSizeServlet.java" + - "protocol/src/main/protos/api/api.proto#CanDelegatedMaxSizeRequestMessage" diff --git a/docs/api/specs/http/getcanwithdrawunfreezeamount.yaml b/docs/api/specs/http/getcanwithdrawunfreezeamount.yaml new file mode 100644 index 00000000..347a208c --- /dev/null +++ b/docs/api/specs/http/getcanwithdrawunfreezeamount.yaml @@ -0,0 +1,111 @@ +"/wallet/getcanwithdrawunfreezeamount": + "get": + "tags": + - "Stake 2.0" + "summary": "Withdrawable unfreeze amount at a given time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md` for examples and detailed behavior." + "operationId": "wallet_getcanwithdrawunfreezeamount_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanWithdrawUnfreezeAmountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcanwithdrawunfreezeamount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountOnSolidityServlet" + "parameters": + - + "name": "owner_address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Address of the account that owns or initiates the request." + "x-source-derived": true + - + "name": "timestamp" + "in": "query" + "required": false + "schema": + "type": "integer" + "format": "int64" + "description": "Timestamp in milliseconds." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Withdrawable unfreeze amount at a given time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md` for examples and detailed behavior." + "operationId": "wallet_getcanwithdrawunfreezeamount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getcanwithdrawunfreezeamount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/CanWithdrawUnfreezeAmountResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getcanwithdrawunfreezeamount" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetCanWithdrawUnfreezeAmountOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/CanWithdrawUnfreezeAmountRequestMessageRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetCanWithdrawUnfreezeAmountServlet.java" + - "protocol/src/main/protos/api/api.proto#CanWithdrawUnfreezeAmountRequestMessage" diff --git a/docs/api/specs/http/getchainparameters.yaml b/docs/api/specs/http/getchainparameters.yaml new file mode 100644 index 00000000..79f7e0ad --- /dev/null +++ b/docs/api/specs/http/getchainparameters.yaml @@ -0,0 +1,74 @@ +"/wallet/getchainparameters": + "get": + "tags": + - "Witness / governance" + "summary": "Current chain parameters" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getchainparameters.md` for examples and detailed behavior." + "operationId": "wallet_getchainparameters_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getchainparameters.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ChainParameters" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetChainParametersServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetChainParametersServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Current chain parameters" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getchainparameters.md` for examples and detailed behavior." + "operationId": "wallet_getchainparameters_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getchainparameters.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ChainParameters" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetChainParametersServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetChainParametersServlet.java" diff --git a/docs/api/specs/http/getcontract.yaml b/docs/api/specs/http/getcontract.yaml new file mode 100644 index 00000000..4cd241ac --- /dev/null +++ b/docs/api/specs/http/getcontract.yaml @@ -0,0 +1,94 @@ +"/wallet/getcontract": + "get": + "tags": + - "Smart contract" + "summary": "Contract metadata" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontract.md` for examples and detailed behavior." + "operationId": "wallet_getcontract_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Smart contract" + "summary": "Contract metadata" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontract.md` for examples and detailed behavior." + "operationId": "wallet_getcontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContract" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/getcontractinfo.yaml b/docs/api/specs/http/getcontractinfo.yaml new file mode 100644 index 00000000..92c7b1c8 --- /dev/null +++ b/docs/api/specs/http/getcontractinfo.yaml @@ -0,0 +1,94 @@ +"/wallet/getcontractinfo": + "get": + "tags": + - "Smart contract" + "summary": "Full contract runtime info" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontractinfo.md` for examples and detailed behavior." + "operationId": "wallet_getcontractinfo_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontractinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContractDataWrapper" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractInfoServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Smart contract" + "summary": "Full contract runtime info" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/getcontractinfo.md` for examples and detailed behavior." + "operationId": "wallet_getcontractinfo_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/getcontractinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/SmartContractDataWrapper" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetContractInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetContractInfoServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/getdelegatedresource.yaml b/docs/api/specs/http/getdelegatedresource.yaml new file mode 100644 index 00000000..34b17c58 --- /dev/null +++ b/docs/api/specs/http/getdelegatedresource.yaml @@ -0,0 +1,111 @@ +"/wallet/getdelegatedresource": + "get": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation records (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresource.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresource_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresource" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceOnSolidityServlet" + "parameters": + - + "name": "fromAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Source account address." + "x-source-derived": true + - + "name": "toAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Destination account address." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation records (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresource.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresource" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/DelegatedResourceMessageRequest" + "required": + - "fromAddress" + - "toAddress" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceServlet.java" + - "protocol/src/main/protos/api/api.proto#DelegatedResourceMessage" diff --git a/docs/api/specs/http/getdelegatedresourceaccountindex.yaml b/docs/api/specs/http/getdelegatedresourceaccountindex.yaml new file mode 100644 index 00000000..fe43d570 --- /dev/null +++ b/docs/api/specs/http/getdelegatedresourceaccountindex.yaml @@ -0,0 +1,102 @@ +"/wallet/getdelegatedresourceaccountindex": + "get": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation counterparty addresses (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresourceaccountindex.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindex_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresourceaccountindex.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindex" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Query delegation counterparty addresses (V1, read-only)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/getdelegatedresourceaccountindex.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindex_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/getdelegatedresourceaccountindex.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindex" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceAccountIndexServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/getdelegatedresourceaccountindexv2.yaml b/docs/api/specs/http/getdelegatedresourceaccountindexv2.yaml new file mode 100644 index 00000000..0cbb11b3 --- /dev/null +++ b/docs/api/specs/http/getdelegatedresourceaccountindexv2.yaml @@ -0,0 +1,102 @@ +"/wallet/getdelegatedresourceaccountindexv2": + "get": + "tags": + - "Stake 2.0" + "summary": "Query delegation counterparty addresses" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindexv2_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindexv2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2OnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Query delegation counterparty addresses" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourceaccountindexv2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourceaccountindexv2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceAccountIndex" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourceaccountindexv2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceAccountIndexV2OnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceAccountIndexV2Servlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/getdelegatedresourcev2.yaml b/docs/api/specs/http/getdelegatedresourcev2.yaml new file mode 100644 index 00000000..8bb541e3 --- /dev/null +++ b/docs/api/specs/http/getdelegatedresourcev2.yaml @@ -0,0 +1,111 @@ +"/wallet/getdelegatedresourcev2": + "get": + "tags": + - "Stake 2.0" + "summary": "Query delegation records" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourcev2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourcev2_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourcev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourcev2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceV2OnSolidityServlet" + "parameters": + - + "name": "fromAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Source account address." + "x-source-derived": true + - + "name": "toAddress" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Destination account address." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Stake 2.0" + "summary": "Query delegation records" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/getdelegatedresourcev2.md` for examples and detailed behavior." + "operationId": "wallet_getdelegatedresourcev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/getdelegatedresourcev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/DelegatedResourceList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetDelegatedResourceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getdelegatedresourcev2" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetDelegatedResourceV2OnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/DelegatedResourceMessageRequest" + "required": + - "fromAddress" + - "toAddress" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetDelegatedResourceV2Servlet.java" + - "protocol/src/main/protos/api/api.proto#DelegatedResourceMessage" diff --git a/docs/api/specs/http/getenergyprices.yaml b/docs/api/specs/http/getenergyprices.yaml new file mode 100644 index 00000000..dcce6fb9 --- /dev/null +++ b/docs/api/specs/http/getenergyprices.yaml @@ -0,0 +1,81 @@ +"/wallet/getenergyprices": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Historical energy unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getenergyprices.md` for examples and detailed behavior." + "operationId": "wallet_getenergyprices_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getenergyprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetEnergyPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getenergyprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetEnergyPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetEnergyPricesServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Historical energy unit prices" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getenergyprices.md` for examples and detailed behavior." + "operationId": "wallet_getenergyprices_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getenergyprices.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/PricesResponseMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetEnergyPricesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getenergyprices" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetEnergyPricesOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetEnergyPricesServlet.java" diff --git a/docs/api/specs/http/getnextmaintenancetime.yaml b/docs/api/specs/http/getnextmaintenancetime.yaml new file mode 100644 index 00000000..24608c86 --- /dev/null +++ b/docs/api/specs/http/getnextmaintenancetime.yaml @@ -0,0 +1,83 @@ +"/wallet/getnextmaintenancetime": + "get": + "tags": + - "Witness / governance" + "summary": "Next maintenance period time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getnextmaintenancetime.md` for examples and detailed behavior." + "operationId": "wallet_getnextmaintenancetime_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getnextmaintenancetime.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NumberMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNextMaintenanceTimeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNextMaintenanceTimeServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Next maintenance period time" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getnextmaintenancetime.md` for examples and detailed behavior." + "operationId": "wallet_getnextmaintenancetime_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getnextmaintenancetime.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NumberMessage" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNextMaintenanceTimeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNextMaintenanceTimeServlet.java" diff --git a/docs/api/specs/http/getnodeinfo.yaml b/docs/api/specs/http/getnodeinfo.yaml new file mode 100644 index 00000000..ec7bf183 --- /dev/null +++ b/docs/api/specs/http/getnodeinfo.yaml @@ -0,0 +1,81 @@ +"/wallet/getnodeinfo": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Node status (also /monitor/getnodeinfo)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getnodeinfo.md` for examples and detailed behavior." + "operationId": "wallet_getnodeinfo_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getnodeinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNodeInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnodeinfo" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNodeInfoOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNodeInfoServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Node status (also /monitor/getnodeinfo)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/getnodeinfo.md` for examples and detailed behavior." + "operationId": "wallet_getnodeinfo_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/getnodeinfo.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNodeInfoServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnodeinfo" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNodeInfoOnSolidityServlet" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNodeInfoServlet.java" diff --git a/docs/api/specs/http/getnowblock.yaml b/docs/api/specs/http/getnowblock.yaml new file mode 100644 index 00000000..511901ff --- /dev/null +++ b/docs/api/specs/http/getnowblock.yaml @@ -0,0 +1,95 @@ +"/wallet/getnowblock": + "get": + "tags": + - "Block / transaction query" + "summary": "Latest block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getnowblock.md` for examples and detailed behavior." + "operationId": "wallet_getnowblock_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getnowblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNowBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnowblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNowBlockOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNowBlockServlet.java" + "post": + "tags": + - "Block / transaction query" + "summary": "Latest block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getnowblock.md` for examples and detailed behavior." + "operationId": "wallet_getnowblock_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getnowblock.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Block" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetNowBlockServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getnowblock" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetNowBlockOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetNowBlockServlet.java" diff --git a/docs/api/specs/http/getpaginatedassetissuelist.yaml b/docs/api/specs/http/getpaginatedassetissuelist.yaml new file mode 100644 index 00000000..82460eb8 --- /dev/null +++ b/docs/api/specs/http/getpaginatedassetissuelist.yaml @@ -0,0 +1,117 @@ +"/wallet/getpaginatedassetissuelist": + "get": + "tags": + - "TRC10 asset" + "summary": "Paginated TRC10 list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getpaginatedassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedassetissuelist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getpaginatedassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatedassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedAssetIssueListOnSolidityServlet" + "parameters": + - + "name": "offset" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "x-source-derived": true + - + "name": "limit" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedAssetIssueListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "post": + "tags": + - "TRC10 asset" + "summary": "Paginated TRC10 list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/getpaginatedassetissuelist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedassetissuelist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/getpaginatedassetissuelist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/AssetIssueList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedAssetIssueListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatedassetissuelist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedAssetIssueListOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/PaginatedMessageRequest" + "required": + - "limit" + - "offset" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedAssetIssueListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" diff --git a/docs/api/specs/http/getpaginatednowwitnesslist.yaml b/docs/api/specs/http/getpaginatednowwitnesslist.yaml new file mode 100644 index 00000000..03b3cbe0 --- /dev/null +++ b/docs/api/specs/http/getpaginatednowwitnesslist.yaml @@ -0,0 +1,117 @@ +"/wallet/getpaginatednowwitnesslist": + "get": + "tags": + - "Witness / governance" + "summary": "Paginated SR list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatednowwitnesslist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedNowWitnessListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatednowwitnesslist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedNowWitnessListOnSolidityServlet" + "parameters": + - + "name": "offset" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "x-source-derived": true + - + "name": "limit" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedNowWitnessListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "post": + "tags": + - "Witness / governance" + "summary": "Paginated SR list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatednowwitnesslist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatednowwitnesslist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedNowWitnessListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/getpaginatednowwitnesslist" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetPaginatedNowWitnessListOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/PaginatedMessageRequest" + "required": + - "limit" + - "offset" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedNowWitnessListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" diff --git a/docs/api/specs/http/getpaginatedproposallist.yaml b/docs/api/specs/http/getpaginatedproposallist.yaml new file mode 100644 index 00000000..595f90ca --- /dev/null +++ b/docs/api/specs/http/getpaginatedproposallist.yaml @@ -0,0 +1,105 @@ +"/wallet/getpaginatedproposallist": + "get": + "tags": + - "Witness / governance" + "summary": "Paginated proposal list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatedproposallist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedproposallist_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatedproposallist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedProposalListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "offset" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Zero-based pagination offset." + "x-source-derived": true + - + "name": "limit" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Maximum number of items to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedProposalListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" + "post": + "tags": + - "Witness / governance" + "summary": "Paginated proposal list" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getpaginatedproposallist.md` for examples and detailed behavior." + "operationId": "wallet_getpaginatedproposallist_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getpaginatedproposallist.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPaginatedProposalListServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/PaginatedMessageRequest" + "required": + - "limit" + - "offset" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPaginatedProposalListServlet.java" + - "protocol/src/main/protos/api/api.proto#PaginatedMessage" diff --git a/docs/api/specs/http/getpendingsize.yaml b/docs/api/specs/http/getpendingsize.yaml new file mode 100644 index 00000000..fd26c780 --- /dev/null +++ b/docs/api/specs/http/getpendingsize.yaml @@ -0,0 +1,87 @@ +"/wallet/getpendingsize": + "get": + "tags": + - "Block / transaction query" + "summary": "Pending pool size" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getpendingsize.md` for examples and detailed behavior." + "operationId": "wallet_getpendingsize_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getpendingsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "pendingSize": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetpendingsizeGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPendingSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPendingSizeServlet.java" + "post": + "tags": + - "Block / transaction query" + "summary": "Pending pool size" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/getpendingsize.md` for examples and detailed behavior." + "operationId": "wallet_getpendingsize_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/getpendingsize.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "pendingSize": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GetpendingsizePostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetPendingSizeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + [] + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetPendingSizeServlet.java" diff --git a/docs/api/specs/http/getproposalbyid.yaml b/docs/api/specs/http/getproposalbyid.yaml new file mode 100644 index 00000000..a97d7032 --- /dev/null +++ b/docs/api/specs/http/getproposalbyid.yaml @@ -0,0 +1,102 @@ +"/wallet/getproposalbyid": + "get": + "tags": + - "Witness / governance" + "summary": "Proposal by ID" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getproposalbyid.md` for examples and detailed behavior." + "operationId": "wallet_getproposalbyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getproposalbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Proposal" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetProposalByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "id" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Proposal id." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetProposalByIdServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "Proposal by ID" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/getproposalbyid.md` for examples and detailed behavior." + "operationId": "wallet_getproposalbyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/getproposalbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Proposal" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetProposalByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "id": + "type": "integer" + "description": "Proposal id." + "format": "int64" + "visible": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-shape": "servlet-json-fields" + "required": + - "id" + "x-java-unknown-fields": "ignored-by-jsonformat" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetProposalByIdServlet.java" diff --git a/docs/api/specs/http/getsignweight.yaml b/docs/api/specs/http/getsignweight.yaml new file mode 100644 index 00000000..7fc91913 --- /dev/null +++ b/docs/api/specs/http/getsignweight.yaml @@ -0,0 +1,45 @@ +"/wallet/getsignweight": + "post": + "tags": + - "Transaction build / broadcast" + "summary": "Current multi-sig weight" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/tx-build-and-broadcast/getsignweight.md` for examples and detailed behavior." + "operationId": "wallet_getsignweight_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/tx-build-and-broadcast/getsignweight.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionSignWeight" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionSignWeightServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransactionRequest" + "required": + - "raw_data" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionSignWeightServlet.java" + - "framework/src/main/java/org/tron/core/services/http/Util.java" + - "protocol/src/main/protos/core/Tron.proto#Transaction" diff --git a/docs/api/specs/http/gettransactionbyid.yaml b/docs/api/specs/http/gettransactionbyid.yaml new file mode 100644 index 00000000..4432b9e8 --- /dev/null +++ b/docs/api/specs/http/gettransactionbyid.yaml @@ -0,0 +1,106 @@ +"/wallet/gettransactionbyid": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionbyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionbyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactionbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionbyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionbyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionbyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactionbyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/gettransactioncountbyblocknum.yaml b/docs/api/specs/http/gettransactioncountbyblocknum.yaml new file mode 100644 index 00000000..81719aa0 --- /dev/null +++ b/docs/api/specs/http/gettransactioncountbyblocknum.yaml @@ -0,0 +1,113 @@ +"/wallet/gettransactioncountbyblocknum": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction count in a block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioncountbyblocknum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "count": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GettransactioncountbyblocknumGetResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionCountByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioncountbyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionCountByBlockNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionCountByBlockNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction count in a block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioncountbyblocknum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioncountbyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "object" + "additionalProperties": false + "properties": + "count": + "type": "integer" + "format": "int64" + "not": + "required": + - "Error" + "title": "GettransactioncountbyblocknumPostResultObject1" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionCountByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioncountbyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionCountByBlockNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/NumberMessageRequest" + "required": + - "num" diff --git a/docs/api/specs/http/gettransactionfrompending.yaml b/docs/api/specs/http/gettransactionfrompending.yaml new file mode 100644 index 00000000..97b32702 --- /dev/null +++ b/docs/api/specs/http/gettransactionfrompending.yaml @@ -0,0 +1,90 @@ +"/wallet/gettransactionfrompending": + "get": + "tags": + - "Block / transaction query" + "summary": "Single pending transaction" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionfrompending_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "Single pending transaction" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionfrompending_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionFromPendingServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/gettransactioninfobyblocknum.yaml b/docs/api/specs/http/gettransactioninfobyblocknum.yaml new file mode 100644 index 00000000..d56ca92d --- /dev/null +++ b/docs/api/specs/http/gettransactioninfobyblocknum.yaml @@ -0,0 +1,127 @@ +"/wallet/gettransactioninfobyblocknum": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction receipts by block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyblocknum_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionInfo" + "x-java-response": "Array of TransactionInfo rendered by printTransactionInfoList" + "title": "GettransactioninfobyblocknumGetResultArray1" + - + "type": "object" + "additionalProperties": false + "maxProperties": 0 + "x-java-response": "Empty object returned when num is not positive" + "title": "GettransactioninfobyblocknumGetResultEmpty2" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByBlockNumOnSolidityServlet" + "parameters": + - + "name": "num" + "in": "query" + "required": true + "schema": + "type": "integer" + "format": "int64" + "description": "Number of items or blocks to return." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByBlockNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction receipts by block" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyblocknum_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyblocknum.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "type": "array" + "items": + "$ref": "#/components/schemas/TransactionInfo" + "x-java-response": "Array of TransactionInfo rendered by printTransactionInfoList" + "title": "GettransactioninfobyblocknumPostResultArray1" + - + "type": "object" + "additionalProperties": false + "maxProperties": 0 + "x-java-response": "Empty object returned when num is not positive" + "title": "GettransactioninfobyblocknumPostResultEmpty2" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByBlockNumServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyblocknum" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByBlockNumOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/NumberMessageRequest" + "required": + - "num" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByBlockNumServlet.java" + - "protocol/src/main/protos/api/api.proto#NumberMessage" diff --git a/docs/api/specs/http/gettransactioninfobyid.yaml b/docs/api/specs/http/gettransactioninfobyid.yaml new file mode 100644 index 00000000..e26de685 --- /dev/null +++ b/docs/api/specs/http/gettransactioninfobyid.yaml @@ -0,0 +1,106 @@ +"/wallet/gettransactioninfobyid": + "get": + "tags": + - "Block / transaction query" + "summary": "Transaction receipt by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyid_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByIdOnSolidityServlet" + "parameters": + - + "name": "value" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Hex string, amount, or value field accepted by this endpoint." + "x-source-derived": true + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" + "post": + "tags": + - "Block / transaction query" + "summary": "Transaction receipt by txid" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactioninfobyid.md` for examples and detailed behavior." + "operationId": "wallet_gettransactioninfobyid_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactioninfobyid.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionInfo" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionInfoByIdServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/gettransactioninfobyid" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "GetTransactionInfoByIdOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/BytesMessageRequest" + "required": + - "value" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionInfoByIdServlet.java" + - "protocol/src/main/protos/api/api.proto#BytesMessage" diff --git a/docs/api/specs/http/gettransactionlistfrompending.yaml b/docs/api/specs/http/gettransactionlistfrompending.yaml new file mode 100644 index 00000000..5edbaa63 --- /dev/null +++ b/docs/api/specs/http/gettransactionlistfrompending.yaml @@ -0,0 +1,81 @@ +"/wallet/gettransactionlistfrompending": + "get": + "tags": + - "Block / transaction query" + "summary": "All pending transaction IDs" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionlistfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionlistfrompending_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionlistfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionIdList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionListFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "post": + "tags": + - "Block / transaction query" + "summary": "All pending transaction IDs" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/block-and-tx-query/gettransactionlistfrompending.md` for examples and detailed behavior." + "operationId": "wallet_gettransactionlistfrompending_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/block-and-tx-query/gettransactionlistfrompending.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/TransactionIdList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "GetTransactionListFromPendingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/GetTransactionListFromPendingServlet.java" + - "protocol/src/main/protos/api/api.proto#TransactionIdList" diff --git a/docs/api/specs/http/listnodes.yaml b/docs/api/specs/http/listnodes.yaml new file mode 100644 index 00000000..a30130fa --- /dev/null +++ b/docs/api/specs/http/listnodes.yaml @@ -0,0 +1,80 @@ +"/wallet/listnodes": + "get": + "tags": + - "Node / pricing / tools" + "summary": "Known peers (also /net/listnodes)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/listnodes.md` for examples and detailed behavior." + "operationId": "wallet_listnodes_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/listnodes.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListNodesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListNodesServlet.java" + "post": + "tags": + - "Node / pricing / tools" + "summary": "Known peers (also /net/listnodes)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/node-and-tools/listnodes.md` for examples and detailed behavior." + "operationId": "wallet_listnodes_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/node-and-tools/listnodes.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/NodeList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListNodesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true diff --git a/docs/api/specs/http/listproposals.yaml b/docs/api/specs/http/listproposals.yaml new file mode 100644 index 00000000..8722cb19 --- /dev/null +++ b/docs/api/specs/http/listproposals.yaml @@ -0,0 +1,83 @@ +"/wallet/listproposals": + "get": + "tags": + - "Witness / governance" + "summary": "List of proposals" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listproposals.md` for examples and detailed behavior." + "operationId": "wallet_listproposals_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listproposals.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListProposalsServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListProposalsServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "List of proposals" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listproposals.md` for examples and detailed behavior." + "operationId": "wallet_listproposals_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listproposals.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/ProposalList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListProposalsServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListProposalsServlet.java" diff --git a/docs/api/specs/http/listwitnesses.yaml b/docs/api/specs/http/listwitnesses.yaml new file mode 100644 index 00000000..606ea2d7 --- /dev/null +++ b/docs/api/specs/http/listwitnesses.yaml @@ -0,0 +1,95 @@ +"/wallet/listwitnesses": + "get": + "tags": + - "Witness / governance" + "summary": "All SR candidates" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listwitnesses.md` for examples and detailed behavior." + "operationId": "wallet_listwitnesses_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listwitnesses.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListWitnessesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/listwitnesses" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "ListWitnessesOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListWitnessesServlet.java" + "post": + "tags": + - "Witness / governance" + "summary": "All SR candidates" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/listwitnesses.md` for examples and detailed behavior." + "operationId": "wallet_listwitnesses_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/listwitnesses.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/WitnessList" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ListWitnessesServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/listwitnesses" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "ListWitnessesOnSolidityServlet" + "parameters": + - + "name": "visible" + "in": "query" + "required": false + "schema": + "type": "boolean" + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ListWitnessesServlet.java" diff --git a/docs/api/specs/http/participateassetissue.yaml b/docs/api/specs/http/participateassetissue.yaml new file mode 100644 index 00000000..4190fa28 --- /dev/null +++ b/docs/api/specs/http/participateassetissue.yaml @@ -0,0 +1,47 @@ +"/wallet/participateassetissue": + "post": + "tags": + - "TRC10 asset" + "summary": "Participate in a TRC10 fundraising" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/participateassetissue.md` for examples and detailed behavior." + "operationId": "wallet_participateassetissue_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/participateassetissue.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ParticipateAssetIssueServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ParticipateAssetIssueContractRequest" + "required": + - "owner_address" + - "to_address" + - "asset_name" + - "amount" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ParticipateAssetIssueActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#ParticipateAssetIssueContract" diff --git a/docs/api/specs/http/proposalapprove.yaml b/docs/api/specs/http/proposalapprove.yaml new file mode 100644 index 00000000..6d1a71ff --- /dev/null +++ b/docs/api/specs/http/proposalapprove.yaml @@ -0,0 +1,45 @@ +"/wallet/proposalapprove": + "post": + "tags": + - "Witness / governance" + "summary": "Vote on a proposal as an SR" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/proposalapprove.md` for examples and detailed behavior." + "operationId": "wallet_proposalapprove_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/proposalapprove.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ProposalApproveServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ProposalApproveContractRequest" + "required": + - "owner_address" + - "proposal_id" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ProposalApproveActuator.java#validate" + - "protocol/src/main/protos/core/contract/proposal_contract.proto#ProposalApproveContract" diff --git a/docs/api/specs/http/proposalcreate.yaml b/docs/api/specs/http/proposalcreate.yaml new file mode 100644 index 00000000..029a51cf --- /dev/null +++ b/docs/api/specs/http/proposalcreate.yaml @@ -0,0 +1,45 @@ +"/wallet/proposalcreate": + "post": + "tags": + - "Witness / governance" + "summary": "Create a chain-parameter proposal" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/proposalcreate.md` for examples and detailed behavior." + "operationId": "wallet_proposalcreate_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/proposalcreate.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ProposalCreateServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ProposalCreateContractRequest" + "required": + - "owner_address" + - "parameters" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ProposalCreateActuator.java#validate" + - "protocol/src/main/protos/core/contract/proposal_contract.proto#ProposalCreateContract" diff --git a/docs/api/specs/http/proposaldelete.yaml b/docs/api/specs/http/proposaldelete.yaml new file mode 100644 index 00000000..e4941330 --- /dev/null +++ b/docs/api/specs/http/proposaldelete.yaml @@ -0,0 +1,45 @@ +"/wallet/proposaldelete": + "post": + "tags": + - "Witness / governance" + "summary": "Withdraw your own proposal" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/proposaldelete.md` for examples and detailed behavior." + "operationId": "wallet_proposaldelete_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/proposaldelete.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ProposalDeleteServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/ProposalDeleteContractRequest" + "required": + - "owner_address" + - "proposal_id" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/ProposalDeleteActuator.java#validate" + - "protocol/src/main/protos/core/contract/proposal_contract.proto#ProposalDeleteContract" diff --git a/docs/api/specs/http/transferasset.yaml b/docs/api/specs/http/transferasset.yaml new file mode 100644 index 00000000..dd5c7df1 --- /dev/null +++ b/docs/api/specs/http/transferasset.yaml @@ -0,0 +1,47 @@ +"/wallet/transferasset": + "post": + "tags": + - "TRC10 asset" + "summary": "Transfer TRC10" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/transferasset.md` for examples and detailed behavior." + "operationId": "wallet_transferasset_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/transferasset.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TransferAssetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TransferAssetContractRequest" + "required": + - "asset_name" + - "owner_address" + - "to_address" + - "amount" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/TransferAssetActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#TransferAssetContract" diff --git a/docs/api/specs/http/triggerconstantcontract.yaml b/docs/api/specs/http/triggerconstantcontract.yaml new file mode 100644 index 00000000..4a1145f1 --- /dev/null +++ b/docs/api/specs/http/triggerconstantcontract.yaml @@ -0,0 +1,51 @@ +"/wallet/triggerconstantcontract": + "post": + "tags": + - "Smart contract" + "summary": "Read-only contract call" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/triggerconstantcontract.md` for examples and detailed behavior." + "operationId": "wallet_triggerconstantcontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/triggerconstantcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/TransactionExtention" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TriggerConstantContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "x-tron-alternate-endpoints": + - + "path": "/walletsolidity/triggerconstantcontract" + "service": "HTTP OnSolidity" + "consistency": "solidified" + "x-java-servlet": "TriggerConstantContractOnSolidityServlet" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TriggerSmartContractRequest" + "required": + - "owner_address" + "anyOf": + - + "required": + - "contract_address" + "title": "TriggerconstantcontractPostRequestRequiresContractAddress1" + - + "required": + - "data" + "title": "TriggerconstantcontractPostRequestRequiresData2" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/TriggerConstantContractServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#TriggerSmartContract" diff --git a/docs/api/specs/http/triggersmartcontract.yaml b/docs/api/specs/http/triggersmartcontract.yaml new file mode 100644 index 00000000..33453ebd --- /dev/null +++ b/docs/api/specs/http/triggersmartcontract.yaml @@ -0,0 +1,38 @@ +"/wallet/triggersmartcontract": + "post": + "tags": + - "Smart contract" + "summary": "Trigger a contract (write)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/triggersmartcontract.md` for examples and detailed behavior." + "operationId": "wallet_triggersmartcontract_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/triggersmartcontract.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "$ref": "#/components/schemas/TransactionExtention" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "TriggerSmartContractServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/TriggerSmartContractRequest" + "required": + - "owner_address" + - "contract_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/VMActuator.java#validate" + - "framework/src/main/java/org/tron/core/services/http/TriggerSmartContractServlet.java" + - "protocol/src/main/protos/core/contract/smart_contract.proto#TriggerSmartContract" diff --git a/docs/api/specs/http/undelegateresource.yaml b/docs/api/specs/http/undelegateresource.yaml new file mode 100644 index 00000000..3ee64013 --- /dev/null +++ b/docs/api/specs/http/undelegateresource.yaml @@ -0,0 +1,47 @@ +"/wallet/undelegateresource": + "post": + "tags": + - "Stake 2.0" + "summary": "Undelegate resources from another account" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/undelegateresource.md` for examples and detailed behavior." + "operationId": "wallet_undelegateresource_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/undelegateresource.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnDelegateResourceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnDelegateResourceContractRequest" + "required": + - "owner_address" + - "balance" + - "receiver_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnDelegateResourceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#UnDelegateResourceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" diff --git a/docs/api/specs/http/unfreezeasset.yaml b/docs/api/specs/http/unfreezeasset.yaml new file mode 100644 index 00000000..f7ebe0d8 --- /dev/null +++ b/docs/api/specs/http/unfreezeasset.yaml @@ -0,0 +1,44 @@ +"/wallet/unfreezeasset": + "post": + "tags": + - "TRC10 asset" + "summary": "Unfreeze TRC10 frozen by the issuer" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/unfreezeasset.md` for examples and detailed behavior." + "operationId": "wallet_unfreezeasset_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/unfreezeasset.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnFreezeAssetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnfreezeAssetContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnfreezeAssetActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#UnfreezeAssetContract" diff --git a/docs/api/specs/http/unfreezebalance.yaml b/docs/api/specs/http/unfreezebalance.yaml new file mode 100644 index 00000000..2af575b9 --- /dev/null +++ b/docs/api/specs/http/unfreezebalance.yaml @@ -0,0 +1,45 @@ +"/wallet/unfreezebalance": + "post": + "tags": + - "Stake 1.0 (unfreeze and query only)" + "summary": "Unfreeze matured resources (V1, still usable for legacy positions)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v1/unfreezebalance.md` for examples and detailed behavior." + "operationId": "wallet_unfreezebalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v1/unfreezebalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnFreezeBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnfreezeBalanceContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnfreezeBalanceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#UnfreezeBalanceContract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" diff --git a/docs/api/specs/http/unfreezebalancev2.yaml b/docs/api/specs/http/unfreezebalancev2.yaml new file mode 100644 index 00000000..7def287c --- /dev/null +++ b/docs/api/specs/http/unfreezebalancev2.yaml @@ -0,0 +1,46 @@ +"/wallet/unfreezebalancev2": + "post": + "tags": + - "Stake 2.0" + "summary": "Initiate unfreeze (14-day waiting period)" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/unfreezebalancev2.md` for examples and detailed behavior." + "operationId": "wallet_unfreezebalancev2_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/unfreezebalancev2.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UnFreezeBalanceV2Servlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UnfreezeBalanceV2ContractRequest" + "required": + - "owner_address" + - "unfreeze_balance" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UnfreezeBalanceV2Actuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#UnfreezeBalanceV2Contract" + - "protocol/src/main/protos/core/contract/common.proto#ResourceCode" diff --git a/docs/api/specs/http/updateBrokerage.yaml b/docs/api/specs/http/updateBrokerage.yaml new file mode 100644 index 00000000..a7fb1928 --- /dev/null +++ b/docs/api/specs/http/updateBrokerage.yaml @@ -0,0 +1,44 @@ +"/wallet/updateBrokerage": + "post": + "tags": + - "Witness / governance" + "summary": "Update an SR's brokerage" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/updateBrokerage.md` for examples and detailed behavior." + "operationId": "wallet_updateBrokerage_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/updateBrokerage.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateBrokerageServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateBrokerageContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateBrokerageActuator.java#validate" + - "protocol/src/main/protos/core/contract/storage_contract.proto#UpdateBrokerageContract" diff --git a/docs/api/specs/http/updateaccount.yaml b/docs/api/specs/http/updateaccount.yaml new file mode 100644 index 00000000..f8ff9df0 --- /dev/null +++ b/docs/api/specs/http/updateaccount.yaml @@ -0,0 +1,44 @@ +"/wallet/updateaccount": + "post": + "tags": + - "Account" + "summary": "Update an account's name" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/updateaccount.md` for examples and detailed behavior." + "operationId": "wallet_updateaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/updateaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/AccountUpdateContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateAccountActuator.java#validate" + - "protocol/src/main/protos/core/contract/account_contract.proto#AccountUpdateContract" diff --git a/docs/api/specs/http/updateasset.yaml b/docs/api/specs/http/updateasset.yaml new file mode 100644 index 00000000..268ed2f5 --- /dev/null +++ b/docs/api/specs/http/updateasset.yaml @@ -0,0 +1,45 @@ +"/wallet/updateasset": + "post": + "tags": + - "TRC10 asset" + "summary": "Update a TRC10's description / URL / limits" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/asset/updateasset.md` for examples and detailed behavior." + "operationId": "wallet_updateasset_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/asset/updateasset.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateAssetServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateAssetContractRequest" + "required": + - "owner_address" + - "url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateAssetActuator.java#validate" + - "protocol/src/main/protos/core/contract/asset_issue_contract.proto#UpdateAssetContract" diff --git a/docs/api/specs/http/updateenergylimit.yaml b/docs/api/specs/http/updateenergylimit.yaml new file mode 100644 index 00000000..4004d56c --- /dev/null +++ b/docs/api/specs/http/updateenergylimit.yaml @@ -0,0 +1,46 @@ +"/wallet/updateenergylimit": + "post": + "tags": + - "Smart contract" + "summary": "Change the deployer's energy limit" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/updateenergylimit.md` for examples and detailed behavior." + "operationId": "wallet_updateenergylimit_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/updateenergylimit.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateEnergyLimitServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateEnergyLimitContractRequest" + "required": + - "owner_address" + - "contract_address" + - "origin_energy_limit" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateEnergyLimitContractActuator.java#validate" + - "protocol/src/main/protos/core/contract/smart_contract.proto#UpdateEnergyLimitContract" diff --git a/docs/api/specs/http/updatesetting.yaml b/docs/api/specs/http/updatesetting.yaml new file mode 100644 index 00000000..64a1fb72 --- /dev/null +++ b/docs/api/specs/http/updatesetting.yaml @@ -0,0 +1,45 @@ +"/wallet/updatesetting": + "post": + "tags": + - "Smart contract" + "summary": "Change the user-energy percentage" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/smart-contract/updatesetting.md` for examples and detailed behavior." + "operationId": "wallet_updatesetting_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/smart-contract/updatesetting.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateSettingServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/UpdateSettingContractRequest" + "required": + - "owner_address" + - "contract_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/UpdateSettingContractActuator.java#validate" + - "protocol/src/main/protos/core/contract/smart_contract.proto#UpdateSettingContract" diff --git a/docs/api/specs/http/updatewitness.yaml b/docs/api/specs/http/updatewitness.yaml new file mode 100644 index 00000000..36326446 --- /dev/null +++ b/docs/api/specs/http/updatewitness.yaml @@ -0,0 +1,45 @@ +"/wallet/updatewitness": + "post": + "tags": + - "Witness / governance" + "summary": "Update an SR's URL" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/updatewitness.md` for examples and detailed behavior." + "operationId": "wallet_updatewitness_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/updatewitness.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "UpdateWitnessServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WitnessUpdateContractRequest" + "required": + - "owner_address" + - "update_url" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WitnessUpdateActuator.java#validate" + - "protocol/src/main/protos/core/contract/witness_contract.proto#WitnessUpdateContract" diff --git a/docs/api/specs/http/validateaddress.yaml b/docs/api/specs/http/validateaddress.yaml new file mode 100644 index 00000000..17cddd21 --- /dev/null +++ b/docs/api/specs/http/validateaddress.yaml @@ -0,0 +1,85 @@ +"/wallet/validateaddress": + "get": + "tags": + - "Account" + "summary": "Validate an address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/validateaddress.md` for examples and detailed behavior." + "operationId": "wallet_validateaddress_get" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/validateaddress.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "message": + "type": "string" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ValidateAddressServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "parameters": + - + "name": "address" + "in": "query" + "required": true + "schema": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-derived": true + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ValidateAddressServlet.java" + "post": + "tags": + - "Account" + "summary": "Validate an address" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/account/validateaddress.md` for examples and detailed behavior." + "operationId": "wallet_validateaddress_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/account/validateaddress.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "result": + "type": "boolean" + "message": + "type": "string" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "ValidateAddressServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "type": "object" + "additionalProperties": false + "properties": + "address": + "type": "string" + "description": "Account or contract address accepted by this endpoint." + "x-source-shape": "servlet-json-fields" + "x-java-unknown-fields": "ignored-by-jsonformat" + "required": + - "address" + "x-overlay-derived": true + "x-source-refs": + - "framework/src/main/java/org/tron/core/services/http/ValidateAddressServlet.java" diff --git a/docs/api/specs/http/votewitnessaccount.yaml b/docs/api/specs/http/votewitnessaccount.yaml new file mode 100644 index 00000000..f8fcadd7 --- /dev/null +++ b/docs/api/specs/http/votewitnessaccount.yaml @@ -0,0 +1,45 @@ +"/wallet/votewitnessaccount": + "post": + "tags": + - "Witness / governance" + "summary": "Vote for SRs" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/votewitnessaccount.md` for examples and detailed behavior." + "operationId": "wallet_votewitnessaccount_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/votewitnessaccount.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "VoteWitnessAccountServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/VoteWitnessContractRequest" + "required": + - "owner_address" + - "votes" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/VoteWitnessActuator.java#validate" + - "protocol/src/main/protos/core/contract/witness_contract.proto#VoteWitnessContract" diff --git a/docs/api/specs/http/withdrawbalance.yaml b/docs/api/specs/http/withdrawbalance.yaml new file mode 100644 index 00000000..20beb216 --- /dev/null +++ b/docs/api/specs/http/withdrawbalance.yaml @@ -0,0 +1,44 @@ +"/wallet/withdrawbalance": + "post": + "tags": + - "Witness / governance" + "summary": "Withdraw block production rewards / dividends" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/witness-and-governance/withdrawbalance.md` for examples and detailed behavior." + "operationId": "wallet_withdrawbalance_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/witness-and-governance/withdrawbalance.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "WithdrawBalanceServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WithdrawBalanceContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WithdrawBalanceActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#WithdrawBalanceContract" diff --git a/docs/api/specs/http/withdrawexpireunfreeze.yaml b/docs/api/specs/http/withdrawexpireunfreeze.yaml new file mode 100644 index 00000000..b5ff19f8 --- /dev/null +++ b/docs/api/specs/http/withdrawexpireunfreeze.yaml @@ -0,0 +1,44 @@ +"/wallet/withdrawexpireunfreeze": + "post": + "tags": + - "Stake 2.0" + "summary": "Withdraw matured unfreezes" + "description": "Endpoint registration, HTTP method, servlet, and request type are derived from java-tron source. See `docs/api/http/stake-v2/withdrawexpireunfreeze.md` for examples and detailed behavior." + "operationId": "wallet_withdrawexpireunfreeze_post" + "externalDocs": + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/http/stake-v2/withdrawexpireunfreeze.md" + "responses": + "200": + "description": "java-tron response. Most business errors are returned with HTTP 200 and an error object in the body." + "content": + "application/json": + "schema": + "oneOf": + - + "$ref": "#/components/schemas/Transaction" + - + "$ref": "#/components/schemas/JavaTronError" + "x-tron-business-error": + "httpStatus": 200 + "errorSchema": "#/components/schemas/JavaTronError" + "discriminatorField": "Error" + "404": + "description": "Endpoint disabled by node configuration." + "x-source-derived": true + "x-java-service": "FullNode HTTP" + "x-java-servlet": "WithdrawExpireUnfreezeServlet" + "x-java-source": "framework/src/main/java/org/tron/core/services/http/FullNodeHttpApiService.java" + "requestBody": + "required": true + "content": + "application/json": + "schema": + "allOf": + - + "$ref": "#/components/schemas/WithdrawExpireUnfreezeContractRequest" + "required": + - "owner_address" + "x-overlay-derived": true + "x-source-refs": + - "actuator/src/main/java/org/tron/core/actuator/WithdrawExpireUnfreezeActuator.java#validate" + - "protocol/src/main/protos/core/contract/balance_contract.proto#WithdrawExpireUnfreezeContract" diff --git a/docs/api/specs/json-rpc/buildTransaction.json b/docs/api/specs/json-rpc/buildTransaction.json new file mode 100644 index 00000000..c7bab576 --- /dev/null +++ b/docs/api/specs/json-rpc/buildTransaction.json @@ -0,0 +1,146 @@ +{ + "name": "buildTransaction", + "tags": [ + { + "name": "Transaction build" + } + ], + "summary": "Build an unsigned transaction (FullNode only; TRX transfer / TRC10 transfer / contract deploy / contract trigger)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/tx-build/buildTransaction.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "args", + "required": true, + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "from": { + "type": "string", + "description": "Sender account address." + }, + "to": { + "type": "string", + "description": "Recipient account or contract address." + }, + "gas": { + "type": "string", + "description": "Gas limit encoded as a hex quantity." + }, + "gasPrice": { + "type": "string", + "description": "Gas price encoded as a hex quantity." + }, + "value": { + "type": "string", + "description": "Hex string, amount, or value field accepted by this endpoint." + }, + "data": { + "type": "string", + "description": "Hex-encoded contract call data or transaction data." + }, + "nonce": { + "type": "string", + "description": "Transaction nonce encoded as a hex quantity." + }, + "tokenId": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "TRC10 token id." + }, + "tokenValue": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "TRC10 token amount." + }, + "abi": { + "type": "string", + "description": "Smart contract ABI definition." + }, + "consumeUserResourcePercent": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Percentage of contract execution resource cost paid by the user." + }, + "originEnergyLimit": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Origin energy limit for a deployed smart contract." + }, + "name": { + "type": "string", + "description": "Name encoded as expected by java-tron." + }, + "permissionId": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Permission id used to sign the transaction with a non-owner account permission." + }, + "extraData": { + "type": "string", + "description": "Extra transaction data encoded as expected by java-tron." + }, + "visible": { + "type": "boolean", + "description": "When true, addresses are encoded in base58check; when false or omitted, addresses are hex-encoded." + } + } + }, + "x-java-type": "BuildArguments", + "x-position": 0, + "description": "Transaction call arguments." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionJson" + }, + { + "type": "null", + "title": "BuildTransactionResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32600, + "message": "JsonRpcInvalidRequestException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/tx-build/buildTransaction.md" + }, + "x-source-derived": true, + "x-java-method": "buildTransaction", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 only (the Solidity port throws -32601)", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#buildTransaction", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#buildTransaction", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class TransactionJson", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/BuildArguments.java#class BuildArguments" + ] +} diff --git a/docs/api/specs/json-rpc/eth_accounts.json b/docs/api/specs/json-rpc/eth_accounts.json new file mode 100644 index 00000000..0e136d2e --- /dev/null +++ b/docs/api/specs/json-rpc/eth_accounts.json @@ -0,0 +1,35 @@ +{ + "name": "eth_accounts", + "tags": [ + { + "name": "Compatibility stub methods" + } + ], + "summary": "[]", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/stub/eth_accounts.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "x-java-type": "String[]" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/stub/eth_accounts.md" + }, + "x-source-derived": true, + "x-java-method": "getAccounts", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_accounts", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getAccounts" + ] +} diff --git a/docs/api/specs/json-rpc/eth_blockNumber.json b/docs/api/specs/json-rpc/eth_blockNumber.json new file mode 100644 index 00000000..246de0cc --- /dev/null +++ b/docs/api/specs/json-rpc/eth_blockNumber.json @@ -0,0 +1,32 @@ +{ + "name": "eth_blockNumber", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Latest block height", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_blockNumber.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_blockNumber.md" + }, + "x-source-derived": true, + "x-java-method": "getLatestBlockNum", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_blockNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getLatestBlockNum" + ] +} diff --git a/docs/api/specs/json-rpc/eth_call.json b/docs/api/specs/json-rpc/eth_call.json new file mode 100644 index 00000000..c55643bb --- /dev/null +++ b/docs/api/specs/json-rpc/eth_call.json @@ -0,0 +1,104 @@ +{ + "name": "eth_call", + "tags": [ + { + "name": "Smart contract calls" + } + ], + "summary": "Read-only contract call", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/smart-contract/eth_call.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "transactionCall", + "required": true, + "schema": { + "$ref": "#/components/schemas/TransactionCall" + }, + "x-java-type": "CallArguments", + "x-position": 0, + "description": "Transaction call arguments." + }, + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "latest" + ], + "title": "EthCallParamString1" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "blockNumber": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "description": "Hex-encoded block number." + } + }, + "required": [ + "blockNumber" + ], + "title": "EthCallParamRequiresBlockNumber2" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "blockHash": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$", + "description": "32-byte block hash, with or without the 0x prefix." + } + }, + "required": [ + "blockHash" + ], + "title": "EthCallParamRequiresBlockHash3" + } + ] + }, + "x-java-type": "Object", + "x-position": 1, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32600, + "message": "JsonRpcInvalidRequestException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/smart-contract/eth_call.md" + }, + "x-source-derived": true, + "x-java-method": "getCall", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_call", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getCall" + ] +} diff --git a/docs/api/specs/json-rpc/eth_chainId.json b/docs/api/specs/json-rpc/eth_chainId.json new file mode 100644 index 00000000..037a1c26 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_chainId.json @@ -0,0 +1,37 @@ +{ + "name": "eth_chainId", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "chainId (last 4 bytes of the genesis block hash)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_chainId.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_chainId.md" + }, + "x-source-derived": true, + "x-java-method": "ethChainId", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_chainId", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethChainId" + ] +} diff --git a/docs/api/specs/json-rpc/eth_coinbase.json b/docs/api/specs/json-rpc/eth_coinbase.json new file mode 100644 index 00000000..750ba5e0 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_coinbase.json @@ -0,0 +1,37 @@ +{ + "name": "eth_coinbase", + "tags": [ + { + "name": "Compatibility stub methods" + } + ], + "summary": "The configured etherbase address", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/stub/eth_coinbase.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/stub/eth_coinbase.md" + }, + "x-source-derived": true, + "x-java-method": "getCoinbase", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_coinbase", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getCoinbase" + ] +} diff --git a/docs/api/specs/json-rpc/eth_estimateGas.json b/docs/api/specs/json-rpc/eth_estimateGas.json new file mode 100644 index 00000000..6864081d --- /dev/null +++ b/docs/api/specs/json-rpc/eth_estimateGas.json @@ -0,0 +1,57 @@ +{ + "name": "eth_estimateGas", + "tags": [ + { + "name": "Smart contract calls" + } + ], + "summary": "Estimate energy consumption", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/smart-contract/eth_estimateGas.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "args", + "required": true, + "schema": { + "$ref": "#/components/schemas/TransactionCall" + }, + "x-java-type": "CallArguments", + "x-position": 0, + "description": "Transaction call arguments." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32600, + "message": "JsonRpcInvalidRequestException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/smart-contract/eth_estimateGas.md" + }, + "x-source-derived": true, + "x-java-method": "estimateGas", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_estimateGas", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#estimateGas", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/CallArguments.java#class CallArguments" + ] +} diff --git a/docs/api/specs/json-rpc/eth_gasPrice.json b/docs/api/specs/json-rpc/eth_gasPrice.json new file mode 100644 index 00000000..9fc5660e --- /dev/null +++ b/docs/api/specs/json-rpc/eth_gasPrice.json @@ -0,0 +1,32 @@ +{ + "name": "eth_gasPrice", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Current energy unit price (sun)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_gasPrice.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_gasPrice.md" + }, + "x-source-derived": true, + "x-java-method": "gasPrice", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_gasPrice", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#gasPrice" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getBalance.json b/docs/api/specs/json-rpc/eth_getBalance.json new file mode 100644 index 00000000..e0b949a0 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getBalance.json @@ -0,0 +1,61 @@ +{ + "name": "eth_getBalance", + "tags": [ + { + "name": "Account state" + } + ], + "summary": "Account TRX balance (sun)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/account/eth_getBalance.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "address", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0, + "description": "Account or contract address." + }, + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "type": "string", + "enum": [ + "latest" + ] + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/account/eth_getBalance.md" + }, + "x-source-derived": true, + "x-java-method": "getTrxBalance", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBalance", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTrxBalance" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getBlockByHash.json b/docs/api/specs/json-rpc/eth_getBlockByHash.json new file mode 100644 index 00000000..e1bb0823 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getBlockByHash.json @@ -0,0 +1,68 @@ +{ + "name": "eth_getBlockByHash", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a block by hash", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockByHash.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockHash", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte block hash, with or without the 0x prefix." + }, + { + "name": "fullTransactionObjects", + "required": true, + "schema": { + "type": "boolean" + }, + "x-java-type": "Boolean", + "x-position": 1, + "description": "Whether to return full transaction objects instead of transaction hashes." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BlockResult" + }, + { + "type": "null", + "title": "EthGetBlockByHashResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockByHash.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockByHash", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java#class BlockResult", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getBlockByNumber.json b/docs/api/specs/json-rpc/eth_getBlockByNumber.json new file mode 100644 index 00000000..e4e9ab3b --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getBlockByNumber.json @@ -0,0 +1,84 @@ +{ + "name": "eth_getBlockByNumber", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a block by height / tag", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockByNumber.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "bnOrId", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "", + "latest", + "earliest", + "finalized" + ], + "title": "EthGetBlockByNumberParamString1" + }, + { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "title": "EthGetBlockByNumberParamString2" + } + ] + }, + "x-java-type": "String", + "x-position": 0, + "description": "Hex block number or supported block tag." + }, + { + "name": "fullTransactionObjects", + "required": true, + "schema": { + "type": "boolean" + }, + "x-java-type": "Boolean", + "x-position": 1, + "description": "Whether to return full transaction objects instead of transaction hashes." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BlockResult" + }, + { + "type": "null", + "title": "EthGetBlockByNumberResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockByNumber.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockByNumber", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockByNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockByNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/JsonRpcApiUtil.java#getByJsonBlockId", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java#class BlockResult", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getBlockReceipts.json b/docs/api/specs/json-rpc/eth_getBlockReceipts.json new file mode 100644 index 00000000..f7b725eb --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getBlockReceipts.json @@ -0,0 +1,90 @@ +{ + "name": "eth_getBlockReceipts", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Receipt list for an entire block", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockReceipts.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockNumOrHashOrTag", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$", + "title": "EthGetBlockReceiptsParamString1" + }, + { + "oneOf": [ + { + "type": "string", + "enum": [ + "", + "latest", + "earliest", + "finalized" + ], + "title": "EthGetBlockReceiptsParamNested1String1" + }, + { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "title": "EthGetBlockReceiptsParamNested1String2" + } + ], + "title": "EthGetBlockReceiptsParamVariant2" + } + ] + }, + "x-java-type": "String", + "x-position": 0, + "description": "Block hash, hex block number, or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionReceipt" + }, + "title": "EthGetBlockReceiptsResultArray1" + }, + { + "type": "null", + "title": "EthGetBlockReceiptsResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockReceipts.md" + }, + "x-source-derived": true, + "x-java-method": "getBlockReceipts", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockReceipts", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getBlockReceipts", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionReceipt.java#class TransactionReceipt" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getBlockTransactionCountByHash.json b/docs/api/specs/json-rpc/eth_getBlockTransactionCountByHash.json new file mode 100644 index 00000000..7898da1d --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getBlockTransactionCountByHash.json @@ -0,0 +1,57 @@ +{ + "name": "eth_getBlockTransactionCountByHash", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Block transaction count (by hash)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByHash.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockHash", + "required": true, + "description": "32-byte block hash, with or without the 0x prefix.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "type": "string", + "x-java-type": "String", + "title": "EthGetBlockTransactionCountByHashResultString1" + }, + { + "type": "null", + "title": "EthGetBlockTransactionCountByHashResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByHash.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockTransactionCountByHash", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockTransactionCountByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockTransactionCountByHash" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getBlockTransactionCountByNumber.json b/docs/api/specs/json-rpc/eth_getBlockTransactionCountByNumber.json new file mode 100644 index 00000000..72b814c5 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getBlockTransactionCountByNumber.json @@ -0,0 +1,57 @@ +{ + "name": "eth_getBlockTransactionCountByNumber", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Block transaction count (by height)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByNumber.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "bnOrId", + "required": true, + "description": "Hex block number or supported block tag.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "type": "string", + "x-java-type": "String", + "title": "EthGetBlockTransactionCountByNumberResultString1" + }, + { + "type": "null", + "title": "EthGetBlockTransactionCountByNumberResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getBlockTransactionCountByNumber.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetBlockTransactionCountByNumber", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getBlockTransactionCountByNumber", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetBlockTransactionCountByNumber" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getCode.json b/docs/api/specs/json-rpc/eth_getCode.json new file mode 100644 index 00000000..0aa0290b --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getCode.json @@ -0,0 +1,61 @@ +{ + "name": "eth_getCode", + "tags": [ + { + "name": "Account state" + } + ], + "summary": "Contract runtime bytecode", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/account/eth_getCode.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "contractAddress", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0, + "description": "Contract address." + }, + { + "name": "bnOrId", + "required": true, + "schema": { + "type": "string", + "enum": [ + "latest" + ] + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/account/eth_getCode.md" + }, + "x-source-derived": true, + "x-java-method": "getABIOfSmartContract", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getCode", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getABIOfSmartContract" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getFilterChanges.json b/docs/api/specs/json-rpc/eth_getFilterChanges.json new file mode 100644 index 00000000..9f3e7077 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getFilterChanges.json @@ -0,0 +1,59 @@ +{ + "name": "eth_getFilterChanges", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Pull and drain filter increments", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_getFilterChanges.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "filterId", + "required": true, + "description": "Filter id returned by eth_newFilter or eth_newBlockFilter.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "x-java-type": "Object[]" + } + }, + "errors": [ + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_getFilterChanges.md" + }, + "x-source-derived": true, + "x-java-method": "getFilterChanges", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getFilterChanges", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getFilterChanges" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getFilterLogs.json b/docs/api/specs/json-rpc/eth_getFilterLogs.json new file mode 100644 index 00000000..15842965 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getFilterLogs.json @@ -0,0 +1,76 @@ +{ + "name": "eth_getFilterLogs", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Pull a log filter's full set (without draining)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_getFilterLogs.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "filterId", + "required": true, + "description": "Filter id returned by eth_newFilter or eth_newBlockFilter.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Log" + }, + "x-java-type": "LogFilterElement[]" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32005, + "message": "JsonRpcTooManyResultException" + }, + { + "code": -32000, + "message": "BadItemException" + }, + { + "code": -32000, + "message": "ExecutionException" + }, + { + "code": -32000, + "message": "InterruptedException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_getFilterLogs.md" + }, + "x-source-derived": true, + "x-java-method": "getFilterLogs", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getFilterLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getFilterLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class LogFilterElement" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getLogs.json b/docs/api/specs/json-rpc/eth_getLogs.json new file mode 100644 index 00000000..988dbc28 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getLogs.json @@ -0,0 +1,77 @@ +{ + "name": "eth_getLogs", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "One-shot log query", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_getLogs.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "fr", + "required": true, + "schema": { + "$ref": "#/components/schemas/LogFilter" + }, + "x-java-type": "FilterRequest", + "x-position": 0, + "description": "Log filter request." + } + ], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Log" + }, + "x-java-type": "LogFilterElement[]" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32005, + "message": "JsonRpcTooManyResultException" + }, + { + "code": -32000, + "message": "BadItemException" + }, + { + "code": -32000, + "message": "ExecutionException" + }, + { + "code": -32000, + "message": "InterruptedException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_getLogs.md" + }, + "x-source-derived": true, + "x-java-method": "getLogs", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getLogs", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class FilterRequest", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class LogFilterElement" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getStorageAt.json b/docs/api/specs/json-rpc/eth_getStorageAt.json new file mode 100644 index 00000000..1b38e6f6 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getStorageAt.json @@ -0,0 +1,71 @@ +{ + "name": "eth_getStorageAt", + "tags": [ + { + "name": "Account state" + } + ], + "summary": "Contract storage slot", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/account/eth_getStorageAt.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "address", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0, + "description": "Account or contract address." + }, + { + "name": "storageIdx", + "required": true, + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 1, + "description": "Storage slot index." + }, + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "type": "string", + "enum": [ + "latest" + ] + }, + "x-java-type": "String", + "x-position": 2, + "description": "Hex block number or supported block tag." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/account/eth_getStorageAt.md" + }, + "x-source-derived": true, + "x-java-method": "getStorageAt", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getStorageAt", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getStorageAt" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getTransactionByBlockHashAndIndex.json b/docs/api/specs/json-rpc/eth_getTransactionByBlockHashAndIndex.json new file mode 100644 index 00000000..de47de40 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getTransactionByBlockHashAndIndex.json @@ -0,0 +1,68 @@ +{ + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a transaction by block hash + index", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockHashAndIndex.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockHash", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte block hash, with or without the 0x prefix." + }, + { + "name": "index", + "required": true, + "schema": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$" + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex-encoded transaction index within the block." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionResult" + }, + { + "type": "null", + "title": "EthGetTransactionByBlockHashAndIndexResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockHashAndIndex.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionByBlockHashAndIndex", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionByBlockHashAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionByBlockHashAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getTransactionByBlockNumberAndIndex.json b/docs/api/specs/json-rpc/eth_getTransactionByBlockNumberAndIndex.json new file mode 100644 index 00000000..04037c2c --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getTransactionByBlockNumberAndIndex.json @@ -0,0 +1,83 @@ +{ + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a transaction by block height + index", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockNumberAndIndex.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "blockNumOrTag", + "required": true, + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "", + "latest", + "earliest", + "finalized" + ], + "title": "EthGetTransactionByBlockNumberAndIndexParamString1" + }, + { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$", + "title": "EthGetTransactionByBlockNumberAndIndexParamString2" + } + ] + }, + "x-java-type": "String", + "x-position": 0, + "description": "Hex block number or supported block tag." + }, + { + "name": "index", + "required": true, + "schema": { + "type": "string", + "pattern": "^0x[0-9a-fA-F]+$" + }, + "x-java-type": "String", + "x-position": 1, + "description": "Hex-encoded transaction index within the block." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionResult" + }, + { + "type": "null", + "title": "EthGetTransactionByBlockNumberAndIndexResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionByBlockNumberAndIndex.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionByBlockNumberAndIndex", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionByBlockNumberAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionByBlockNumberAndIndex", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getTransactionByHash.json b/docs/api/specs/json-rpc/eth_getTransactionByHash.json new file mode 100644 index 00000000..8a795892 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getTransactionByHash.json @@ -0,0 +1,57 @@ +{ + "name": "eth_getTransactionByHash", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a transaction by txid", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionByHash.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "txId", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte transaction id, with or without the 0x prefix." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionResult" + }, + { + "type": "null", + "title": "EthGetTransactionByHashResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionByHash.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionByHash", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionByHash", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionResult.java#class TransactionResult" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getTransactionReceipt.json b/docs/api/specs/json-rpc/eth_getTransactionReceipt.json new file mode 100644 index 00000000..9c238b8b --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getTransactionReceipt.json @@ -0,0 +1,57 @@ +{ + "name": "eth_getTransactionReceipt", + "tags": [ + { + "name": "Block / transaction query" + } + ], + "summary": "Query a receipt by txid", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/block-and-tx-query/eth_getTransactionReceipt.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "txid", + "required": true, + "schema": { + "type": "string", + "pattern": "^(0x)?[a-zA-Z0-9]{64}$" + }, + "x-java-type": "String", + "x-position": 0, + "description": "32-byte transaction id, with or without the 0x prefix." + } + ], + "result": { + "name": "result", + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/TransactionReceipt" + }, + { + "type": "null", + "title": "EthGetTransactionReceiptResultNull2" + } + ] + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/block-and-tx-query/eth_getTransactionReceipt.md" + }, + "x-source-derived": true, + "x-java-method": "getTransactionReceipt", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getTransactionReceipt", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getTransactionReceipt", + "framework/src/main/java/org/tron/core/services/jsonrpc/types/TransactionReceipt.java#class TransactionReceipt" + ] +} diff --git a/docs/api/specs/json-rpc/eth_getWork.json b/docs/api/specs/json-rpc/eth_getWork.json new file mode 100644 index 00000000..93150600 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_getWork.json @@ -0,0 +1,35 @@ +{ + "name": "eth_getWork", + "tags": [ + { + "name": "Compatibility stub methods" + } + ], + "summary": "[blockHash, null, null]", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/stub/eth_getWork.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "x-java-type": "List" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/stub/eth_getWork.md" + }, + "x-source-derived": true, + "x-java-method": "ethGetWork", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_getWork", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#ethGetWork" + ] +} diff --git a/docs/api/specs/json-rpc/eth_newBlockFilter.json b/docs/api/specs/json-rpc/eth_newBlockFilter.json new file mode 100644 index 00000000..8a4ce5e1 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_newBlockFilter.json @@ -0,0 +1,41 @@ +{ + "name": "eth_newBlockFilter", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Register a new-block filter", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_newBlockFilter.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32005, + "message": "JsonRpcExceedLimitException" + }, + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_newBlockFilter.md" + }, + "x-source-derived": true, + "x-java-method": "newBlockFilter", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_newBlockFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#newBlockFilter" + ] +} diff --git a/docs/api/specs/json-rpc/eth_newFilter.json b/docs/api/specs/json-rpc/eth_newFilter.json new file mode 100644 index 00000000..3b38c849 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_newFilter.json @@ -0,0 +1,53 @@ +{ + "name": "eth_newFilter", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Register a log filter", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_newFilter.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "fr", + "required": true, + "schema": { + "$ref": "#/components/schemas/LogFilter" + }, + "x-java-type": "FilterRequest", + "x-position": 0, + "description": "Log filter request." + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_newFilter.md" + }, + "x-source-derived": true, + "x-java-method": "newFilter", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_newFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#newFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class FilterRequest" + ] +} diff --git a/docs/api/specs/json-rpc/eth_protocolVersion.json b/docs/api/specs/json-rpc/eth_protocolVersion.json new file mode 100644 index 00000000..4d2c6ec2 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_protocolVersion.json @@ -0,0 +1,32 @@ +{ + "name": "eth_protocolVersion", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Protocol version of the current block header", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_protocolVersion.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_protocolVersion.md" + }, + "x-source-derived": true, + "x-java-method": "getProtocolVersion", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_protocolVersion", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getProtocolVersion" + ] +} diff --git a/docs/api/specs/json-rpc/eth_syncing.json b/docs/api/specs/json-rpc/eth_syncing.json new file mode 100644 index 00000000..2bfd13f7 --- /dev/null +++ b/docs/api/specs/json-rpc/eth_syncing.json @@ -0,0 +1,60 @@ +{ + "name": "eth_syncing", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Sync status", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/eth_syncing.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "x-java-type": "Object", + "oneOf": [ + { + "type": "boolean", + "const": false, + "title": "EthSyncingResultFalse1" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "startingBlock": { + "type": "string" + }, + "currentBlock": { + "type": "string" + }, + "highestBlock": { + "type": "string" + } + }, + "required": [ + "startingBlock", + "currentBlock", + "highestBlock" + ], + "title": "EthSyncingResultRequiresStartingBlockCurrentBlockHighestBlock2" + } + ] + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/eth_syncing.md" + }, + "x-source-derived": true, + "x-java-method": "getSyncingStatus", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_syncing", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getSyncingStatus", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#class SyncingResult" + ] +} diff --git a/docs/api/specs/json-rpc/eth_uninstallFilter.json b/docs/api/specs/json-rpc/eth_uninstallFilter.json new file mode 100644 index 00000000..a94eb21b --- /dev/null +++ b/docs/api/specs/json-rpc/eth_uninstallFilter.json @@ -0,0 +1,56 @@ +{ + "name": "eth_uninstallFilter", + "tags": [ + { + "name": "Logs / filters" + } + ], + "summary": "Uninstall a filter", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/filter/eth_uninstallFilter.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "filterId", + "required": true, + "description": "Filter id returned by eth_newFilter or eth_newBlockFilter.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "boolean", + "x-java-type": "boolean" + } + }, + "errors": [ + { + "code": -32601, + "message": "JsonRpcMethodNotFoundException" + }, + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + }, + { + "code": -32000, + "message": "ItemNotFoundException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/filter/eth_uninstallFilter.md" + }, + "x-source-derived": true, + "x-java-method": "uninstallFilter", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#eth_uninstallFilter", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#uninstallFilter" + ] +} diff --git a/docs/api/specs/json-rpc/net_listening.json b/docs/api/specs/json-rpc/net_listening.json new file mode 100644 index 00000000..7d998561 --- /dev/null +++ b/docs/api/specs/json-rpc/net_listening.json @@ -0,0 +1,32 @@ +{ + "name": "net_listening", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Whether listening on P2P", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/net_listening.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "boolean", + "x-java-type": "boolean" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/net_listening.md" + }, + "x-source-derived": true, + "x-java-method": "isListening", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#net_listening", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#isListening" + ] +} diff --git a/docs/api/specs/json-rpc/net_peerCount.json b/docs/api/specs/json-rpc/net_peerCount.json new file mode 100644 index 00000000..6929b95b --- /dev/null +++ b/docs/api/specs/json-rpc/net_peerCount.json @@ -0,0 +1,32 @@ +{ + "name": "net_peerCount", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Number of peers", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/net_peerCount.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/net_peerCount.md" + }, + "x-source-derived": true, + "x-java-method": "getPeerCount", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#net_peerCount", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getPeerCount" + ] +} diff --git a/docs/api/specs/json-rpc/net_version.json b/docs/api/specs/json-rpc/net_version.json new file mode 100644 index 00000000..740e2e52 --- /dev/null +++ b/docs/api/specs/json-rpc/net_version.json @@ -0,0 +1,37 @@ +{ + "name": "net_version", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Network ID (same as eth_chainId)", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/net_version.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32000, + "message": "JsonRpcInternalException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/net_version.md" + }, + "x-source-derived": true, + "x-java-method": "getNetVersion", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#net_version", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#getNetVersion" + ] +} diff --git a/docs/api/specs/json-rpc/web3_clientVersion.json b/docs/api/specs/json-rpc/web3_clientVersion.json new file mode 100644 index 00000000..c23429ad --- /dev/null +++ b/docs/api/specs/json-rpc/web3_clientVersion.json @@ -0,0 +1,32 @@ +{ + "name": "web3_clientVersion", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Client version string", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/web3_clientVersion.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/web3_clientVersion.md" + }, + "x-source-derived": true, + "x-java-method": "web3ClientVersion", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#web3_clientVersion", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#web3ClientVersion" + ] +} diff --git a/docs/api/specs/json-rpc/web3_sha3.json b/docs/api/specs/json-rpc/web3_sha3.json new file mode 100644 index 00000000..702811ed --- /dev/null +++ b/docs/api/specs/json-rpc/web3_sha3.json @@ -0,0 +1,48 @@ +{ + "name": "web3_sha3", + "tags": [ + { + "name": "Node info / chain identity" + } + ], + "summary": "Keccak-256 hash", + "description": "Method name, Java signature, parameters, return type, and declared errors are derived from java-tron source. See `docs/api/json-rpc/node/web3_sha3.md` for examples and detailed behavior.", + "paramStructure": "by-position", + "params": [ + { + "name": "data", + "required": true, + "description": "Hex-encoded input data.", + "schema": { + "type": "string" + }, + "x-java-type": "String", + "x-position": 0 + } + ], + "result": { + "name": "result", + "schema": { + "type": "string", + "x-java-type": "String" + } + }, + "errors": [ + { + "code": -32602, + "message": "JsonRpcInvalidParamsException" + } + ], + "externalDocs": { + "url": "https://github.com/tronprotocol/documentation-en/blob/master/docs/api/json-rpc/node/web3_sha3.md" + }, + "x-source-derived": true, + "x-java-method": "web3Sha3", + "x-java-source": "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java", + "x-ports": "FullNode 8545 / Solidity 8555", + "x-overlay-derived": true, + "x-source-refs": [ + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpc.java#web3_sha3", + "framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java#web3Sha3" + ] +} diff --git a/docs/index.md b/docs/index.md index 4e041ec2..884f0d82 100644 --- a/docs/index.md +++ b/docs/index.md @@ -71,3 +71,7 @@ java-tron 是 TRON 网络的官方 Java 客户端实现，由 TRON 协议团队 - [TRON 改进提案 (TIPs)](https://github.com/tronprotocol/tips) — 协议演进提案的提交、讨论与归档仓库 - [TRON 开发者中心](https://developers.tron.network/) — DApp 开发者文档、SDK、教程的英文总入口 - [TRON 官网](https://tron.network/index?lng=zh) — 项目动态、生态合作伙伴、社区入口 + +## 文档权威来源 + +英文文档仓库 ([`documentation-en`](https://github.com/tronprotocol/documentation-en)) 是 java-tron 文档的权威来源，本中文文档仓库 ([`documentation-zh`](https://github.com/tronprotocol/documentation-zh)) 为其翻译跟进版本。当中英文内容不一致时，以英文版为准；内容变更应先在英文源上进行，再同步到中文译文。 diff --git a/docs/llms.txt b/docs/llms.txt new file mode 100644 index 00000000..a6211d73 --- /dev/null +++ b/docs/llms.txt @@ -0,0 +1,49 @@ +# java-tron + +> java-tron 是 TRON 网络的官方 Java 客户端实现，由 TRON 协议团队维护。它实现了 TRON 主网协议——DPoS 共识、超级代表、账户与资源模型、智能合约、系统合约、多签权限——是运行全节点、参与超级代表选举、部署合约和构建 DApp 的基础软件。本站为英文权威文档 documentation-en 的中文翻译版本；当中英文不一致时，以英文版为准。 + +## 新手入门 + +- [入门指南](https://tronprotocol.github.io/documentation-zh/getting_started/getting_started_with_javatron/)：java-tron 与 TRON 协议的第一步。 +- [术语表](https://tronprotocol.github.io/documentation-zh/glossary/)：常见 TRON 与 java-tron 术语释义。 + +## 运行节点 + +- [部署 java-tron](https://tronprotocol.github.io/documentation-zh/using_javatron/installing_javatron/)：硬件要求、JDK 先决条件、源码编译、启动全节点/固化节点/超级代表节点、JVM 调优。 +- [备份与恢复](https://tronprotocol.github.io/documentation-zh/using_javatron/backup_restore/)：节点数据库的快照与恢复。 +- [轻全节点](https://tronprotocol.github.io/documentation-zh/using_javatron/litefullnode/)：运行与维护裁剪后的低占用节点。 +- [私链网络](https://tronprotocol.github.io/documentation-zh/using_javatron/private_network/)：搭建私有 TRON 链。 +- [节点监控](https://tronprotocol.github.io/documentation-zh/using_javatron/metrics/)：Prometheus / Grafana 指标与健康检查端点。 +- [节点维护工具 (Toolkit)](https://tronprotocol.github.io/documentation-zh/using_javatron/toolkit/)：数据库分区、轻节点裁剪、复制、LevelDB→RocksDB 转换、启动优化。 +- [升级到新版本](https://tronprotocol.github.io/documentation-zh/releases/upgrade-instruction/)：新版本的升级步骤。 + +## API 接口 + +- [API 总览](https://tronprotocol.github.io/documentation-zh/api/)：如何在 HTTP、JSON-RPC、gRPC 三套接口间选择。 +- [HTTP API 参考](https://tronprotocol.github.io/documentation-zh/api/http/)：`/wallet/*` 与 `/walletsolidity/*` 端点，按功能分组（账户、资产、区块/交易查询、交易构建/广播、智能合约、超级代表/治理、质押 v1/v2、节点/工具）。 +- [JSON-RPC API 参考](https://tronprotocol.github.io/documentation-zh/api/json-rpc/)：兼容以太坊的 `eth_*` / `net_*` / `web3_*` 方法，以及 Tron 特有的 `buildTransaction`，含端口、启用开关、编码约定与错误码。 +- [gRPC API 参考](https://tronprotocol.github.io/documentation-zh/api/rpc/)：`protocol.Wallet` / `protocol.WalletSolidity` 方法；契约由 java-tron 仓库中的 `.proto` 文件定义。 +- [OpenAPI 规范（HTTP）](https://tronprotocol.github.io/documentation-zh/api/openapi.yaml)：`/wallet/*` 与 `/walletsolidity/*` HTTP 接口的机器可读 OpenAPI 契约。 +- [OpenRPC 规范（JSON-RPC）](https://tronprotocol.github.io/documentation-zh/api/openrpc.json)：`eth_*` / `net_*` / `web3_*` 及 `buildTransaction` 方法的机器可读 OpenRPC 契约。 + +## 核心协议 + +- [DPoS 共识](https://tronprotocol.github.io/documentation-zh/mechanism-algorithm/dpos/)：委托权益证明出块机制。 +- [超级代表](https://tronprotocol.github.io/documentation-zh/mechanism-algorithm/sr/)：超级代表选举与区块生产。 +- [账户模型](https://tronprotocol.github.io/documentation-zh/mechanism-algorithm/account/)：账户类型与结构。 +- [资源模型](https://tronprotocol.github.io/documentation-zh/mechanism-algorithm/resource/)：带宽与能量、质押、资源代理。 +- [智能合约](https://tronprotocol.github.io/documentation-zh/contracts/contract/)：智能合约模型与生命周期。 +- [系统合约](https://tronprotocol.github.io/documentation-zh/mechanism-algorithm/system-contracts/)：链上系统合约类型。 +- [账户权限管理](https://tronprotocol.github.io/documentation-zh/mechanism-algorithm/multi-signatures/)：多签权限模型。 + +## 开发者 + +- [开发者指南](https://tronprotocol.github.io/documentation-zh/developers/java-tron/)：构建、贡献与扩展 java-tron。 +- [核心模块](https://tronprotocol.github.io/documentation-zh/developers/code-structure/)：源码结构与模块职责。 +- [wallet-cli](https://tronprotocol.github.io/documentation-zh/clients/wallet-cli/)：官方命令行钱包与密钥管理。 + +## 其它 + +- [源码与版本发布 (GitHub)](https://github.com/tronprotocol/java-tron)：java-tron 源码、版本发布与协议 `.proto` 定义。 +- [TRON 改进提案 (TIPs)](https://github.com/tronprotocol/tips)：协议演进提案。 +- [TRON 开发者中心](https://developers.tron.network/)：DApp 开发者文档、SDK、教程。 diff --git a/docs/using_javatron/installing_javatron.md b/docs/using_javatron/installing_javatron.md index 05d371aa..11130dc5 100644 --- a/docs/using_javatron/installing_javatron.md +++ b/docs/using_javatron/installing_javatron.md @@ -241,6 +241,13 @@ localwitness = [ ] ``` +!!! warning "保护好 SR 私钥" + `localwitness` 列表以明文形式存储 SR 账户私钥，任何能读取该文件的人都可以接管你的 SR 产块权限，因此务必妥善保护： + + - 限制文件权限，仅允许节点属主读取配置文件：`chmod 600 config.conf`（若使用 keystore 文件，请对其执行相同操作）。 + - 切勿将含有真实私钥的配置文件提交到 Git——即使之后删除，私钥仍会保留在提交历史中。请将含密钥的文件放在仓库目录之外，并加入 `.gitignore`。 + - 生产环境建议使用 keystore + 密码方式替代明文私钥（参见下文[使用 Keystore + 密码指定超级代表账户私钥](#keystore-password)）。 + 对于运行在高性能服务器（例如，≥ 64GB 内存）上的 SR 节点，强烈建议使用以下优化的 Java 启动命令。这些配置旨在确保区块生产的最大稳定性和效率。请执行与您的环境相对应的命令： #### 选项 1：JDK 8（x86_64 架构） @@ -338,7 +345,7 @@ node.backup { 2. 将其解压至 `tron` 项目的 `output-directory` 目录下。 3. 启动节点，节点将在数据快照的基础上继续同步。 -### 使用 Keystore + 密码指定超级代表账户私钥 +### 使用 Keystore + 密码指定超级代表账户私钥 { #keystore-password } 为了避免以明文方式在配置文件中指定私钥，您可以选择使用 `keystore` 文件和密码的方式。 diff --git a/mkdocs.yml b/mkdocs.yml index a9b57ffa..2bc23b54 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,6 +20,7 @@ nav: - 节点维护工具: using_javatron/toolkit.md - API接口: - 概述: api/index.md + - 机器可读定义: api/interface-definitions.md - HTTP 接口: - 概述: api/http/index.md - 账户: