From d79a2af657da1efed10bfe8b596e5b53f003c9f2 Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Thu, 2 May 2024 15:50:19 -0400 Subject: [PATCH 1/9] Add async txsub endpoint documentation --- .../resources/transactions/README.mdx | 1 + .../components/endpoints/transactions.yml | 142 +++++++++++++++++- .../asyncTransactionSubmissionSchema.yml | 35 +++++ openapi/horizon/main.yml | 2 + 4 files changed, 178 insertions(+), 2 deletions(-) create mode 100644 openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml diff --git a/network/horizon/api-reference/resources/transactions/README.mdx b/network/horizon/api-reference/resources/transactions/README.mdx index a1cea5c38..eb3067394 100644 --- a/network/horizon/api-reference/resources/transactions/README.mdx +++ b/network/horizon/api-reference/resources/transactions/README.mdx @@ -18,5 +18,6 @@ Learn more about [transactions](/docs/learn/glossary/#transaction). | GET | [/transactions/:transaction_id/effects](../retrieve-a-transactions-effects.api.mdx) | | GET | [/transactions](../list-all-transactions.api.mdx) | | POST | [/transactions](../submit-a-transaction.api.mdx) | +| POST | [/transactions_async](../submit-async-transaction.api.mdx) | diff --git a/openapi/horizon/components/endpoints/transactions.yml b/openapi/horizon/components/endpoints/transactions.yml index aeb2f004d..25d9f484d 100644 --- a/openapi/horizon/components/endpoints/transactions.yml +++ b/openapi/horizon/components/endpoints/transactions.yml @@ -116,5 +116,143 @@ paths: $ref: "../schemas/transactionSchema.yml#/components/schemas/SubmitTransaction" examples: SubmitaTransaction: - $ref: "../examples/responses/Transactions/SubmitaTransaction.yml#/components/examples/SubmitaTransaction" - + $ref: "../examples/responses/Transactions/SubmitaTransaction.yml#/components/examples/SubmitaTransaction" + /transactions_async: + post: + summary: Submit Async Transaction + description: "This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not." + operationId: SubmitAsyncTransaction + tags: + - Transactions + parameters: + - in: query + name: tx + schema: + type: string + description: The base64-encoded XDR of the transaction. + required: true + responses: + '201': + description: Transaction has been received by core and is in pending status. + content: + application/json: + schema: + $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/AsyncTransactionSubmissionResponse" + examples: + TransactionPending: + summary: Transaction Pending + value: + tx_status: "PENDING" + hash: "6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165" + '400': + description: Transaction is malformed; ERROR status from core. + content: + application/json: + schema: + oneOf: + - $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/AsyncTransactionSubmissionResponse" + - $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/Problem" + examples: + TransactionMalformed: + summary: Transaction Malformed + value: + type: "transaction_malformed" + title: "Transaction Malformed" + status: 400 + detail: "Horizon could not decode the transaction envelope in this request. A transaction should be an XDR TransactionEnvelope struct encoded using base64. The envelope read from this request is echoed in the `extras.envelope_xdr` field of this response for your convenience." + extras: + envelope_xdr: "" + TransactionError: + summary: ERROR Status from core + value: + errorResultXdr: "AAAAAAAAAGT////7AAAAAA==" + tx_status: "ERROR" + hash: "6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165" + '403': + description: Transaction submission has been disabled for Horizon. + content: + application/json: + schema: + $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/Problem" + examples: + TransactionSubmissionDisabled: + summary: Transaction Submission Disabled + value: + type: "transaction_submission_disabled" + title: "Transaction Submission Disabled" + status: 403 + detail: "Transaction submission has been disabled for Horizon. To enable it again, remove env variable DISABLE_TX_SUB." + extras: + envelope_xdr: "" + '409': + description: Transaction is a duplicate of a previously submitted transaction. + content: + application/json: + schema: + $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/AsyncTransactionSubmissionResponse" + examples: + TransactionDuplicate: + summary: Transaction Duplicate + value: + tx_status: "DUPLICATE" + hash: "6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165" + '500': + description: Transaction submission failure, exception or invalid status from core. + content: + application/json: + schema: + $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/Problem" + examples: + TransactionFailed: + summary: Transaction Submission Failed + value: + type: "transaction_submission_failed" + title: "Transaction Submission Failed" + status: 500 + detail: "Could not submit transaction to stellar-core. The `extras.error` field on this response contains further details. Descriptions of each code can be found at: https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-async/transaction_submission_failed" + extras: + envelope_xdr: "" + error: "Error details here" + TransactionException: + summary: Transaction Submission Exception + value: + type: "transaction_submission_exception" + title: "Transaction Submission Exception" + status: 500 + detail: "Received exception from stellar-core. The `extras.error` field on this response contains further details. Descriptions of each code can be found at: https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-async/transaction_submission_exception" + extras: + envelope_xdr: "" + error: "Exception details here" + TransactionInvalidStatus: + summary: Transaction Submission Invalid Status + value: + type: "transaction_submission_invalid_status" + title: "Transaction Submission Invalid Status" + status: 500 + detail: "Received invalid status from stellar-core. The `extras.error` field on this response contains further details. Descriptions of each code can be found at: https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-async/transaction_submission_invalid_status" + extras: + envelope_xdr: "" + error: "Error details here" + '503': + description: History DB is stale; core is unavailable for transaction submission. + content: + application/json: + schema: + oneOf: + - $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/AsyncTransactionSubmissionResponse" + - $ref: "../schemas/asyncTransactionSubmissionSchema.yml#/components/schemas/Problem" + examples: + HistoryDBStale: + summary: Historical DB Is Too Stale + value: + type: "stale_history" + title: "Historical DB Is Too Stale" + status: 503 + detail: "This horizon instance is configured to reject client requests when it can determine that the history database is lagging too far behind the connected instance of Stellar-Core or read replica. It's also possible that Stellar-Core is out of sync. Please try again later." + extras: + envelope_xdr: "" + TransactionTryAgainLater: + summary: TRY_AGAIN_LATER Status from core + value: + tx_status: "TRY_AGAIN_LATER" + hash: "6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165" diff --git a/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml b/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml new file mode 100644 index 000000000..9b9c15bcd --- /dev/null +++ b/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml @@ -0,0 +1,35 @@ +components: + schemas: + AsyncTransactionSubmissionResponse: + type: object + properties: + errorResultXdr: + type: string + nullable: true + description: TransactionResult XDR string which is present only if the submission status from core is an ERROR. + tx_status: + type: string + enum: ["ERROR", "PENDING", "DUPLICATE", "TRY_AGAIN_LATER"] + description: Status of the transaction submission. + hash: + type: string + description: Hash of the transaction. + Problem: + type: object + properties: + type: + type: string + description: Identifies the problem type. + title: + type: string + description: A short, human-readable summary of the problem type. + status: + type: integer + description: The HTTP status code for this occurrence of the problem. + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem. + extras: + type: object + additionalProperties: true + description: Additional details that might help the client understand the error(s) that occurred. \ No newline at end of file diff --git a/openapi/horizon/main.yml b/openapi/horizon/main.yml index 9727ecdb4..9e6535d7b 100644 --- a/openapi/horizon/main.yml +++ b/openapi/horizon/main.yml @@ -121,3 +121,5 @@ paths: $ref : './components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}~1effects' /transactions: $ref : './components/endpoints/transactions.yml#/paths/~1transactions' + /transactions_async: + $ref: './components/endpoints/transactions.yml#/paths/~1transactions_async' From ffd593d45a91c002fcc89431a15244cba1f271ae Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Thu, 2 May 2024 15:52:51 -0400 Subject: [PATCH 2/9] Add new line --- .../components/schemas/asyncTransactionSubmissionSchema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml b/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml index 9b9c15bcd..633d4abf3 100644 --- a/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml +++ b/openapi/horizon/components/schemas/asyncTransactionSubmissionSchema.yml @@ -32,4 +32,4 @@ components: extras: type: object additionalProperties: true - description: Additional details that might help the client understand the error(s) that occurred. \ No newline at end of file + description: Additional details that might help the client understand the error(s) that occurred. From 347431b6eedad80c87ef86e75641a1f4751892d6 Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Thu, 2 May 2024 16:09:07 -0400 Subject: [PATCH 3/9] Add async endpoint .mdx file --- .../submit-async-transaction.api.mdx | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 network/horizon/api-reference/resources/submit-async-transaction.api.mdx diff --git a/network/horizon/api-reference/resources/submit-async-transaction.api.mdx b/network/horizon/api-reference/resources/submit-async-transaction.api.mdx new file mode 100644 index 000000000..aeba33320 --- /dev/null +++ b/network/horizon/api-reference/resources/submit-async-transaction.api.mdx @@ -0,0 +1,78 @@ +--- +id: submit-async-transaction +title: "Submit Async Transaction" +description: "This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not." +sidebar_label: "Submit Async Transaction" +hide_title: true +hide_table_of_contents: true +api: eJztWVtvG7cS/isDvjQBVhc3jp2q6IMSu4mBnMSQFCCFYagUd1bLZpfcklzZOob/+8GQu9rVzXJ63Iei9otgiRzO5ZtvZsg7FqMVRhZOasUGbJJKC6jiQkvlwJazXDoLHJzhynJBq0Aq4Aq4XSoBOVcKDTgNLkUYO8wybkChu9HmWxcuHEgLMVo5VxjTMp5l+gZKi8bSv+GENfE30qW6dDDLtPgm1Zwk53CTygzhhktHXyXaAAeDttDKIiRG5/BBG/lfrbowdF4Zy3MEJ3OMQDrgmdVQGL2QMVoQGXLT7LeOu9KC0PSbF2aDJR2hDZKeKWYFlCpGYx1XcTgg7NJJZYUjCxtDuvCbLkFwRYsVmVyr+IOFq/fnkzWra59fv+j2DDojcYEd3mnL44Xs5vHtS9JHpCi+wU2KLiX3p7juQm7BlkKgtUmZZUuQao6W9NMGlHZdFjFdoOG0+iJmAzb2FgwpppNGEIuY43PLBles9a1l1xEruOE5OjT06x2TBJ4/SzRLFjHFc2QD5m5ZxKxIMedscMfcsqBvrTNSzVm0BTyEGbd4ctxBRYGI4evZiJy7YVyX3UfM4J+lNBizgTMl3l/TNyGWlo76sX9EHxsntByUcgszRAUGBcoFxjBbgo81BVdawniBKiashTCTy4RWDpUj0bwoMim8/3p/WJJ/t22qnv2BwrGIFYa87WTQDo3RZoS2zNzX2OxyjSqzjM8yDOZtuaoxJEjxngqbKU9EShYUBi0qB1pR/IMbPU6tJQ9U4PVg94ZLS1l9Php9HnkXu9tpWLNLQVRlTqjwy1nELs8/nV18es8idvbl8uPFu+HknEVsMvptOnw/vPg0/TicnI8INuuWjFcZtIngRlOvTMptehhDH7hNdyOG7JGOHMo2MT5enTSqIEQH4i3PiyzEq7X4MmDCR7vMc26WG8CqF0RswbMSvc6NI1t+ChaxEzGbnSanR8ezuP9GID8Vr/qCz07fHL3hr16L10d9MZslos9POO+fHJ3+yI/wp+Oj4xMUSf/o5DW7938RO+73H4a8tJDzLNEmx/jnEOctEHwXyLXCz4lP/k24f5er92+/NHqWYc7ur/cH5D+1SftD0ixpByWc2ULJNG+tq1XYJ6cO6HG/TyB0XGaEv0DvIHSZxcSzECNR2Ra6US0w0wUSzTiquMRnaF0XhutZkHpJM6Iln+Qtfc5rGdaZUjioWbO0RAOBSrtAtLo6zSCPQ7DbhxIyUKQa46AOwu946wy33Xrj9DY2v0MiMYtDevnNde3VBpa6NCC0WqCSqITHUZDh+a4lhg0Y83htW0J8uB6/AM/xBjzbAdwkUTas/95Per1e7zT888svbI3KVoz19Pn36uH8a3HvqvrE0hLNx96Jdf/ydIUm/HqINS9iVE4mEq0PfhGyDmhTKAQhFw6JGRJajYsgLXOuOoQ1sg2qoNa8vCV+q8hI5XCOZmeH8GEyuWx3a95xHo9aiNIYAt/GSf6QOkUPG7GhPd4WGVc8RLBAIRMpQrd78MwmATajxONYkkSeXbbitavUD1crIZhAMeIOcjlPXWhK6ViRSSr1G/2pT5EX9mXYUikbr1fDFcfuZdiGtM8qtO6n2mYtrBY/TLpNVkzjZscu+t0tuyHiVy0i/kt5BxMNqHzUaV6Yc6kiMJjrhadQWHAj/a9nF+Ph24/n08nX6fjL24NcV/PDTwfrM4e4DNnuAcWph1tIXdpsuWfEeG5Kn5tSdVaDZn9iNkv2NKZtDz11aXx9qDVtISDhMisNRoC3Av1aGlmlWvBMxv9fv/pcK59r5d9cK3/l8rH1sVr66OqY1OsP1MaV3Borr9dGlHer0WTHzRvdx7XuvcL0sBoGyEOrKUBtTAGUhVwqC0lp/JVUFYIunDVB8qSKXKQBj3Q1NiNYlioG7gaQOlfYQa8XYyiixnYrfbrazHu8kD2vhe3Ryk6wsONv7XppqOKdGni9lmGdxo8df23ZO+Tk/QU9CpWSJgn6XEEtRYPbk01NYo+CRLP60ajA1pYDwGhL342NUX0X1nDv1l3ovw8TbRc/ChYr5z0IjYtQ0sYrRj8Ij2pHNRU/HiNV8axr/UGgbJ1zAC27ivPTQ+YfhZktl/91PqlbqB23Cx+kddos4ewt9cnW8Qx/XrXNpeILLn3DHgr/nj72H3HhV1l69nZMRq5nS/hNCp6RIy4sTLSGsG47RbyTpmkQ1zr5QSEN/tdmTAJuhRaQiloJ4T0vtErkvDThvcsgGVl3HdWVm6WXG0VjJmE3pmeUXCoMzQe1I5WGEHPH6SqP5GZ8PvfPYVpDwg3MMJVV9yK0UiicT8ZKEZ3Ur3GddwQJbcL1n0EfYnqa+8FWr2LaWkk48cev7aLGrXT+iWupRBcuMyRtnFmGARky7tB833XfxCyHtPcjbd1gvvXZ7MELwPb0sjnTPfUMcx+xHF2q6aWs0NZPD9zRAW0GsFNPCoQYNIv6Zaw0hJaakmp6cWidQtfmpZ1N/CSsg0/hRZXRU5dUifYeqMEbZJJz0Niwt9/td4+oUyV1c+4zuXqWC0994HO1faG8ef5dwwzPz8L/mmfhupfAW9crMi4Vgchj+K7C/BXbgfnriKWUGIMrdndHjPXFZPf39HV4FKZMWF3wDRKe2c35rQ23F6Pqffcl7FPpGy7rJ+aKEphPjvqWjg2uqIqkyGNimau7asdQUHvW2rVV80jKKtsvP48n7P7+f/coyUM= +sidebar_class_name: "post api-method" +info_path: network/horizon/api-reference/resources/horizon +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Submit Async Transaction

+ + + + + +This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not. + +## Request + +

Query Parameters

+ +Transaction has been received by core and is in pending status. + +
Schema
Transaction Pending
+ +Transaction is malformed; ERROR status from core. + +
Schema
    oneOf
    extras object
    + +Additional details that might help the client understand the error(s) that occurred. + +
Transaction Malformed ERROR Status from core
+ +Transaction submission has been disabled for Horizon. + +
Schema
    extras object
    + +Additional details that might help the client understand the error(s) that occurred. + +
Transaction Submission Disabled
+ +Transaction is a duplicate of a previously submitted transaction. + +
Schema
Transaction Duplicate
+ +Transaction submission failure, exception or invalid status from core. + +
Schema
    extras object
    + +Additional details that might help the client understand the error(s) that occurred. + +
Transaction Submission Failed Transaction Submission Exception Transaction Submission Invalid Status
+ +History DB is stale; core is unavailable for transaction submission. + +
Schema
    oneOf
    extras object
    + +Additional details that might help the client understand the error(s) that occurred. + +
Historical DB Is Too Stale TRY_AGAIN_LATER Status from core
+ \ No newline at end of file From 42cc8048c9b3ff8b52067da7da96fb8c98bf3ce2 Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Thu, 2 May 2024 16:18:36 -0400 Subject: [PATCH 4/9] add bundled.yml --- openapi/horizon/bundled.yml | 176 ++++++++++++++++++++++++++++++++++++ 1 file changed, 176 insertions(+) diff --git a/openapi/horizon/bundled.yml b/openapi/horizon/bundled.yml index 982957426..76a73b8fd 100644 --- a/openapi/horizon/bundled.yml +++ b/openapi/horizon/bundled.yml @@ -1163,6 +1163,145 @@ paths: examples: SubmitaTransaction: $ref: '#/components/examples/SubmitaTransaction' + /transactions_async: + post: + summary: Submit Async Transaction + description: This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not. + operationId: SubmitAsyncTransaction + tags: + - Transactions + parameters: + - in: query + name: tx + schema: + type: string + description: The base64-encoded XDR of the transaction. + required: true + responses: + '201': + description: Transaction has been received by core and is in pending status. + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncTransactionSubmissionResponse' + examples: + TransactionPending: + summary: Transaction Pending + value: + tx_status: PENDING + hash: 6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165 + '400': + description: Transaction is malformed; ERROR status from core. + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AsyncTransactionSubmissionResponse' + - $ref: '#/components/schemas/Problem' + examples: + TransactionMalformed: + summary: Transaction Malformed + value: + type: transaction_malformed + title: Transaction Malformed + status: 400 + detail: Horizon could not decode the transaction envelope in this request. A transaction should be an XDR TransactionEnvelope struct encoded using base64. The envelope read from this request is echoed in the `extras.envelope_xdr` field of this response for your convenience. + extras: + envelope_xdr: '' + TransactionError: + summary: ERROR Status from core + value: + errorResultXdr: AAAAAAAAAGT////7AAAAAA== + tx_status: ERROR + hash: 6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165 + '403': + description: Transaction submission has been disabled for Horizon. + content: + application/json: + schema: + $ref: '#/components/schemas/Problem' + examples: + TransactionSubmissionDisabled: + summary: Transaction Submission Disabled + value: + type: transaction_submission_disabled + title: Transaction Submission Disabled + status: 403 + detail: Transaction submission has been disabled for Horizon. To enable it again, remove env variable DISABLE_TX_SUB. + extras: + envelope_xdr: '' + '409': + description: Transaction is a duplicate of a previously submitted transaction. + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncTransactionSubmissionResponse' + examples: + TransactionDuplicate: + summary: Transaction Duplicate + value: + tx_status: DUPLICATE + hash: 6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165 + '500': + description: Transaction submission failure, exception or invalid status from core. + content: + application/json: + schema: + $ref: '#/components/schemas/Problem' + examples: + TransactionFailed: + summary: Transaction Submission Failed + value: + type: transaction_submission_failed + title: Transaction Submission Failed + status: 500 + detail: 'Could not submit transaction to stellar-core. The `extras.error` field on this response contains further details. Descriptions of each code can be found at: https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-async/transaction_submission_failed' + extras: + envelope_xdr: '' + error: Error details here + TransactionException: + summary: Transaction Submission Exception + value: + type: transaction_submission_exception + title: Transaction Submission Exception + status: 500 + detail: 'Received exception from stellar-core. The `extras.error` field on this response contains further details. Descriptions of each code can be found at: https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-async/transaction_submission_exception' + extras: + envelope_xdr: '' + error: Exception details here + TransactionInvalidStatus: + summary: Transaction Submission Invalid Status + value: + type: transaction_submission_invalid_status + title: Transaction Submission Invalid Status + status: 500 + detail: 'Received invalid status from stellar-core. The `extras.error` field on this response contains further details. Descriptions of each code can be found at: https://developers.stellar.org/api/errors/http-status-codes/horizon-specific/transaction-submission-async/transaction_submission_invalid_status' + extras: + envelope_xdr: '' + error: Error details here + '503': + description: History DB is stale; core is unavailable for transaction submission. + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AsyncTransactionSubmissionResponse' + - $ref: '#/components/schemas/Problem' + examples: + HistoryDBStale: + summary: Historical DB Is Too Stale + value: + type: stale_history + title: Historical DB Is Too Stale + status: 503 + detail: This horizon instance is configured to reject client requests when it can determine that the history database is lagging too far behind the connected instance of Stellar-Core or read replica. It's also possible that Stellar-Core is out of sync. Please try again later. + extras: + envelope_xdr: '' + TransactionTryAgainLater: + summary: TRY_AGAIN_LATER Status from core + value: + tx_status: TRY_AGAIN_LATER + hash: 6cbb7f714bd08cea7c30cab7818a35c510cbbfc0a6aa06172a1e94146ecf0165 components: parameters: SponsorParam: @@ -3474,6 +3613,43 @@ components: - result_meta_xdr - memo_type - signatures + AsyncTransactionSubmissionResponse: + type: object + properties: + errorResultXdr: + type: string + nullable: true + description: TransactionResult XDR string which is present only if the submission status from core is an ERROR. + tx_status: + type: string + enum: + - ERROR + - PENDING + - DUPLICATE + - TRY_AGAIN_LATER + description: Status of the transaction submission. + hash: + type: string + description: Hash of the transaction. + Problem: + type: object + properties: + type: + type: string + description: Identifies the problem type. + title: + type: string + description: A short, human-readable summary of the problem type. + status: + type: integer + description: The HTTP status code for this occurrence of the problem. + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem. + extras: + type: object + additionalProperties: true + description: Additional details that might help the client understand the error(s) that occurred. examples: ListAllAccounts: value: From e0825b1c723046d2c2a9018e1b1b9476e318f855 Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Thu, 2 May 2024 16:30:09 -0400 Subject: [PATCH 5/9] add sidebar.js --- network/horizon/api-reference/resources/sidebar.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/network/horizon/api-reference/resources/sidebar.js b/network/horizon/api-reference/resources/sidebar.js index 9a7e250ed..14846db3d 100644 --- a/network/horizon/api-reference/resources/sidebar.js +++ b/network/horizon/api-reference/resources/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"horizon/api-reference/resources/horizon"},{"type":"category","label":"Accounts","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-accounts","label":"List all Accounts","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-account","label":"Retrieve an Account","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-transactions-by-account-id","label":"Retrieve an Account's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-operations-by-account-id","label":"Retrieve an Account's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-payments-by-account-id","label":"Retrieve an Account's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-effects-by-account-id","label":"Retrieve an Account's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offers-by-account-id","label":"Retrieve an Account's Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-account-id","label":"Retrieve an Account's Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-data-by-account-id","label":"Retrieve an Account's Data","className":"api-method get"}]},{"type":"category","label":"Assets","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-assets","label":"List all Assets","className":"api-method get"}]},{"type":"category","label":"Claimable Balances","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-claimable-balances","label":"List All Claimable Balances","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-claimable-balance","label":"Retrieve a Claimable Balance","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Effects","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-effects","label":"List All Effects","className":"api-method get"}]},{"type":"category","label":"Fee Stats","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-fee-stats","label":"Retrieve Fee Stats","className":"api-method get"}]},{"type":"category","label":"Liquidity Pools","items":[{"type":"doc","id":"horizon/api-reference/resources/list-liquidity-pools","label":"List Liquidity Pools","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-liquidity-pool","label":"Retrieve a Liquidity Pool","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-effects","label":"Retrieve Related Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-trades","label":"Retrieve Related Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Ledgers","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledger","label":"Retrieve a Ledger","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-transactions","label":"Retrieve a Ledger's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-payments","label":"Retrieve a Ledger's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-operations","label":"Retrieve a Ledger's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-effects","label":"Retrieve a Ledgers's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-ledgers","label":"List All Ledgers","className":"api-method get"}]},{"type":"category","label":"Offers","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-offers","label":"List All Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offer-by-offer-id","label":"Retrieve an Offer","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-offer-id","label":"Retrieve an Offer's Trades","className":"api-method get"}]},{"type":"category","label":"Order Books","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-order-book","label":"Retrieve an Order Book","className":"api-method get"}]},{"type":"category","label":"Trade Aggregations","items":[{"type":"doc","id":"horizon/api-reference/resources/list-trade-aggregations","label":"List Trade Aggregations","className":"api-method get"}]},{"type":"category","label":"Trades","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-trades","label":"List All Trades","className":"api-method get"}]},{"type":"category","label":"Transactions","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transaction","label":"Retrieve a Transaction","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-operations","label":"Retrieve a Transaction's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-effects","label":"Retrieve a Transaction's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-transactions","label":"List All Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/submit-a-transaction","label":"Submit a Transaction","className":"api-method post"}]},{"type":"category","label":"Operations","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operation","label":"Retrieve an Operation","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operations-effects","label":"Retrieve an Operation's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-operations","label":"List All Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-payments","label":"List All Payments","className":"api-method get"}]},{"type":"category","label":"Paths","items":[{"type":"doc","id":"horizon/api-reference/resources/list-strict-receive-payment-paths","label":"List Strict Receive Payment Paths","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-strict-send-payment-paths","label":"List Strict Send Payment Paths","className":"api-method get"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"horizon/api-reference/resources/horizon"},{"type":"category","label":"Accounts","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-accounts","label":"List all Accounts","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-account","label":"Retrieve an Account","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-transactions-by-account-id","label":"Retrieve an Account's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-operations-by-account-id","label":"Retrieve an Account's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-payments-by-account-id","label":"Retrieve an Account's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-effects-by-account-id","label":"Retrieve an Account's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offers-by-account-id","label":"Retrieve an Account's Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-account-id","label":"Retrieve an Account's Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-data-by-account-id","label":"Retrieve an Account's Data","className":"api-method get"}]},{"type":"category","label":"Assets","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-assets","label":"List all Assets","className":"api-method get"}]},{"type":"category","label":"Claimable Balances","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-claimable-balances","label":"List All Claimable Balances","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-claimable-balance","label":"Retrieve a Claimable Balance","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Effects","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-effects","label":"List All Effects","className":"api-method get"}]},{"type":"category","label":"Fee Stats","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-fee-stats","label":"Retrieve Fee Stats","className":"api-method get"}]},{"type":"category","label":"Liquidity Pools","items":[{"type":"doc","id":"horizon/api-reference/resources/list-liquidity-pools","label":"List Liquidity Pools","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-liquidity-pool","label":"Retrieve a Liquidity Pool","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-effects","label":"Retrieve Related Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-trades","label":"Retrieve Related Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Ledgers","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledger","label":"Retrieve a Ledger","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-transactions","label":"Retrieve a Ledger's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-payments","label":"Retrieve a Ledger's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-operations","label":"Retrieve a Ledger's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-effects","label":"Retrieve a Ledgers's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-ledgers","label":"List All Ledgers","className":"api-method get"}]},{"type":"category","label":"Offers","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-offers","label":"List All Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offer-by-offer-id","label":"Retrieve an Offer","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-offer-id","label":"Retrieve an Offer's Trades","className":"api-method get"}]},{"type":"category","label":"Order Books","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-order-book","label":"Retrieve an Order Book","className":"api-method get"}]},{"type":"category","label":"Trade Aggregations","items":[{"type":"doc","id":"horizon/api-reference/resources/list-trade-aggregations","label":"List Trade Aggregations","className":"api-method get"}]},{"type":"category","label":"Trades","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-trades","label":"List All Trades","className":"api-method get"}]},{"type":"category","label":"Transactions","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transaction","label":"Retrieve a Transaction","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-operations","label":"Retrieve a Transaction's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-effects","label":"Retrieve a Transaction's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-transactions","label":"List All Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/submit-a-transaction","label":"Submit a Transaction","className":"api-method post"},{"type":"doc","id":"horizon/api-reference/resources/submit-async-transaction","label":"Submit Async Transaction","className":"api-method post"}]},{"type":"category","label":"Operations","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operation","label":"Retrieve an Operation","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operations-effects","label":"Retrieve an Operation's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-operations","label":"List All Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-payments","label":"List All Payments","className":"api-method get"}]},{"type":"category","label":"Paths","items":[{"type":"doc","id":"horizon/api-reference/resources/list-strict-receive-payment-paths","label":"List Strict Receive Payment Paths","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-strict-send-payment-paths","label":"List Strict Send Payment Paths","className":"api-method get"}]}]; \ No newline at end of file From 7c7424da5ed578c68a6c2197168a737b0fe51c0f Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Fri, 3 May 2024 10:04:50 -0400 Subject: [PATCH 6/9] Update openapi/horizon/bundled.yml Co-authored-by: Jake Urban <10968980+JakeUrban@users.noreply.github.com> --- openapi/horizon/bundled.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi/horizon/bundled.yml b/openapi/horizon/bundled.yml index 76a73b8fd..18e5ab049 100644 --- a/openapi/horizon/bundled.yml +++ b/openapi/horizon/bundled.yml @@ -1166,7 +1166,7 @@ paths: /transactions_async: post: summary: Submit Async Transaction - description: This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not. + description: This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. operationId: SubmitAsyncTransaction tags: - Transactions From ebb2c1cc0f03f6ceb3083e2dfa25eec1a81878ea Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Mon, 6 May 2024 13:31:13 -0400 Subject: [PATCH 7/9] Change to "Asynchronously" --- network/horizon/api-reference/resources/sidebar.js | 2 +- openapi/horizon/bundled.yml | 4 ++-- openapi/horizon/components/endpoints/transactions.yml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/network/horizon/api-reference/resources/sidebar.js b/network/horizon/api-reference/resources/sidebar.js index 14846db3d..444332e2e 100644 --- a/network/horizon/api-reference/resources/sidebar.js +++ b/network/horizon/api-reference/resources/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"horizon/api-reference/resources/horizon"},{"type":"category","label":"Accounts","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-accounts","label":"List all Accounts","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-account","label":"Retrieve an Account","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-transactions-by-account-id","label":"Retrieve an Account's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-operations-by-account-id","label":"Retrieve an Account's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-payments-by-account-id","label":"Retrieve an Account's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-effects-by-account-id","label":"Retrieve an Account's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offers-by-account-id","label":"Retrieve an Account's Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-account-id","label":"Retrieve an Account's Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-data-by-account-id","label":"Retrieve an Account's Data","className":"api-method get"}]},{"type":"category","label":"Assets","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-assets","label":"List all Assets","className":"api-method get"}]},{"type":"category","label":"Claimable Balances","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-claimable-balances","label":"List All Claimable Balances","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-claimable-balance","label":"Retrieve a Claimable Balance","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Effects","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-effects","label":"List All Effects","className":"api-method get"}]},{"type":"category","label":"Fee Stats","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-fee-stats","label":"Retrieve Fee Stats","className":"api-method get"}]},{"type":"category","label":"Liquidity Pools","items":[{"type":"doc","id":"horizon/api-reference/resources/list-liquidity-pools","label":"List Liquidity Pools","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-liquidity-pool","label":"Retrieve a Liquidity Pool","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-effects","label":"Retrieve Related Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-trades","label":"Retrieve Related Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Ledgers","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledger","label":"Retrieve a Ledger","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-transactions","label":"Retrieve a Ledger's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-payments","label":"Retrieve a Ledger's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-operations","label":"Retrieve a Ledger's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-effects","label":"Retrieve a Ledgers's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-ledgers","label":"List All Ledgers","className":"api-method get"}]},{"type":"category","label":"Offers","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-offers","label":"List All Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offer-by-offer-id","label":"Retrieve an Offer","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-offer-id","label":"Retrieve an Offer's Trades","className":"api-method get"}]},{"type":"category","label":"Order Books","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-order-book","label":"Retrieve an Order Book","className":"api-method get"}]},{"type":"category","label":"Trade Aggregations","items":[{"type":"doc","id":"horizon/api-reference/resources/list-trade-aggregations","label":"List Trade Aggregations","className":"api-method get"}]},{"type":"category","label":"Trades","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-trades","label":"List All Trades","className":"api-method get"}]},{"type":"category","label":"Transactions","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transaction","label":"Retrieve a Transaction","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-operations","label":"Retrieve a Transaction's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-effects","label":"Retrieve a Transaction's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-transactions","label":"List All Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/submit-a-transaction","label":"Submit a Transaction","className":"api-method post"},{"type":"doc","id":"horizon/api-reference/resources/submit-async-transaction","label":"Submit Async Transaction","className":"api-method post"}]},{"type":"category","label":"Operations","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operation","label":"Retrieve an Operation","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operations-effects","label":"Retrieve an Operation's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-operations","label":"List All Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-payments","label":"List All Payments","className":"api-method get"}]},{"type":"category","label":"Paths","items":[{"type":"doc","id":"horizon/api-reference/resources/list-strict-receive-payment-paths","label":"List Strict Receive Payment Paths","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-strict-send-payment-paths","label":"List Strict Send Payment Paths","className":"api-method get"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"horizon/api-reference/resources/horizon"},{"type":"category","label":"Accounts","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-accounts","label":"List all Accounts","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-account","label":"Retrieve an Account","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-transactions-by-account-id","label":"Retrieve an Account's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-operations-by-account-id","label":"Retrieve an Account's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-payments-by-account-id","label":"Retrieve an Account's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-effects-by-account-id","label":"Retrieve an Account's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offers-by-account-id","label":"Retrieve an Account's Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-account-id","label":"Retrieve an Account's Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-data-by-account-id","label":"Retrieve an Account's Data","className":"api-method get"}]},{"type":"category","label":"Assets","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-assets","label":"List all Assets","className":"api-method get"}]},{"type":"category","label":"Claimable Balances","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-claimable-balances","label":"List All Claimable Balances","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-claimable-balance","label":"Retrieve a Claimable Balance","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/cb-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Effects","items":[{"type":"doc","id":"horizon/api-reference/resources/list-all-effects","label":"List All Effects","className":"api-method get"}]},{"type":"category","label":"Fee Stats","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-fee-stats","label":"Retrieve Fee Stats","className":"api-method get"}]},{"type":"category","label":"Liquidity Pools","items":[{"type":"doc","id":"horizon/api-reference/resources/list-liquidity-pools","label":"List Liquidity Pools","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-liquidity-pool","label":"Retrieve a Liquidity Pool","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-effects","label":"Retrieve Related Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-related-trades","label":"Retrieve Related Trades","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/lp-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Ledgers","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledger","label":"Retrieve a Ledger","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-transactions","label":"Retrieve a Ledger's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-payments","label":"Retrieve a Ledger's Payments","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-operations","label":"Retrieve a Ledger's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-ledgers-effects","label":"Retrieve a Ledgers's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-ledgers","label":"List All Ledgers","className":"api-method get"}]},{"type":"category","label":"Offers","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-offers","label":"List All Offers","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-offer-by-offer-id","label":"Retrieve an Offer","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/get-trades-by-offer-id","label":"Retrieve an Offer's Trades","className":"api-method get"}]},{"type":"category","label":"Order Books","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-order-book","label":"Retrieve an Order Book","className":"api-method get"}]},{"type":"category","label":"Trade Aggregations","items":[{"type":"doc","id":"horizon/api-reference/resources/list-trade-aggregations","label":"List Trade Aggregations","className":"api-method get"}]},{"type":"category","label":"Trades","items":[{"type":"doc","id":"horizon/api-reference/resources/get-all-trades","label":"List All Trades","className":"api-method get"}]},{"type":"category","label":"Transactions","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transaction","label":"Retrieve a Transaction","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-operations","label":"Retrieve a Transaction's Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-a-transactions-effects","label":"Retrieve a Transaction's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-transactions","label":"List All Transactions","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/submit-a-transaction","label":"Submit a Transaction","className":"api-method post"},{"type":"doc","id":"horizon/api-reference/resources/submit-async-transaction","label":"Submit a Transaction Asynchronously","className":"api-method post"}]},{"type":"category","label":"Operations","items":[{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operation","label":"Retrieve an Operation","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/retrieve-an-operations-effects","label":"Retrieve an Operation's Effects","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-operations","label":"List All Operations","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-all-payments","label":"List All Payments","className":"api-method get"}]},{"type":"category","label":"Paths","items":[{"type":"doc","id":"horizon/api-reference/resources/list-strict-receive-payment-paths","label":"List Strict Receive Payment Paths","className":"api-method get"},{"type":"doc","id":"horizon/api-reference/resources/list-strict-send-payment-paths","label":"List Strict Send Payment Paths","className":"api-method get"}]}]; \ No newline at end of file diff --git a/openapi/horizon/bundled.yml b/openapi/horizon/bundled.yml index 18e5ab049..df97fe92c 100644 --- a/openapi/horizon/bundled.yml +++ b/openapi/horizon/bundled.yml @@ -1165,8 +1165,8 @@ paths: $ref: '#/components/examples/SubmitaTransaction' /transactions_async: post: - summary: Submit Async Transaction - description: This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. + summary: Submit a Transaction Asynchronously + description: This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. operationId: SubmitAsyncTransaction tags: - Transactions diff --git a/openapi/horizon/components/endpoints/transactions.yml b/openapi/horizon/components/endpoints/transactions.yml index 25d9f484d..9f1911f33 100644 --- a/openapi/horizon/components/endpoints/transactions.yml +++ b/openapi/horizon/components/endpoints/transactions.yml @@ -119,8 +119,8 @@ paths: $ref: "../examples/responses/Transactions/SubmitaTransaction.yml#/components/examples/SubmitaTransaction" /transactions_async: post: - summary: Submit Async Transaction - description: "This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not." + summary: Submit a Transaction Asynchronously + description: "This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon." operationId: SubmitAsyncTransaction tags: - Transactions From ef38089c2df8f4fdcd5d9f98580f24bb9ee67c81 Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Mon, 6 May 2024 13:31:48 -0400 Subject: [PATCH 8/9] Change to "Asynchronously" - 2 --- .../resources/submit-async-transaction.api.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/network/horizon/api-reference/resources/submit-async-transaction.api.mdx b/network/horizon/api-reference/resources/submit-async-transaction.api.mdx index aeba33320..7e1aa6dd4 100644 --- a/network/horizon/api-reference/resources/submit-async-transaction.api.mdx +++ b/network/horizon/api-reference/resources/submit-async-transaction.api.mdx @@ -1,11 +1,11 @@ --- id: submit-async-transaction -title: "Submit Async Transaction" -description: "This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not." -sidebar_label: "Submit Async Transaction" +title: "Submit a Transaction Asynchronously" +description: "This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon." +sidebar_label: "Submit a Transaction Asynchronously" hide_title: true hide_table_of_contents: true -api: eJztWVtvG7cS/isDvjQBVhc3jp2q6IMSu4mBnMSQFCCFYagUd1bLZpfcklzZOob/+8GQu9rVzXJ63Iei9otgiRzO5ZtvZsg7FqMVRhZOasUGbJJKC6jiQkvlwJazXDoLHJzhynJBq0Aq4Aq4XSoBOVcKDTgNLkUYO8wybkChu9HmWxcuHEgLMVo5VxjTMp5l+gZKi8bSv+GENfE30qW6dDDLtPgm1Zwk53CTygzhhktHXyXaAAeDttDKIiRG5/BBG/lfrbowdF4Zy3MEJ3OMQDrgmdVQGL2QMVoQGXLT7LeOu9KC0PSbF2aDJR2hDZKeKWYFlCpGYx1XcTgg7NJJZYUjCxtDuvCbLkFwRYsVmVyr+IOFq/fnkzWra59fv+j2DDojcYEd3mnL44Xs5vHtS9JHpCi+wU2KLiX3p7juQm7BlkKgtUmZZUuQao6W9NMGlHZdFjFdoOG0+iJmAzb2FgwpppNGEIuY43PLBles9a1l1xEruOE5OjT06x2TBJ4/SzRLFjHFc2QD5m5ZxKxIMedscMfcsqBvrTNSzVm0BTyEGbd4ctxBRYGI4evZiJy7YVyX3UfM4J+lNBizgTMl3l/TNyGWlo76sX9EHxsntByUcgszRAUGBcoFxjBbgo81BVdawniBKiashTCTy4RWDpUj0bwoMim8/3p/WJJ/t22qnv2BwrGIFYa87WTQDo3RZoS2zNzX2OxyjSqzjM8yDOZtuaoxJEjxngqbKU9EShYUBi0qB1pR/IMbPU6tJQ9U4PVg94ZLS1l9Php9HnkXu9tpWLNLQVRlTqjwy1nELs8/nV18es8idvbl8uPFu+HknEVsMvptOnw/vPg0/TicnI8INuuWjFcZtIngRlOvTMptehhDH7hNdyOG7JGOHMo2MT5enTSqIEQH4i3PiyzEq7X4MmDCR7vMc26WG8CqF0RswbMSvc6NI1t+ChaxEzGbnSanR8ezuP9GID8Vr/qCz07fHL3hr16L10d9MZslos9POO+fHJ3+yI/wp+Oj4xMUSf/o5DW7938RO+73H4a8tJDzLNEmx/jnEOctEHwXyLXCz4lP/k24f5er92+/NHqWYc7ur/cH5D+1SftD0ixpByWc2ULJNG+tq1XYJ6cO6HG/TyB0XGaEv0DvIHSZxcSzECNR2Ra6US0w0wUSzTiquMRnaF0XhutZkHpJM6Iln+Qtfc5rGdaZUjioWbO0RAOBSrtAtLo6zSCPQ7DbhxIyUKQa46AOwu946wy33Xrj9DY2v0MiMYtDevnNde3VBpa6NCC0WqCSqITHUZDh+a4lhg0Y83htW0J8uB6/AM/xBjzbAdwkUTas/95Per1e7zT888svbI3KVoz19Pn36uH8a3HvqvrE0hLNx96Jdf/ydIUm/HqINS9iVE4mEq0PfhGyDmhTKAQhFw6JGRJajYsgLXOuOoQ1sg2qoNa8vCV+q8hI5XCOZmeH8GEyuWx3a95xHo9aiNIYAt/GSf6QOkUPG7GhPd4WGVc8RLBAIRMpQrd78MwmATajxONYkkSeXbbitavUD1crIZhAMeIOcjlPXWhK6ViRSSr1G/2pT5EX9mXYUikbr1fDFcfuZdiGtM8qtO6n2mYtrBY/TLpNVkzjZscu+t0tuyHiVy0i/kt5BxMNqHzUaV6Yc6kiMJjrhadQWHAj/a9nF+Ph24/n08nX6fjL24NcV/PDTwfrM4e4DNnuAcWph1tIXdpsuWfEeG5Kn5tSdVaDZn9iNkv2NKZtDz11aXx9qDVtISDhMisNRoC3Av1aGlmlWvBMxv9fv/pcK59r5d9cK3/l8rH1sVr66OqY1OsP1MaV3Borr9dGlHer0WTHzRvdx7XuvcL0sBoGyEOrKUBtTAGUhVwqC0lp/JVUFYIunDVB8qSKXKQBj3Q1NiNYlioG7gaQOlfYQa8XYyiixnYrfbrazHu8kD2vhe3Ryk6wsONv7XppqOKdGni9lmGdxo8df23ZO+Tk/QU9CpWSJgn6XEEtRYPbk01NYo+CRLP60ajA1pYDwGhL342NUX0X1nDv1l3ovw8TbRc/ChYr5z0IjYtQ0sYrRj8Ij2pHNRU/HiNV8axr/UGgbJ1zAC27ivPTQ+YfhZktl/91PqlbqB23Cx+kddos4ewt9cnW8Qx/XrXNpeILLn3DHgr/nj72H3HhV1l69nZMRq5nS/hNCp6RIy4sTLSGsG47RbyTpmkQ1zr5QSEN/tdmTAJuhRaQiloJ4T0vtErkvDThvcsgGVl3HdWVm6WXG0VjJmE3pmeUXCoMzQe1I5WGEHPH6SqP5GZ8PvfPYVpDwg3MMJVV9yK0UiicT8ZKEZ3Ur3GddwQJbcL1n0EfYnqa+8FWr2LaWkk48cev7aLGrXT+iWupRBcuMyRtnFmGARky7tB833XfxCyHtPcjbd1gvvXZ7MELwPb0sjnTPfUMcx+xHF2q6aWs0NZPD9zRAW0GsFNPCoQYNIv6Zaw0hJaakmp6cWidQtfmpZ1N/CSsg0/hRZXRU5dUifYeqMEbZJJz0Niwt9/td4+oUyV1c+4zuXqWC0994HO1faG8ef5dwwzPz8L/mmfhupfAW9crMi4Vgchj+K7C/BXbgfnriKWUGIMrdndHjPXFZPf39HV4FKZMWF3wDRKe2c35rQ23F6Pqffcl7FPpGy7rJ+aKEphPjvqWjg2uqIqkyGNimau7asdQUHvW2rVV80jKKtsvP48n7P7+f/coyUM= +api: eJztWVtvG7cS/isDvjQBVhc3jp2q6IMSu4mBnMSQFCCFYagUd1bLZpfcklzZOob/+8GQu9rVzXJ63Iei9oshiRzO5ZtvZsg7FqMVRhZOasUGbJJKC6jiQkvlwJazXDoLHJzhynJBq8BpcCnC2GGWcQMK3Y0234DbpRKp0UqXNlt24cKBtBCjlXOFMe3iWaZvoLRoLH0M0tuiLdxIl+rSwSzT4ptUczoph5tUZgg3XDr6KtEGOBi0hVYWITE6hw/ayP9q1YWh88pZniM4mWME0gHPrIbC6IWM0YLIkJtmv3XclRaEpt+8MBss6whtkBRNMSugVDEa67iKwwFhl07CJ2+KIzMba7rwmy5BcEVLFNldq/mDhav355M1r9ZOv37R7Rl0RuICO7zTlscL2c3j25ekEznDe4KO34jODEEqkZUxxiAVcMgwnqMB0l2qOVpSdLZcOY1FTBdoOO2/iNmAjb05QwropBHNIub43LLBFWt9a9l1xApueI4ODf16xyRB6c8SzZJFTPEc2YC5WxYxK1LMORvcMbcs6FvrjFRzFm3BEGHGLZ4cd1BRZGL4ejaqvd32CbuPmME/S2kwZgNnSry/pm9CcC0d9WP/iP5tnNByWcotzBAVGBQoF8E5PvjeY5acWKCKCXwh7uQyoZVD5Ug0L4pMCu+/3h+W5N9tm6pnf6BwLGKFIW87GbRDY7QZoS0z9zU2u1yjyizjswyDeVuuagwJUrynwmZKHJGSBYVBi8qBVtkSZAu01pIHKjR79HvDpQWu4Hw0+jzyLna307Bml4KoypxQ4ZeziF2efzq7+PSeRezsy+XHi3fDyTmL2GT023T4fnjxafpxODkfEWzWLRmvpVQb042mXpmU2/Qwhj5wm+5GDNkjHTmUbWJ8vDppVEGIDsRbnhdZiFdr8WXAhI92mefcLDeAVS+I2IJnJXqdG0e2/BQsYidiNjtNTo+OZ3H/jUB+Kl71BZ+dvjl6w1+9Fq+P+mI2S0Sfn3DePzk6/ZEf4U/HR8cnKJL+0clrdu//Inbc7z8MeWkh51miTY7xzyHOWyD4LpBrhZ8Tn/ybcP8uV+/ffmn0LMOc3V/vD8h/apP2h6RZ0g5KOLOFkmneWlersE9OHdDjfp9A6LjMCH+BXUHoMotBaQcxEpVtoRvVAjNdEGmDo/pLfIbWdWG4ngWplzQjWvJJ3tLnvJZhnSmFg5o1S0s0EKi0C0Srq9MM8jgEu30oIQNFqkPpIFV/x1tnuO3WG6e3sfkdEolZHNLLb66LsTaw1KUBodUClUQlPI6CDM93LTFswJjHa9sS4sP1+AV4jjfg2Q7gJomyYf33ftLr9Xqn4cMvv7A1Klsx1tPn36uH86/FvavqE0tLNB97J7Zq8xMVmvDrIda8iFE5mUi0PvhFyDqgTaEQhFw4JGZIaDUugrTMueoQ1sg2qIJa8/KW+K0iI5XDOZqdHcKHyeSy3b5V/ZC0oIUojSHwbZzkD6lT9LARG9rjbZFxxUMECxQykSK0wwfPbBJgM0o8jiVJ5NllK167Sv1wtRKCCRQj7iCX89SFLpWOFZmkUr/RsPoUeWFfhi2VsvF6NVxx7F6GbUj7rELrfqpt1sJq8cOk22TFNG527KLf3bIbIn7VIuK/lHcw0YDKR50GiDmXKgKDuV54CoUFN9L/enYxHr79eD6dfJ2Ov7w9yHU1P/x0sD5ziMuQ7R5QnHq4hfTD1Z5547kpfW5K1VkNmv2J2SzZ05i2PfTUpfH1oda0hYCEy6w0GAHeCvRrQRuQasEzGf9//epzrXyulX9zrfyVy8fWx2rpo6tjUq8/UBtXcmusvF4bUd6tRpPtuzh/Q9e6CAvTw2oYIA+tpgC1MQVQFnKpLCSlcSmaOgRdOGuC5EkVuUgDHumebEawLFUM3A0gda6wg14vxlBEje1W+nS1mfd4IXteC9ujlZ1gYcdf4/XSUMU7NfB6LcM6jR87/s6yd8jJ+wt6FColTRL0fwW1FA1uTzY1iT0KEs3qR6MCW1sOAKMtfTc2RvVdWMO9W5ej/z5MtF38KFisnPcgNC5CSRuvGP0gPKod1VT8eIxUxbOu9QeBsnXOAbTsKs5PD5l/FGa2XP7X+aRuoXbcLnyQ1mmzhLO31CdbxzP8edU2l4ovuPQNeyj8e/rYf8SFX2Xp2dsxGbmeLeE3KXhGjriwMNEawrrtFPFOmqZBXOvkB4U0+F+bMQm4FVpAKmolhPe80CqR89KEFzCDZGTddVRXbhZu6H1IOo/dmJ5RcqkwNB/UjlQaQswdp6s8kpvx+dy/j2kNCTcww1RW3YvQSqFwPhkrRXRSP9d13hEktAnXfwZ9iOmx7gdbPZNpayXhxB+/tosat9KRMIpsFy4zJG2cWYYBGTLu0Hzfdd/ELIe09yNt3WC+9dnswQvA9vSyOdM99QxzH7EcXarppazQ1k8P3NEBbQawU08KhBg0i/plrDSElpqSanpxaJ1C1+alnU38JKyDT+HJldFTl1SJ9h6owRtkknPQ2LC33+13j6hTJXVz7jO5epYLT33A25fJMFx7yt1U5a4hief34n/pe3HdZOCt6xUZl4rQ5cF9VyXDFduRDNcRSyljBlfs7o6o7IvJ7u/p6/BaTCmyuvkbJDyzm4NdG3wvRtXD70vYp9I3XNZvzxVXMJ819fUdG1xReUmRx0Q/V3fVjqGgvq21a6sYkpQVDVx+Hk/Y/f3/AK9v12k= sidebar_class_name: "post api-method" info_path: network/horizon/api-reference/resources/horizon custom_edit_url: null @@ -24,13 +24,13 @@ import Markdown from "@theme/Markdown"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; -

Submit Async Transaction

+

Submit a Transaction Asynchronously

-This endpoint submits a transaction in an async manner to the Stellar network. It is designed to allow users to submit transaction without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to check whether the transaction was successfully ingested or not. +This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. ## Request From ba4e0d4834fe71f9ec68b34d5e67358ffabf715f Mon Sep 17 00:00:00 2001 From: Aditya Vyas Date: Mon, 6 May 2024 14:54:40 -0400 Subject: [PATCH 9/9] Change to "Asynchronously" - 3 --- .../resources/submit-async-transaction.api.mdx | 6 +++--- openapi/horizon/bundled.yml | 2 +- openapi/horizon/components/endpoints/transactions.yml | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/network/horizon/api-reference/resources/submit-async-transaction.api.mdx b/network/horizon/api-reference/resources/submit-async-transaction.api.mdx index 7e1aa6dd4..3e52fb231 100644 --- a/network/horizon/api-reference/resources/submit-async-transaction.api.mdx +++ b/network/horizon/api-reference/resources/submit-async-transaction.api.mdx @@ -1,11 +1,11 @@ --- id: submit-async-transaction title: "Submit a Transaction Asynchronously" -description: "This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon." +description: "This endpoint submits transactions to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon." sidebar_label: "Submit a Transaction Asynchronously" hide_title: true hide_table_of_contents: true -api: eJztWVtvG7cS/isDvjQBVhc3jp2q6IMSu4mBnMSQFCCFYagUd1bLZpfcklzZOob/+8GQu9rVzXJ63Iei9oshiRzO5ZtvZsg7FqMVRhZOasUGbJJKC6jiQkvlwJazXDoLHJzhynJBq8BpcCnC2GGWcQMK3Y0234DbpRKp0UqXNlt24cKBtBCjlXOFMe3iWaZvoLRoLH0M0tuiLdxIl+rSwSzT4ptUczoph5tUZgg3XDr6KtEGOBi0hVYWITE6hw/ayP9q1YWh88pZniM4mWME0gHPrIbC6IWM0YLIkJtmv3XclRaEpt+8MBss6whtkBRNMSugVDEa67iKwwFhl07CJ2+KIzMba7rwmy5BcEVLFNldq/mDhav355M1r9ZOv37R7Rl0RuICO7zTlscL2c3j25ekEznDe4KO34jODEEqkZUxxiAVcMgwnqMB0l2qOVpSdLZcOY1FTBdoOO2/iNmAjb05QwropBHNIub43LLBFWt9a9l1xApueI4ODf16xyRB6c8SzZJFTPEc2YC5WxYxK1LMORvcMbcs6FvrjFRzFm3BEGHGLZ4cd1BRZGL4ejaqvd32CbuPmME/S2kwZgNnSry/pm9CcC0d9WP/iP5tnNByWcotzBAVGBQoF8E5PvjeY5acWKCKCXwh7uQyoZVD5Ug0L4pMCu+/3h+W5N9tm6pnf6BwLGKFIW87GbRDY7QZoS0z9zU2u1yjyizjswyDeVuuagwJUrynwmZKHJGSBYVBi8qBVtkSZAu01pIHKjR79HvDpQWu4Hw0+jzyLna307Bml4KoypxQ4ZeziF2efzq7+PSeRezsy+XHi3fDyTmL2GT023T4fnjxafpxODkfEWzWLRmvpVQb042mXpmU2/Qwhj5wm+5GDNkjHTmUbWJ8vDppVEGIDsRbnhdZiFdr8WXAhI92mefcLDeAVS+I2IJnJXqdG0e2/BQsYidiNjtNTo+OZ3H/jUB+Kl71BZ+dvjl6w1+9Fq+P+mI2S0Sfn3DePzk6/ZEf4U/HR8cnKJL+0clrdu//Inbc7z8MeWkh51miTY7xzyHOWyD4LpBrhZ8Tn/ybcP8uV+/ffmn0LMOc3V/vD8h/apP2h6RZ0g5KOLOFkmneWlersE9OHdDjfp9A6LjMCH+BXUHoMotBaQcxEpVtoRvVAjNdEGmDo/pLfIbWdWG4ngWplzQjWvJJ3tLnvJZhnSmFg5o1S0s0EKi0C0Srq9MM8jgEu30oIQNFqkPpIFV/x1tnuO3WG6e3sfkdEolZHNLLb66LsTaw1KUBodUClUQlPI6CDM93LTFswJjHa9sS4sP1+AV4jjfg2Q7gJomyYf33ftLr9Xqn4cMvv7A1Klsx1tPn36uH86/FvavqE0tLNB97J7Zq8xMVmvDrIda8iFE5mUi0PvhFyDqgTaEQhFw4JGZIaDUugrTMueoQ1sg2qIJa8/KW+K0iI5XDOZqdHcKHyeSy3b5V/ZC0oIUojSHwbZzkD6lT9LARG9rjbZFxxUMECxQykSK0wwfPbBJgM0o8jiVJ5NllK167Sv1wtRKCCRQj7iCX89SFLpWOFZmkUr/RsPoUeWFfhi2VsvF6NVxx7F6GbUj7rELrfqpt1sJq8cOk22TFNG527KLf3bIbIn7VIuK/lHcw0YDKR50GiDmXKgKDuV54CoUFN9L/enYxHr79eD6dfJ2Ov7w9yHU1P/x0sD5ziMuQ7R5QnHq4hfTD1Z5547kpfW5K1VkNmv2J2SzZ05i2PfTUpfH1oda0hYCEy6w0GAHeCvRrQRuQasEzGf9//epzrXyulX9zrfyVy8fWx2rpo6tjUq8/UBtXcmusvF4bUd6tRpPtuzh/Q9e6CAvTw2oYIA+tpgC1MQVQFnKpLCSlcSmaOgRdOGuC5EkVuUgDHumebEawLFUM3A0gda6wg14vxlBEje1W+nS1mfd4IXteC9ujlZ1gYcdf4/XSUMU7NfB6LcM6jR87/s6yd8jJ+wt6FColTRL0fwW1FA1uTzY1iT0KEs3qR6MCW1sOAKMtfTc2RvVdWMO9W5ej/z5MtF38KFisnPcgNC5CSRuvGP0gPKod1VT8eIxUxbOu9QeBsnXOAbTsKs5PD5l/FGa2XP7X+aRuoXbcLnyQ1mmzhLO31CdbxzP8edU2l4ovuPQNeyj8e/rYf8SFX2Xp2dsxGbmeLeE3KXhGjriwMNEawrrtFPFOmqZBXOvkB4U0+F+bMQm4FVpAKmolhPe80CqR89KEFzCDZGTddVRXbhZu6H1IOo/dmJ5RcqkwNB/UjlQaQswdp6s8kpvx+dy/j2kNCTcww1RW3YvQSqFwPhkrRXRSP9d13hEktAnXfwZ9iOmx7gdbPZNpayXhxB+/tosat9KRMIpsFy4zJG2cWYYBGTLu0Hzfdd/ELIe09yNt3WC+9dnswQvA9vSyOdM99QxzH7EcXarppazQ1k8P3NEBbQawU08KhBg0i/plrDSElpqSanpxaJ1C1+alnU38JKyDT+HJldFTl1SJ9h6owRtkknPQ2LC33+13j6hTJXVz7jO5epYLT33A25fJMFx7yt1U5a4hief34n/pe3HdZOCt6xUZl4rQ5cF9VyXDFduRDNcRSyljBlfs7o6o7IvJ7u/p6/BaTCmyuvkbJDyzm4NdG3wvRtXD70vYp9I3XNZvzxVXMJ819fUdG1xReUmRx0Q/V3fVjqGgvq21a6sYkpQVDVx+Hk/Y/f3/AK9v12k= +api: eJztWVtvG7cS/isDvjQBVhc3jp2q6IMSu4mBnMSQFCCFYagUd6Rls0tuSa5sHcP//WDIvelmOT3uQ1H7RbBEDufyzTcz5B2L0Qojcye1YgM2SaQFVHGupXJgi1kmnQVnuLJc0BoLToNLEMYO05QbUOhutPkG3K6USIxWurDpqgsXDqSFGK1cKIxpF09TfQOFReOFBOHrsm+kS3ThYJZq8U2qBZ2UwU0iU4QbLh19NdcGOBi0uVYWYW50Bh+0kf/VqgtD55WzPENwMsMIpAOeWg250UsZowWRIjfNfuu4KywITb95YTZY1hHaICmaYJpDoWI01nEVhwPCLj0P/3lTHJnZWNOF33QBgitaosjuSs0fLFy9P5+0F9c+v37R7Rl0RuISO7zTlsdz2c3i25ekEznDe4KOb8txGmYIUom0iDEGqYBDivECDZDuUi3QkqKzVe00FjGdo+G0/yJmAzb25gwpoJNGNIuY4wvLBles9a1l1xHLueEZOjT06x2ThKQ/CzQrFjHFM2QD5m5ZxKxIMONscMfcKqdvrTNSLVi0hUKEGbd4ctxBRZGJ4evZqPJ22yfsPmIG/yykwZgNnCnw/pq+CcG1dNSP/SP62Dih5bKEW5ghKjAoUC6Dc3zwvccsOTFHFRP4QtzJZUIrh8qRaJ7nqRTef70/LMm/2zZVz/5A4VjEckPedjJoh8ZoM0JbpO5rbHa5RhVpymcpBvO2XNUYEqR4T4XNlDgiIQtygxaVA63SFcgWaK0lD5Ro9uj3hksLXMH5aPR55F3sbqdhzS4FURUZocIvZxG7PP90dvHpPYvY2ZfLjxfvhpNzFrHJ6Lfp8P3w4tP043ByPiLYrFsyXkupNqYbTb0yCbfJYQx94DbZjRiyRzpyKNvE+Lg+aVRCiA7EW57laYhXa/FlwISPdpFl3Kw2gFUtiNiSpwV6nRtHtvwULGInYjY7nZ8eHc/i/huB/FS86gs+O31z9Ia/ei1eH/XFbDYXfX7Cef/k6PRHfoQ/HR8dn6CY949OXrN7/xex437/YchLCxlP59pkGP8c4rwFgu8CuVb4ee6TfxPu3+Xq/dsvjZ6lmLH76/0B+U9l0v6QNEvaQQlntlAyzVrrKhX2yakCetzvEwgdlynhL7ArCF2kMSjtIEaisi10o1piqnMibXBUfonP0LouDNezIPGSZkRLPslb+pxXMqwzhXBQsWZhiQYClXaBaLU+zSCPQ7DbhxIyUCQ6lA5S9Xe8dYbbbrVxehub32EuMY1DevnNVTHWBla6MCC0WqKSqITHUZDh+a4lhg0Y83htW0J8uB6/AM/xBjzbAdwkUTas/t5Per1e7zT888svbI3KasZ6+vx79XD+tbi3rj6xtETzsXdiqzY/UaEJvx5izYsYlZNzidYHPw9ZB7QpFIKQC4fEDAmtxkWQFBlXHcIa2QZlUCte3hK/VWSkcrhAs7ND+DCZXLbbt7Ifkha0EIUxBL6Nk/whVYoeNmJDe7zNU654iGCOQs6lCO3wwTObBNiMEo9jSRJ5etmK165SP6xXQjCBYsQdZHKRuNCl0rEilVTqNxpWnyIv7MuwpVQ2Xq+GNcfuZdiGtM9KtO6n2mYt1IsfJt0mK6Zxs2MX/e6W3RDxqxYR/6W8g4kGVD7qNEAsuFQRGMz00lMoLLmR/tezi/Hw7cfz6eTrdPzl7UGuq/jhp4P1mUNchGz3gOLUwy2lH672zBvPTelzU6rOKtDsT8xmyZ7GtO2hpy6Nrw+1pi0EzLlMC4MR4K1Avxa0AamWPJXx/9evPtfK51r5N9fKX7l8bH0slz66Os6r9QdqYy23wsrrtRHlXT2abN/F+Ru61kVYmB7qYYA8VE8BamMKoCzkUlmYF8YlaKoQdOGsCZInVeQiCXike7IZwbJQMXA3gMS53A56vRhDETW2W+rT1WbR47nseS1sj1Z2goUdf43XS0IV71TA67UM6zR+7Pg7y94hJ+8v6FGolDRJ0GcNtQQNbk82FYk9ChLN6kejAltbDgCjLX03NkbVXVjDvVuXo/8+TLRd/ChY1M57EBoXoaSNa0Y/CI9yRzkVPx4jZfGsav1BoGydcwAtu4rz00PmH4WZLZf/dT6pWqgdtwsfpHXarODsLfXJ1vEUf67b5kLxJZe+YQ+Ff08f+4+48CstPXs7JiPXsyX8JgVPyREXFiZaQ1i3nSLeSdMkiGud/KCQBv9rMyYBt0QLSEWthPCeF1rN5aIw4QXMIBlZdR3llZuFG3ofks5jN6ZnlEwqDM0HtSOlhhBzx+kqj+SmfLHw72Naw5wbmGEiy+5FaKVQOJ+MpSJ6Xj3Xdd4RJLQJ138GfYjpse4HWz6TaWsl4cQfv7aLGrfCkTCKbBcuUyRtnFmFARlS7tB833XfxKyGtPcjbd1gvvXZ7MELwPb0sjnTPfUMcx+xDF2i6aUs19ZPD9zRAW0GsFNPCoQYNMvqZawwhJaKkip6cWidQtfmpZ1N/CSsg0/hyZXRU5dUc+09UIE3yCTnoLFhb7/b7x5Rp0rqZtxncvksF576gLcvk2G49pS7qcpdQxLPz8X/zufiqsfAW9fLUy4Vgctj+67MhSu2IxeuI5ZQwgyu2N0dMdkXk97f09fhsZgypL74G8x5ajfnujb2XozKd9+XsE+lb7iqnp5LqmA+aarbOza4ouqSII+Jfa7uyh1DQW1ba9dWLSQpNQtcfh5P2P39/wDeytdN sidebar_class_name: "post api-method" info_path: network/horizon/api-reference/resources/horizon custom_edit_url: null @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; -This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. +This endpoint submits transactions to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. ## Request diff --git a/openapi/horizon/bundled.yml b/openapi/horizon/bundled.yml index df97fe92c..d48fc5040 100644 --- a/openapi/horizon/bundled.yml +++ b/openapi/horizon/bundled.yml @@ -1166,7 +1166,7 @@ paths: /transactions_async: post: summary: Submit a Transaction Asynchronously - description: This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. + description: This endpoint submits transactions to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon. operationId: SubmitAsyncTransaction tags: - Transactions diff --git a/openapi/horizon/components/endpoints/transactions.yml b/openapi/horizon/components/endpoints/transactions.yml index 9f1911f33..e2fd0272d 100644 --- a/openapi/horizon/components/endpoints/transactions.yml +++ b/openapi/horizon/components/endpoints/transactions.yml @@ -120,7 +120,7 @@ paths: /transactions_async: post: summary: Submit a Transaction Asynchronously - description: "This endpoint submits a transaction to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon." + description: "This endpoint submits transactions to the Stellar network asynchronously. It is designed to allow users to submit transactions without blocking them while waiting for a response from Horizon. At the same time, it also provides clear response status codes from stellar-core to help understand the status of the submitted transaction. You can then use Horizon's [GET transaction endpoint](./retrieve-a-transaction.api.mdx) to wait for the transaction to be included in a ledger and ingested by Horizon." operationId: SubmitAsyncTransaction tags: - Transactions