Skip to content

Commit

Permalink
Update 00_overview.md (#298)
Browse files Browse the repository at this point in the history
* Update 00_overview.md

Example usage with the public node and local

Signed-off-by: Caleb Curry <[email protected]>

* Update documentation/testnet/getting_started/00_overview.md

Signed-off-by: Collin Chin <[email protected]>

* Update documentation/testnet/getting_started/00_overview.md

Signed-off-by: Collin Chin <[email protected]>

---------

Signed-off-by: Caleb Curry <[email protected]>
Signed-off-by: Collin Chin <[email protected]>
Co-authored-by: Collin Chin <[email protected]>
  • Loading branch information
CalebCurry and collinc97 authored Oct 16, 2023
1 parent c391c27 commit 3d58d31
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions documentation/testnet/getting_started/00_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,28 @@ and running experimental features for inclusion on mainnet.
The Aleo Testnet3 API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).

To connect to the network, make a request to an Aleo Testnet III bootnode.
<!-- markdown-link-check-disable -->

| URL |
|------------------|
| [api.explorer.aleo.org/v1/testnet3](api.explorer.aleo.org/v1/testnet3/) |

| Status | Region | URL |
|:------:|:--------:|------------------|
| Live | Americas | vm.aleo.org/api/ |
For example, you can [retrieve the current block height](https://api.explorer.aleo.org/v1/testnet3/latest/height).

With a local instance of `snarkos`, you can launch a client node with:

```
snarkos start --client --nodisplay
```

By default, this will make the node API available at `0.0.0.0:3033`:

```
http://0.0.0.0:3033/testnet3/latest/height
```

Now, refer to the [API reference](#api) for a list of available endpoints.
<!-- markdown-link-check-enable -->

## snarkOS

Expand Down

0 comments on commit 3d58d31

Please sign in to comment.