From 5d31c2fbeab8d7942e92a937514739c25f32e906 Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Wed, 25 Jan 2023 13:15:51 +0000 Subject: [PATCH] Clarify encoding of hash in the api docs (#282) --- api/methods/getLatestLedger.mdx | 2 +- api/methods/getTransactionStatus.mdx | 4 ++-- api/methods/requestAirdrop.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/methods/getLatestLedger.mdx b/api/methods/getLatestLedger.mdx index 636f391e..9c980652 100644 --- a/api/methods/getLatestLedger.mdx +++ b/api/methods/getLatestLedger.mdx @@ -15,6 +15,6 @@ For finding out the current latest known ledger of this node. This is a subset o ## Returns - `` - - `id`: `` - hash of the latest ledger + - `id`: `` - hash of the latest ledger as a hex-encoded string - `protocolVersion`: `` - `sequence`: `` diff --git a/api/methods/getTransactionStatus.mdx b/api/methods/getTransactionStatus.mdx index bef1e68a..7e0e7950 100644 --- a/api/methods/getTransactionStatus.mdx +++ b/api/methods/getTransactionStatus.mdx @@ -13,7 +13,7 @@ Clients will poll this to tell when the transaction has been completed. ## Parameters -- `` - transaction hash to query +- `` - transaction hash to query, as a hex-encoded string ## Returns @@ -104,4 +104,4 @@ Clients will poll this to tell when the transaction has been completed. } } } -``` \ No newline at end of file +``` diff --git a/api/methods/requestAirdrop.mdx b/api/methods/requestAirdrop.mdx index a9c718c6..b833f278 100644 --- a/api/methods/requestAirdrop.mdx +++ b/api/methods/requestAirdrop.mdx @@ -19,7 +19,7 @@ Maybe we could replace this with a 'friendbotUrl' field in `getNetwork` method? ## Returns - `` - - `transactionId`: `` - Transaction id of the transfer. + - `transactionId`: `` - Transaction id of the transfer as a hex-encoded string. ## Errors