Skip to content

Commit d11a9db

Browse files
John Whittongitbook-bot
John Whitton
authored andcommitted
GitBook: [master] 35 pages modified
1 parent 66e929b commit d11a9db

35 files changed

+119
-137
lines changed

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@
22

33
Harmony Developers guide
44

5-

SUMMARY.md

-1
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,4 @@
6464
* [Harmony Wallets](tools-for-users/math-wallet/README.md)
6565
* [Math Wallet](tools-for-users/math-wallet/setup.md)
6666
* [Ledger](tools-for-users/math-wallet/ledger.md)
67-
* [Untitled](tools-for-users/untitled.md)
6867

api-developers-guide/methods/account-methods/getexploreraddress.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: GetExplorerAddress returns the transaction history of an address
66

77
Returns information about the transaction history of a given address with a configurable format.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `id` - `String` - The address to get the balance of.
1212
2. `offset` - `Integer` - _\(Optional\)_ Number of address transactions per page.
@@ -17,7 +17,7 @@ Returns information about the transaction history of a given address with a conf
1717
3. "RECEIVED" - Show only transactions this address received
1818
4. "SENT" - Show only transaction this address sent
1919

20-
#### Result
20+
## Result
2121

2222
* `id` - `String` - Account address.
2323
* `balance` - `Integer` - Account balance.
@@ -31,7 +31,7 @@ Returns information about the transaction history of a given address with a conf
3131
* `data` - `String` - Extra data.
3232
* `type` - `String` - Either "SENT" or "RECEIVED".
3333

34-
#### Sample Curl Request
34+
## Sample Curl Request
3535

