From 7cc27e7bd15ba3dc54c733fc646bfe17f19a0a27 Mon Sep 17 00:00:00 2001 From: Tyera Eulberg Date: Mon, 27 Aug 2018 17:34:32 -0600 Subject: [PATCH] Doc requestAirdrop rpc method --- doc/json-rpc.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/json-rpc.md b/doc/json-rpc.md index 15baaec34e..c1b51d2469 100644 --- a/doc/json-rpc.md +++ b/doc/json-rpc.md @@ -19,6 +19,7 @@ Methods * [getBalance](#getbalance) * [getLastId](#getlastid) * [getTransactionCount](#gettransactioncount) +* [requestAirdrop](#requestairdrop) * [sendTransaction](#sendtransaction) Request Formatting @@ -135,6 +136,27 @@ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "m --- +### requestAirdrop +Requests an airdrop of tokens to a Pubkey + +##### Parameters: +* `string` - Pubkey of account to receive tokens, as base-58 encoded string +* `integer` - token quantity, as a signed 64-bit integer + +##### Results: +* `string` - Transaction Signature of airdrop, as base-58 encoded string + +##### Example: +```bash +// Request +curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1, "method":"requestAirdrop", "params":["83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri", 50]}' http://localhost:8899 + +// Result +{"jsonrpc":"2.0","result":"5VERv8NMvzbJMEkV8xnrLkEaWRtSz9CosKDYjCJjBRnbJLgp8uirBgmQpjKhoR4tjF3ZpRzrFmBV6UjKdiSZkQUW","id":1} +``` + +--- + ### sendTransaction Creates new transaction