From 35baf89622ba00e862f8b8aa4680614f5b01994d Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Fri, 27 Jan 2023 17:03:03 +0000 Subject: [PATCH 1/6] Proposed api revisions --- api/methods/getAccount.mdx | 47 ------------------- api/methods/getHealth.mdx | 38 --------------- api/methods/getLatestLedger.mdx | 7 +-- ...etLedgerEntry.mdx => getLedgerEntries.mdx} | 47 ++++++++++++------- api/methods/getLedgers.mdx | 21 +++++++++ api/methods/getNetwork.mdx | 3 +- api/methods/getTransactionStatus.mdx | 4 +- api/methods/requestAirdrop.mdx | 26 ---------- api/methods/sendTransaction.mdx | 6 ++- api/methods/simulateTransaction.mdx | 8 ++-- 10 files changed, 69 insertions(+), 138 deletions(-) delete mode 100644 api/methods/getAccount.mdx delete mode 100644 api/methods/getHealth.mdx rename api/methods/{getLedgerEntry.mdx => getLedgerEntries.mdx} (77%) create mode 100644 api/methods/getLedgers.mdx delete mode 100644 api/methods/requestAirdrop.mdx diff --git a/api/methods/getAccount.mdx b/api/methods/getAccount.mdx deleted file mode 100644 index 2bf84831..00000000 --- a/api/methods/getAccount.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -Fetch a minimal set of current info about a Stellar account. - -Needed to get the current sequence number, and balance for the account so you can build a successful transaction. - -## Parameters - -- `
` - Address of the account to lookup - -## Returns - -- `` - - `id`: `
` - - `sequence`: `` - Current sequence number of the account - - TODO: Balances for the account (same format as in horizon) should be displayed - - TODO: signers/flags/thresholds/etc? - -## Examples - -### Request - -```json -{ - "jsonrpc": "2.0", - "id": 8675309, - "method": "getAccount", - "params": { - "address": "GAO2X2IGYZQEN7RJCA25MB2DM7AQA354AL77DJ2WL46Z6V5XRWVWV44Z" - } -} -``` - -### Response - -```json -{ - "jsonrpc": "2.0", - "id": 8675309, - "result": { - "id": "GAO2X2IGYZQEN7RJCA25MB2DM7AQA354AL77DJ2WL46Z6V5XRWVWV44Z", - "sequence": "703867830403072" - } -} -``` diff --git a/api/methods/getHealth.mdx b/api/methods/getHealth.mdx deleted file mode 100644 index 06a958d2..00000000 --- a/api/methods/getHealth.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 2 ---- - -General node health check. - -## Parameters - -- None - -## Returns - -- `` - - `status`: "healthy" - -## Examples - -### Request - -```json -{ - "jsonrpc": "2.0", - "id": 8675309, - "method": "getHealth" -} -``` - -### Response - -```json -{ - "jsonrpc": "2.0", - "id": 8675309, - "result": { - "status": "healthy" - } -} -``` diff --git a/api/methods/getLatestLedger.mdx b/api/methods/getLatestLedger.mdx index 9c980652..5be01631 100644 --- a/api/methods/getLatestLedger.mdx +++ b/api/methods/getLatestLedger.mdx @@ -15,6 +15,7 @@ For finding out the current latest known ledger of this node. This is a subset o ## Returns - `` - - `id`: `` - hash of the latest ledger as a hex-encoded string - - `protocolVersion`: `` - - `sequence`: `` + - `id`: `` - Hash of the latest ledger as a hex-encoded string + - `protocolVersion`: `` - Protocol version + - `sequence`: `` - Sequence number of the latest ledger + - `closeTime`: `` - Timestamp that the latest ledger was completed diff --git a/api/methods/getLedgerEntry.mdx b/api/methods/getLedgerEntries.mdx similarity index 77% rename from api/methods/getLedgerEntry.mdx rename to api/methods/getLedgerEntries.mdx index 37c741cc..096bbcde 100644 --- a/api/methods/getLedgerEntry.mdx +++ b/api/methods/getLedgerEntries.mdx @@ -8,13 +8,14 @@ To fetch contract wasm byte-code, use the ContractCode ledger entry key. ## Parameters -- `key`: `` - The key of the ledger entry you wish to retrieve (serialized in a base64 string) +- `keys`: `[]` - Array of keys for ledger entries you wish to retrieve (each serialized in a base64 string) ## Return - `` - - `xdr`: `` - The current value of the given ledger entry (serialized in a base64 string) - - `lastModifiedLedgerSeq`: `` - The ledger number of the last time this entry was updated (optional) + - `entries`: `` - Array of ledger entry results. If a key was not found, it will be `null` in the array. + - `xdr`: `` - The current value of the given ledger entry (each serialized in a base64 string) + - `lastModifiedLedgerSeq`: `` - The ledger number of the last time this entry was updated (optional) - `latestLedger`: `` - The current latest ledger observed by the node when this response was generated. ## Examples @@ -25,9 +26,9 @@ To fetch contract wasm byte-code, use the ContractCode ledger entry key. { "jsonrpc": "2.0", "id": 8675309, - "method": "getLedgerEntry", + "method": "getLedgerEntries", "params": { - "key": "AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAABQAAAAdDT1VOVEVSAA==" + "keys": ["AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAABQAAAAdDT1VOVEVSAA=="] } } ``` @@ -39,8 +40,12 @@ To fetch contract wasm byte-code, use the ContractCode ledger entry key. "jsonrpc": "2.0", "id": 8675309, "result": { - "xdr": "AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAABQAAAAdDT1VOVEVSAAAAAAEAAAAD", - "lastModifiedLedgerSeq": "164986", + "entries": [ + { + "xdr": "AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAABQAAAAdDT1VOVEVSAAAAAAEAAAAD", + "lastModifiedLedgerSeq": "164986" + } + ], "latestLedger": "179436" } } @@ -134,15 +139,15 @@ print(get_ledger_key_contract_code( # OUTPUT: AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAAAwAAAAM= ``` -We then take our output from this function, and use it as the `key` parameter in our call to the `getLedgerEntry` method. +We then take our output from this function, and use it as the `key` parameter in our call to the `getLedgerEntries` method. ```json { "jsonrpc": "2.0", "id": 8675309, - "method": "getLedgerEntry", + "method": "getLedgerEntries", "params": { - "key": "AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAAAwAAAAM=" + "keys": ["AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAAAwAAAAM="] } } ``` @@ -154,8 +159,12 @@ And the response we get contains the `LedgerEntryData` that can be used to find "jsonrpc": "2.0", "id": 8675309, "result": { - "xdr": "AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAAAwAAAAMAAAAEAAAAAQAAAAcAAAAA1CpZRz0BSN27PmqtsmBhv+AAJJwHgmrvJNPrHRAl9l8=", - "lastModifiedLedgerSeq": "164303", + "entries": [ + { + "xdr": "AAAABhv6ziOnWcVRdGMZjtFKSWnLSndMp9JPVLLXxQqAvKqJAAAAAwAAAAMAAAAEAAAAAQAAAAcAAAAA1CpZRz0BSN27PmqtsmBhv+AAJJwHgmrvJNPrHRAl9l8=", + "lastModifiedLedgerSeq": "164303" + } + ], "latestLedger": "246819" } } @@ -191,9 +200,9 @@ Now, finally we have a `LedgerKey` that correspond to the WASM byte-code that ha { "jsonrpc": "2.0", "id": 8675309, - "method": "getLedgerEntry", + "method": "getLedgerEntries", "params": { - "key": "AAAAB9QqWUc9AUjduz5qrbJgYb/gACScB4Jq7yTT6x0QJfZf" + "keys": ["AAAAB9QqWUc9AUjduz5qrbJgYb/gACScB4Jq7yTT6x0QJfZf"] } } ``` @@ -205,12 +214,16 @@ And the response we get contains (even more) `LedgerEntryData` that we can decod "jsonrpc": "2.0", "id": 8675309, "result": { - "xdr": "AAAABwAAAADUKllHPQFI3bs+aq2yYGG/4AAknAeCau8k0+sdECX2XwAAAakAYXNtAQAAAAEXBWABfgF+YAJ+fgF+YAABfmABfwBgAAACEwMBbAEwAAABbAExAAABbAFfAAEDBgUCAwQEBAUDAQAQBhkDfwFBgIDAAAt/AEGAgMAAC38AQYCAwAALBzUFBm1lbW9yeQIACWluY3JlbWVudAADAV8ABwpfX2RhdGFfZW5kAwELX19oZWFwX2Jhc2UDAgrAAQWhAQMBfwF+AX8jgICAgABBEGsiACSAgICAAAJAAkBC2YP9sqDNAxCAgICAAEIVUg0AAkBC2YP9sqDNAxCBgICAACIBQg+DQgFSDQAgAUIEiKchAgwCCyAAQQhqEISAgIAAAAtBACECCwJAIAJBAWoiAg0AEIWAgIAAAAtC2YP9sqDNAyACrUIEhkIBhCIBEIKAgIAAGiAAQRBqJICAgIAAIAELCQAQhoCAgAAACwkAEIaAgIAAAAsEAAAACwIACwAeEWNvbnRyYWN0ZW52bWV0YXYwAAAAAAAAAAAAAAAbAC8OY29udHJhY3RzcGVjdjAAAAAAAAAACWluY3JlbWVudAAAAAAAAAAAAAABAAAAAQAAAA==", - "lastModifiedLedgerSeq": "164302", + "entries": [ + { + "xdr": "AAAABwAAAADUKllHPQFI3bs+aq2yYGG/4AAknAeCau8k0+sdECX2XwAAAakAYXNtAQAAAAEXBWABfgF+YAJ+fgF+YAABfmABfwBgAAACEwMBbAEwAAABbAExAAABbAFfAAEDBgUCAwQEBAUDAQAQBhkDfwFBgIDAAAt/AEGAgMAAC38AQYCAwAALBzUFBm1lbW9yeQIACWluY3JlbWVudAADAV8ABwpfX2RhdGFfZW5kAwELX19oZWFwX2Jhc2UDAgrAAQWhAQMBfwF+AX8jgICAgABBEGsiACSAgICAAAJAAkBC2YP9sqDNAxCAgICAAEIVUg0AAkBC2YP9sqDNAxCBgICAACIBQg+DQgFSDQAgAUIEiKchAgwCCyAAQQhqEISAgIAAAAtBACECCwJAIAJBAWoiAg0AEIWAgIAAAAtC2YP9sqDNAyACrUIEhkIBhCIBEIKAgIAAGiAAQRBqJICAgIAAIAELCQAQhoCAgAAACwkAEIaAgIAAAAsEAAAACwIACwAeEWNvbnRyYWN0ZW52bWV0YXYwAAAAAAAAAAAAAAAbAC8OY29udHJhY3RzcGVjdjAAAAAAAAAACWluY3JlbWVudAAAAAAAAAAAAAABAAAAAQAAAA==", + "lastModifiedLedgerSeq": "164302" + } + ], "latestLedger": "246883" } } ``` [`increment` example contract]: -["View XDR" page of the Stellar Laboratory]: \ No newline at end of file +["View XDR" page of the Stellar Laboratory]: diff --git a/api/methods/getLedgers.mdx b/api/methods/getLedgers.mdx new file mode 100644 index 00000000..27c3749a --- /dev/null +++ b/api/methods/getLedgers.mdx @@ -0,0 +1,21 @@ +--- +sidebar_position: 7 +--- + +:::note +The `getLedgers` method is proposed but not yet implemented. +::: + + +Clients can request a list of ledgers. Soroban-RPC will support querying within a maximum 24 hours of recent ledgers. + +## Parameters + +- `startLedger`: `` - Stringified ledger sequence number to fetch events after (inclusive). +- `endLedger`: `` - Stringified ledger sequence number to fetch events before (inclusive). endLedger must be less than or equal to startLedger + 720 (about 1 hour of ledgers). + +## Returns + +- `` + - `ledgers`: `` + - TODO: Figure out the object returned here. diff --git a/api/methods/getNetwork.mdx b/api/methods/getNetwork.mdx index 5e997243..b64e9284 100644 --- a/api/methods/getNetwork.mdx +++ b/api/methods/getNetwork.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 6 --- :::note @@ -15,5 +15,6 @@ General info about the currently configured network. ## Returns - `` + - `friendbotUrl`: `` (optional) - The URL of this network's "friendbot" faucet - `passphrase`: `` - Network passphrase configured - `protocolVersion`: `` - Protocol version of the latest ledger diff --git a/api/methods/getTransactionStatus.mdx b/api/methods/getTransactionStatus.mdx index 7e0e7950..7f50796c 100644 --- a/api/methods/getTransactionStatus.mdx +++ b/api/methods/getTransactionStatus.mdx @@ -33,6 +33,7 @@ Clients will poll this to tell when the transaction has been completed. - `code`: `` - Short unique string representing the type of error - `message`: `` - Human friendly summary of the error - `data`: `` - (optional) More data related to the error if available + - `eta`: `` - (optional) A rough estimate of the soonest time this transaction could be included in a ledger. Only present if the transaction is "pending". ## Examples @@ -59,7 +60,8 @@ Clients will poll this to tell when the transaction has been completed. "id": 8675309, "result": { "id": "d70916f8b8aa55c13d5974a38e32a3efe440ef6870c0f0a07075d1c128d23698", - "status": "pending" + "status": "pending", + "eta": "2023-01-27T16:54:52Z" } } ``` diff --git a/api/methods/requestAirdrop.mdx b/api/methods/requestAirdrop.mdx deleted file mode 100644 index b833f278..00000000 --- a/api/methods/requestAirdrop.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar_position: 9 ---- - -:::note -The `requestAirdrop` method is still a work-in-progress. -::: - -Used outside pubnet to request some lumens from friendbot for a particular account. - -:::note -Maybe we could replace this with a 'friendbotUrl' field in `getNetwork` method? -::: - -## Parameters - -- `` - Account pubkey to fund - -## Returns - -- `` - - `transactionId`: `` - Transaction id of the transfer as a hex-encoded string. - -## Errors - -- If this is pubnet (or friendbot is otherwise unavailable). diff --git a/api/methods/sendTransaction.mdx b/api/methods/sendTransaction.mdx index cf968e4a..630ffe4d 100644 --- a/api/methods/sendTransaction.mdx +++ b/api/methods/sendTransaction.mdx @@ -24,6 +24,7 @@ This supports all transactions, not only smart contract-related transactions. - `success` - `error` - `error`: `` - (optional) If the transaction was rejected immediately, this will be an error object. See [`getTransactionStatus`](getTransactionStatus) for format. + - `eta`: `` - A rough estimate of the soonest time this transaction could be included in a ledger. ## Possible Errors @@ -55,9 +56,10 @@ The following example request uses a transaction to invoke the `increment` metho "result": { "id": "d70916f8b8aa55c13d5974a38e32a3efe440ef6870c0f0a07075d1c128d23698", "status": "pending", - "error": null + "error": null, + "eta": "2023-01-27T16:54:52Z" } } ``` -[`increment` example contract]: \ No newline at end of file +[`increment` example contract]: diff --git a/api/methods/simulateTransaction.mdx b/api/methods/simulateTransaction.mdx index 38d73f4c..c5bcdc86 100644 --- a/api/methods/simulateTransaction.mdx +++ b/api/methods/simulateTransaction.mdx @@ -14,7 +14,7 @@ Submit a trial contract invocation to get back return values, expected ledger fo - `cost`: `` - Information about the fees expected, instructions used, etc. - `cpuInsns`: `` - Stringified-number of the total cpu instructions consumed by this transaction - `memBytes`: `` - Stringified-number of the total memory bytes allocated by this transaction - - `footprint`: `` -Array of ledger keys expected to be written by this transaction. (serialized in base64) + - `footprints`: `` - Array of xdr.LedgerFootprints (one per operation) expected to be read/written by this transaction. (each serialized in base64) - `results`: `` - If error is present then results will not be in the response - `xdr`: `` - (optional) Only present on success. xdr-encoded return value of the contract call - `latestLedger`: `` - Stringified-number of the current latest ledger observed by the node when this response was generated. @@ -49,7 +49,9 @@ The example transaction below invokes the `increment` function from the [`increm "xdr": "AAAAAQAAAAY=" } ], - "footprint": "AAAAAgAAAAYb+s4jp1nFUXRjGY7RSklpy0p3TKfST1Sy18UKgLyqiQAAAAMAAAADAAAAB9QqWUc9AUjduz5qrbJgYb/gACScB4Jq7yTT6x0QJfZfAAAAAQAAAAYb+s4jp1nFUXRjGY7RSklpy0p3TKfST1Sy18UKgLyqiQAAAAUAAAAHQ09VTlRFUgA=", + "footprints": [ + "AAAAAgAAAAYb+s4jp1nFUXRjGY7RSklpy0p3TKfST1Sy18UKgLyqiQAAAAMAAAADAAAAB9QqWUc9AUjduz5qrbJgYb/gACScB4Jq7yTT6x0QJfZfAAAAAQAAAAYb+s4jp1nFUXRjGY7RSklpy0p3TKfST1Sy18UKgLyqiQAAAAUAAAAHQ09VTlRFUgA=" + ], "cost": { "cpuInsns": "163642", "memBytes": "1506" @@ -59,4 +61,4 @@ The example transaction below invokes the `increment` function from the [`increm } ``` -[`increment` example contract]: \ No newline at end of file +[`increment` example contract]: From 612f6dd28a6a7165b599c28578928811dd2f1d80 Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Mon, 30 Jan 2023 16:57:00 +0000 Subject: [PATCH 2/6] Remove getEvents endLedger --- api/methods/getEvents.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/api/methods/getEvents.mdx b/api/methods/getEvents.mdx index 3b09c6d4..b0050e26 100644 --- a/api/methods/getEvents.mdx +++ b/api/methods/getEvents.mdx @@ -12,8 +12,7 @@ By default soroban-rpc retains the most recent 24 hours of events. ## Parameters -- `startLedger`: `` - Stringified ledger sequence number to fetch events after (inclusive). -- `endLedger`: `` - Stringified ledger sequence number to fetch events before (inclusive). endLedger must be less than or equal to startLedger + 4320 (about 6 hours of ledgers). +- `startLedger`: `` - Stringified ledger sequence number to fetch events after (inclusive). If `startLedger` is greater than the latest ledger seen by this node, this method will return an error. - `filters`: `` - List of filters for the returned events. Events matching any of the filters are included. To match a filter, an event must match both a contractId and a topic. Maximum 5 filters are allowed per request. - `type`: `<"system"|"contract">` - (optional) Filter to only system or only contract type events. If omitted, return all. - `contractIds`: `` - (optional) List of contract ids to query for events. If omitted, return events for all contracts. Maximum 5 contract IDs are allowed per request. @@ -68,7 +67,6 @@ The examples below only returns two transfer events that took place to/from the "method": "getEvents", "params": { "startLedger": "227000", - "endLedger": "230200", "filters": [ { "type": "contract", From 8c9fb964a59cbc3a630c22b93dd04bd22483d81f Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Mon, 30 Jan 2023 18:08:36 +0000 Subject: [PATCH 3/6] remove endLedger from getLedgers --- api/methods/getLedgers.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/methods/getLedgers.mdx b/api/methods/getLedgers.mdx index 27c3749a..fd0d5812 100644 --- a/api/methods/getLedgers.mdx +++ b/api/methods/getLedgers.mdx @@ -11,8 +11,8 @@ Clients can request a list of ledgers. Soroban-RPC will support querying within ## Parameters -- `startLedger`: `` - Stringified ledger sequence number to fetch events after (inclusive). -- `endLedger`: `` - Stringified ledger sequence number to fetch events before (inclusive). endLedger must be less than or equal to startLedger + 720 (about 1 hour of ledgers). +- `startLedger`: `` - Stringified ledger sequence number to fetch ledgers after (inclusive). If `startLedger` is greater than the latest ledger seen by this node, this method will return an error. +- `pagination`: `` - See "[Pagination](../pagination)" ## Returns From b13fde5cd201a3df9f3ed4a3d54e23d27cd22455 Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Tue, 31 Jan 2023 14:00:43 +0000 Subject: [PATCH 4/6] Error if startLedger is too early --- api/methods/getEvents.mdx | 2 +- api/methods/getLedgers.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api/methods/getEvents.mdx b/api/methods/getEvents.mdx index b0050e26..bfa85571 100644 --- a/api/methods/getEvents.mdx +++ b/api/methods/getEvents.mdx @@ -12,7 +12,7 @@ By default soroban-rpc retains the most recent 24 hours of events. ## Parameters -- `startLedger`: `` - Stringified ledger sequence number to fetch events after (inclusive). If `startLedger` is greater than the latest ledger seen by this node, this method will return an error. +- `startLedger`: `` - Stringified ledger sequence number to fetch events after (inclusive). This method will return an error if `startLedger` is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node. - `filters`: `` - List of filters for the returned events. Events matching any of the filters are included. To match a filter, an event must match both a contractId and a topic. Maximum 5 filters are allowed per request. - `type`: `<"system"|"contract">` - (optional) Filter to only system or only contract type events. If omitted, return all. - `contractIds`: `` - (optional) List of contract ids to query for events. If omitted, return events for all contracts. Maximum 5 contract IDs are allowed per request. diff --git a/api/methods/getLedgers.mdx b/api/methods/getLedgers.mdx index fd0d5812..effe5eac 100644 --- a/api/methods/getLedgers.mdx +++ b/api/methods/getLedgers.mdx @@ -11,7 +11,7 @@ Clients can request a list of ledgers. Soroban-RPC will support querying within ## Parameters -- `startLedger`: `` - Stringified ledger sequence number to fetch ledgers after (inclusive). If `startLedger` is greater than the latest ledger seen by this node, this method will return an error. +- `startLedger`: `` - Stringified ledger sequence number to fetch ledgers after (inclusive). This method will return an error if `startLedger` is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node. - `pagination`: `` - See "[Pagination](../pagination)" ## Returns From 4b4b1645763edbde9559a2b65a857239dc72bb9c Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Tue, 31 Jan 2023 14:00:58 +0000 Subject: [PATCH 5/6] Bring back getHealth --- api/methods/getHealth.mdx | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 api/methods/getHealth.mdx diff --git a/api/methods/getHealth.mdx b/api/methods/getHealth.mdx new file mode 100644 index 00000000..06a958d2 --- /dev/null +++ b/api/methods/getHealth.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 2 +--- + +General node health check. + +## Parameters + +- None + +## Returns + +- `` + - `status`: "healthy" + +## Examples + +### Request + +```json +{ + "jsonrpc": "2.0", + "id": 8675309, + "method": "getHealth" +} +``` + +### Response + +```json +{ + "jsonrpc": "2.0", + "id": 8675309, + "result": { + "status": "healthy" + } +} +``` From d4ddb1945e8c86817192bb5977bcae09c6d4b9aa Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Wed, 1 Feb 2023 17:44:17 +0000 Subject: [PATCH 6/6] remove getLedgers method --- api/methods/getLedgers.mdx | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 api/methods/getLedgers.mdx diff --git a/api/methods/getLedgers.mdx b/api/methods/getLedgers.mdx deleted file mode 100644 index effe5eac..00000000 --- a/api/methods/getLedgers.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -sidebar_position: 7 ---- - -:::note -The `getLedgers` method is proposed but not yet implemented. -::: - - -Clients can request a list of ledgers. Soroban-RPC will support querying within a maximum 24 hours of recent ledgers. - -## Parameters - -- `startLedger`: `` - Stringified ledger sequence number to fetch ledgers after (inclusive). This method will return an error if `startLedger` is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node. -- `pagination`: `` - See "[Pagination](../pagination)" - -## Returns - -- `` - - `ledgers`: `` - - TODO: Figure out the object returned here.