3636
| Param | Value |
3737
| :--- | :--- |
@@ -44,7 +44,7 @@ Returns information about the transaction history of a given address with a conf
4444
curl -H "Content-Type:application/json" -X GET "e0.b.hmny.io:5000/address?id=one18t4yj4fuutj83uwqckkvxp9gfa0568uc48ggj7&tx_view=ALL&offset=5&page=2"
4545
```
4646

47-
#### Sample Curl Response
47+
## Sample Curl Response
4848

4949
```javascript
5050
{

api-developers-guide/methods/account-methods/hmy_getbalance.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ description: GetBalance
66

77
Get the balance of an address at a given block.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - The address to get the balance of.
1212
2. `String` - Block to get query for balance; "latest" gives latest block.
1313

14-
#### Returns
14+
## Returns
1515

1616
* `String` - The current balance for the given address in ATTO.
1717

18-
#### Sample Curl Request
18+
## Sample Curl Request
1919

2020
```bash
2121
curl -d '{

api-developers-guide/methods/account-methods/hmy_gettransactioncount.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ description: GetTransactionCount
66

77
Given an account address, returns the number of transactions the account has made.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - Account address
1212
2. `String` - Block number to query for transaction count. Usually `latest`, which uses the most recent block.
1313

14-
#### Returns
14+
## Returns
1515

1616
* `String` - Number of transactions the account has made.
1717

18-
#### Sample Curl Request
18+
## Sample Curl Request
1919

2020
```bash
2121
curl -d '{
@@ -29,7 +29,7 @@ curl -d '{
2929
}' -H "Content-Type:application/json" -X POST "http://s0.b.hmny.io:9500"
3030
```
3131

32-
#### Sample Curl Response
32+
## Sample Curl Response
3333

3434
```javascript
3535
{

api-developers-guide/methods/blockchain-related-methods/getexplorernodecount.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ description: GetExplorerNode-Count returns the number of explorer nodes in the n
66

77
Returns number of explorer nodes in the network.
88

9-
#### Returns
9+
## Returns
1010

1111
* `Integer` - Number of explorer nodes in the network.
1212

13-
#### Sample Curl Request
13+
## Sample Curl Request
1414

1515
```bash
1616
curl -H "Content-Type:application/json" -X GET "e1.b.hmny.io:5000/node-count"
1717
```
1818

19-
#### Sample Curl Response
19+
## Sample Curl Response
2020

2121
```javascript
2222
2

api-developers-guide/methods/blockchain-related-methods/getexplorershard.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,26 @@ description: GetExplorerShard returns explorer nodes hashes in the network.
66

77
Returns explorer node hashes of a given shard.
88

9-
#### Parameters
9+
## Parameters
1010

1111
{% hint style="danger" %}
1212
Currently, `id` does not change which shard is queried; only the explorer endpoint \(`e0` or `e1`\) determines which shard is queried. Thus, `id` is optional.
1313
{% endhint %}
1414

1515
* `id` - `Integer` - _\(Optional\)_ Shard ID to query.
1616

17-
#### Returns
17+
## Returns
1818

1919
* `nodes` - `Array`
2020
* `id` - `String` - Explorer node hash.
2121

22-
#### Sample Curl Request
22+
## Sample Curl Request
2323

2424
```bash
2525
curl -H "Content-Type:application/json" -X GET "e1.b.hmny.io:5000/shard"
2626
```
2727

28-
#### Sample Curl Response
28+
## Sample Curl Response
2929

3030
```javascript
3131
{

api-developers-guide/methods/blockchain-related-methods/getexplorertransaction.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ description: >-
88

99
Returns a list of network of a particular shard and epoch. To get current list of validators you should pass epoch from current block.
1010

11-
#### Parameters
11+
## Parameters
1212

1313
* `shard_id` - `Integer` - Shard to query.
1414
* `epoch` - `Integer` - Defaults to current epoch.
1515

16-
#### Returns
16+
## Returns
1717

1818
* `validators` - `Array` - Array of all of the validators.
1919

20-
#### Sample Curl Request
20+
## Sample Curl Request
2121

2222
| Parameter | Value |
2323
| :--- | :--- |
@@ -28,7 +28,7 @@ Returns a list of network of a particular shard and epoch. To get current list o
2828
curl -H "Content-Type:application/json" -X GET "e0.b.hmny.io:5000/committee?shard_id=0&epoch=0"
2929
```
3030

31-
#### Sample Curl Response
31+
## Sample Curl Response
3232

3333
```javascript
3434
{

api-developers-guide/methods/blockchain-related-methods/hmy_blocknumber.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: BlockNumber
66

77
Get number of the most recent block.
88

9-
#### Returns
9+
## Returns
1010

1111
* `String` - Index of the most recent block in the chain.
1212

api-developers-guide/methods/blockchain-related-methods/hmy_gasprice.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: GasPrice
66

77
Returns the current gas price.
88

9-
#### Returns
9+
## Returns
1010

1111
* `String` - Number string of the current gas price.
1212

api-developers-guide/methods/blockchain-related-methods/hmy_getshardingstructure.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ description: GetShardingStructure
66

77
Returns the current shard of the node and lists API and WebSocket endpoints for each shard.
88

9-
#### Returns
9+
## Returns
1010

1111
* `current` - `bool` - If the current node is on this shard.
1212
* `http` - `String` - API endpoint for the shard.
1313
* `shardID` - `Integer` - Shard ID.
1414
* `ws` - `String` - WebSocket endpoint
1515

16-
#### Sample Curl Request
16+
## Sample Curl Request
1717

1818
```bash
1919
curl -d '{
@@ -24,7 +24,7 @@ curl -d '{
2424
}' -H "Content-Type:application/json" -X POST "http://s0.b.hmny.io:9500"
2525
```
2626

27-
#### Sample Curl Response
27+
## Sample Curl Response
2828

2929
```javascript
3030
{

api-developers-guide/methods/blockchain-related-methods/hmy_syncing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Syncing
66

77
Tests whether or not the node is syncing.
88

9-
#### **Returns**
9+
## **Returns**
1010

1111
* `Object` - Whether or not the node is syncing. `false` when it isn't.
1212

api-developers-guide/methods/blockchain-related-methods/untitled.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: GetExplorerBlocks returns information about the requested block(s).
66

77
Returns information about the block\(s\) specified by the parameters.
88

9-
#### Parameters
9+
## Parameters
1010

1111
{% hint style="info" %}
1212
The search range specified by `from` and `to` is inclusive of the ends, meaning `from=0&to=5` will return the blocks at indices 0, 1, 2, 3, 4, and 5.
@@ -18,9 +18,9 @@ If `from` and `to` are both some index **n**, then `blocks` will return the **n*
1818
* `to` - `Integer` - _\(Optional\)_ End of search range.
1919
* `offset` - `Integer` - _\(Optional\)_ How many blocks are listed per page.
2020
* `page` - `Integer` - _\(Optional\)_ Which page to view.
21-
* \[Not Implemented\] __`with_signers` - `Boolean` - If response contains block signers. Defaults to `false`.
21+
* \[Not Implemented\] \_\_`with_signers` - `Boolean` - If response contains block signers. Defaults to `false`.
2222

23-
#### Returns
23+
## Returns
2424

2525
* An array of blocks.
2626
* `height` - `String` - Block's height in the blockchain.
@@ -41,7 +41,7 @@ If `from` and `to` are both some index **n**, then `blocks` will return the **n*
4141
* `epoch` - `Integer` - Epoch this was mined in.
4242
* `extra_data` - `String` - Block's extra data.
4343

44-
#### Sample Curl Request
44+
## Sample Curl Request
4545

4646
| Parameter | Value |
4747
| :--- | :--- |
@@ -52,7 +52,7 @@ If `from` and `to` are both some index **n**, then `blocks` will return the **n*
5252
curl -H "Content-Type:application/json" -X GET "http://e1.b.hmny.io:5000/blocks?from=0&to=4"
5353
```
5454

55-
#### Sample Curl Response
55+
## Sample Curl Response
5656

5757
```javascript
5858
[
@@ -164,5 +164,3 @@ curl -H "Content-Type:application/json" -X GET "http://e1.b.hmny.io:5000/blocks?
164164
]
165165
```
166166

167-
168-

api-developers-guide/methods/contract-related-methods/hmy_getcode.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ description: GetCode
66

77
Get the code at a specific address.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - The address to get the code from.
1212
2. `String` - Block to query for information. Usually `latest`, which specifies the most recent block.
1313
3. `Function` - \(optional\) Optional callback, returns an error object as first parameter and the result as second.
1414

15-
#### Returns
15+
## Returns
1616

1717
* `String` - The data at given address `address`.
1818

api-developers-guide/methods/transaction-related-methods/getexplorerblocks.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: GetExplorerTx returns information about the requested transaction.
66

77
Returns information about a given transaction.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `id` - `String` - Transaction's hash \(ID\).
1212

13-
#### Returns
13+
## Returns
1414

1515
* `id` - `String` - Transaction's hash.
1616
* `timestamp` - `String` - Transaction's timestamp.
@@ -20,7 +20,7 @@ Returns information about a given transaction.
2020
* `bytes` - `String` - Size of the transaction in bytes.
2121
* `data` - `String` - Extra data.
2222

23-
#### Sample Curl Request
23+
## Sample Curl Request
2424

2525
| Parameter | Value |
2626
| :--- | :--- |
@@ -30,7 +30,7 @@ Returns information about a given transaction.
3030
curl -X GET -H "Content-Type:application/json" e0.b.hmny.io:5000/tx?id=0x7d8329dfd17cf82fcfda4e44f0f59b59c7a1379f173829beb005e94504d99b0f
3131
```
3232

33-
#### Sample Curl Response
33+
## Sample Curl Response
3434

3535
```javascript
3636
{

api-developers-guide/methods/transaction-related-methods/hmy_getblockbyhash.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: GetBlockByHash
66

77
Get block by its hash.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - The block hash.
1212
2. `Boolean` - If `true`, the returned block will contain all transactions in the block.
1313

14-
#### Returns
14+
## Returns
1515

1616
* `number` - `Number`: The block number. `null` when its pending block.
1717
* `hash` 32 Bytes - `String`: Hash of the block. `null` when its pending block.

api-developers-guide/methods/transaction-related-methods/hmy_getblockbynumber.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: GetBlockByNumber
66

77
Get block by its index in the blockchain.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - The block number.
1212
2. `Boolean` - If `true`, the returned block will contain all transactions in the block.
1313

14-
#### Returns
14+
## Returns
1515

1616
* `number` - `Number`: The block number. `null` when its pending block.
1717
* `hash` 32 Bytes - `String`: Hash of the block. `null` when its pending block.

api-developers-guide/methods/transaction-related-methods/hmy_getblocktransactioncountbyhash.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: GetBlockTransactionCount
66

77
Get the number of transactions in a block by the block's hash.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - The block hash.
1212

13-
#### Returns
13+
## Returns
1414

1515
* `Number` - The number of transactions in the given block.
1616

api-developers-guide/methods/transaction-related-methods/hmy_getblocktransactioncountbynumber.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: GetBlockTransactionCount
66

77
Get the number of transactions in a block by the block's index in the chain.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `Number` - The block number or hash.
1212

13-
#### Returns
13+
## Returns
1414

1515
* `Number` - The number of transactions in the given block.
1616

api-developers-guide/methods/transaction-related-methods/hmy_gettransactionbyblockhashandindex.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: GetTransactionByBlockHashAndIndex
66

77
Get transaction at an index from a given block, specified by block hash.
88

9-
#### Parameters
9+
## Parameters
1010

1111
1. `String` - The block hash.
1212
2. `Number` - The transactions index position.
1313

14-
#### Returns
14+
## Returns
1515

1616
* `hash` - `String`: Hash of the transaction.
1717
* `nonce` - `Number`: The number of transactions made by the sender prior to this one.

0 commit comments

Comments
 (0)