-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
US-336: Update documentations. (#362)
* Add zilliqa-rs * add scilla parser * Remove upgrade to v8 doc * Add GetNodeType doc. * Add two more api * Add verbose doc * truncate output * Add soft confirmed tx * add get-current-ds-comm * Add news page * fix news * Update supported eth endpoints * fmt * Add persistence addresses. * Add status * Add status * Add pyzil * add ethers.js * add ethers.js * fix errors * Add otterscan * Update docs/zilevm/developer-onboarding/hardhat.md Co-authored-by: Richard Watts <[email protected]> --------- Co-authored-by: Richard Watts <[email protected]>
- Loading branch information
1 parent
7843aa5
commit a8995ee
Showing
26 changed files
with
2,262 additions
and
398 deletions.
There are no files selected for viewing
655 changes: 655 additions & 0 deletions
655
docs/api/blockchain-related-methods/api-blockchain-get-current-ds-comm.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
docs/api/blockchain-related-methods/api-blockchain-get-node-type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| id: api-blockchain-get-node-type | ||
| title: GetNodeType | ||
| --- | ||
|
|
||
| --- | ||
|
|
||
| Returns node type. The possible return values are: | ||
|
|
||
| - `"Not in network, synced till epoch [epoch number]"` if the server has not joined the network and is synced until a specific epoch. | ||
| - `"Seed"` if the server is in lookup node mode and is an archival lookup node. | ||
| - `"Lookup"` if the server is in lookup node mode | ||
|
|
||
| ### Example Request | ||
|
|
||
| === "cURL" | ||
|
|
||
| ```shell | ||
| curl -d '{ | ||
| "id": "1", | ||
| "jsonrpc": "2.0", | ||
| "method": "GetNodeType", | ||
| "params": [""] | ||
| }' -H "Content-Type: application/json" -X POST "https://api.zilliqa.com/" | ||
| ``` | ||
|
|
||
| ### Example Response | ||
|
|
||
| ```json | ||
| { "id": "1", "jsonrpc": "2.0", "result": "Seed" } | ||
| ``` | ||
|
|
||
| ### HTTP Request | ||
|
|
||
| | Chain(s) | URL(s) | | ||
| | --------------------- | -------------------------------------------------------------------------------------------- | | ||
| | **Zilliqa mainnet** | [https://api.zilliqa.com/](https://api.zilliqa.com/) | | ||
| | **Developer testnet** | [https://dev-api.zilliqa.com/](https://dev-api.zilliqa.com/) | | ||
| | **Local testnet** | [http://localhost:4201/](http://localhost:4201/) | | ||
| | **Isolated server** | [https://zilliqa-isolated-server.zilliqa.com/](https://zilliqa-isolated-server.zilliqa.com/) | | ||
|
|
||
| ### Arguments | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| | --------- | ------ | -------- | ----------------- | | ||
| | `id` | string | Required | `"1"` | | ||
| | `jsonrpc` | string | Required | `"2.0"` | | ||
| | `method` | string | Required | `"GetNodeType"` | | ||
| | `params` | string | Required | Empty string `""` | |
45 changes: 45 additions & 0 deletions
45
docs/api/blockchain-related-methods/api-blockchain-get-num-peers.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| id: api-blockchain-get-num-peers | ||
| title: GetNumPeers | ||
| --- | ||
|
|
||
| --- | ||
|
|
||
| Returns total number of peers including committee peers. | ||
|
|
||
| ### Example Request | ||
|
|
||
| === "cURL" | ||
|
|
||
| ```shell | ||
| curl -d '{ | ||
| "id": "1", | ||
| "jsonrpc": "2.0", | ||
| "method": "GetNumPeers", | ||
| "params": [""] | ||
| }' -H "Content-Type: application/json" -X POST "https://api.zilliqa.com/" | ||
| ``` | ||
|
|
||
| ### Example Response | ||
|
|
||
| ```json | ||
| { "id": "1", "jsonrpc": "2.0", "result": 600 } | ||
| ``` | ||
|
|
||
| ### HTTP Request | ||
|
|
||
| | Chain(s) | URL(s) | | ||
| | --------------------- | -------------------------------------------------------------------------------------------- | | ||
| | **Zilliqa mainnet** | [https://api.zilliqa.com/](https://api.zilliqa.com/) | | ||
| | **Developer testnet** | [https://dev-api.zilliqa.com/](https://dev-api.zilliqa.com/) | | ||
| | **Local testnet** | [http://localhost:4201/](http://localhost:4201/) | | ||
| | **Isolated server** | [https://zilliqa-isolated-server.zilliqa.com/](https://zilliqa-isolated-server.zilliqa.com/) | | ||
|
|
||
| ### Arguments | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| | --------- | ------ | -------- | ----------------- | | ||
| | `id` | string | Required | `"1"` | | ||
| | `jsonrpc` | string | Required | `"2.0"` | | ||
| | `method` | string | Required | `"GetNumPeers"` | | ||
| | `params` | string | Required | Empty string `""` | |
45 changes: 45 additions & 0 deletions
45
docs/api/blockchain-related-methods/api-blockchain-get-sharding-structure.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| id: api-blockchain-get-sharding-structure | ||
| title: GetShardingStructure | ||
| --- | ||
|
|
||
| --- | ||
|
|
||
| Retrieves the sharding structure from the lookup server. | ||
|
|
||
| ### Example Request | ||
|
|
||
| === "cURL" | ||
|
|
||
| ```shell | ||
| curl -d '{ | ||
| "id": "1", | ||
| "jsonrpc": "2.0", | ||
| "method": "GetShardingStructure", | ||
| "params": [""] | ||
| }' -H "Content-Type: application/json" -X POST "https://api.zilliqa.com/" | ||
| ``` | ||
|
|
||
| ### Example Response | ||
|
|
||
| ```json | ||
| { "id": "1", "jsonrpc": "2.0", "result": { "NumPeers": [0] } } | ||
| ``` | ||
|
|
||
| ### HTTP Request | ||
|
|
||
| | Chain(s) | URL(s) | | ||
| | --------------------- | -------------------------------------------------------------------------------------------- | | ||
| | **Zilliqa mainnet** | [https://api.zilliqa.com/](https://api.zilliqa.com/) | | ||
| | **Developer testnet** | [https://dev-api.zilliqa.com/](https://dev-api.zilliqa.com/) | | ||
| | **Local testnet** | [http://localhost:4201/](http://localhost:4201/) | | ||
| | **Isolated server** | [https://zilliqa-isolated-server.zilliqa.com/](https://zilliqa-isolated-server.zilliqa.com/) | | ||
|
|
||
| ### Arguments | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| | --------- | ------ | -------- | ------------------------ | | ||
| | `id` | string | Required | `"1"` | | ||
| | `jsonrpc` | string | Required | `"2.0"` | | ||
| | `method` | string | Required | `"GetShardingStructure"` | | ||
| | `params` | string | Required | Empty string `""` | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.