Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Commit

Permalink
Update in JSON-RPC info
Browse files Browse the repository at this point in the history
  • Loading branch information
Jane Wang authored and Jane Wang committed Feb 15, 2024
1 parent b4d6666 commit cc54eba
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions api/json-rpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ To interact with soroban-rpc from inside a JavaScript application, use the [Java

When XDR is passed as a parameter or returned, it is always a string encoded using standard base64.

:::info

Please note that parameter structure must contain named parameters as a by-name
object, and not as positional arguments as a by-position array. Positional
arguments as a by-position array will be deprecated in future RPC releases.

:::

## Open-RPC Specification

Soroban-RPC provides an [OpenRPC] specification document that can be used to mock, build, and/or validate both server and client software implementations. This document is used to generate all of our [methods] documentation pages. You can view the full [specification document here]. Additionally, you can experiment with this specificaiton document in the [OpenRPC Playground].
Expand Down
2 changes: 1 addition & 1 deletion openrpc/src/contentDescriptors/Transaction.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"UnsignedTransaction": {
"name": "transaction",
"summary": "transaction to be simulated",
"description": "In order for the RPC server to successfully simulate a Stellar transaction, the provided transaction must contain only a single operation of the type `invokeHostFunction`. Please note that parameter structure within the request must contain named parameters as a by-name object, and not as positional arguments as a by-position array.",
"description": "In order for the RPC server to successfully simulate a Stellar transaction, the provided transaction must contain only a single operation of the type `invokeHostFunction`.",
"required": true,
"schema": {
"$ref": "#/components/schemas/Transaction"
Expand Down

0 comments on commit cc54eba

Please sign in to comment.