Skip to content

Commit

Permalink
update doc to reflect testnet URLs change
Browse files Browse the repository at this point in the history
Closes: diem#5822
  • Loading branch information
Xiao Li authored and bors-libra committed Aug 31, 2020
1 parent 2c1235f commit 58565a6
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion json-rpc/docs/client_implementation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Libra JSON-RPC APIs extend to JSON-RPC 2.0 Spec for specific use case, check [Li

### Testnet

A simplest way to validate your client works is connecting it to Testnet(https://client.testnet.libra.org/v1).
A simplest way to validate your client works is connecting it to Testnet(https://testnet.libra.org/v1).
For some query blockchain methods like [get_currencies](method_get_currencies.md) or [get_metadata](method_get_metadata.md), you don't need anything else other than a HTTP client to get back response from server.
Try out [get_currencies example](method_get_currencies.md#example) on Testnet, and this can be the first query blockchain API you implement for your client.

Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_get_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Null - If account does not exist

```
// Request: fetches account for account address "1668f6be25668c1a17cd8caf6b8d2f25"
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_account","params":["1668f6be25668c1a17cd8caf6b8d2f25"],"id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_account","params":["1668f6be25668c1a17cd8caf6b8d2f25"],"id":1}' https://testnet.libra.org/v1
// Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_get_account_transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Null - If transaction does not exist

```
// Request: fetches transaction for account address "1668f6be25668c1a17cd8caf6b8d2f25" and sequence number 0, with including events associated with this transaction
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_account_transaction","params":["1668f6be25668c1a17cd8caf6b8d2f25", 0, true],"id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_account_transaction","params":["1668f6be25668c1a17cd8caf6b8d2f25", 0, true],"id":1}' https://testnet.libra.org/v1
// Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_get_currencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Returns array of [CurrencyInfo](type_currency_info.md) objects.

```
// Request: fetches currencies supported by the system
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_currencies","params":[],"id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_currencies","params":[],"id":1}' https://testnet.libra.org/v1
// Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_get_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Returns array of [Event](type_event.md) objects

```
//Request: get events associated with receivedpayment event stream key "00000000000000001668f6be25668c1a17cd8caf6b8d2f25" for account "1668f6be25668c1a17cd8caf6b8d2f25"
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_events","params": ["00000000000000001668f6be25668c1a17cd8caf6b8d2f25", 0, 10], "id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_events","params": ["00000000000000001668f6be25668c1a17cd8caf6b8d2f25", 0, 10], "id":1}' https://testnet.libra.org/v1
//Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_get_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Get the blockchain metadata (e.g., state as known to the current full node).

```
// Request: fetches current block metadata
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_metadata","params":[],"id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_metadata","params":[],"id":1}' https://testnet.libra.org/v1
// Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_get_transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if include_events is false, the events field in the Transaction object will be a

```
// Request: fetches 10 transactions since version 100000
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_transactions","params":[100000, 10, false],"id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_transactions","params":[100000, 10, false],"id":1}' https://testnet.libra.org/v1
// Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/method_submit.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ For VM and Mempool errors may include a "data" object contains more detail infor

```
// Request: submits a transaction whose hex-encoded LCS byte representation is in params
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"submit","params":["1668F6BE25668C1A17CD8CAF6B8D2F25370000000000000001E101A11CEB0B010000000701000202020403061004160205181D0735610896011000000001010000020001000003020301010004010300010501060C0108000506080005030A020A020005060C05030A020A020109000C4C696272614163636F756E741257697468647261774361706162696C6974791B657874726163745F77697468647261775F6361706162696C697479087061795F66726F6D1B726573746F72655F77697468647261775F6361706162696C69747900000000000000000000000000000001010104010C0B0011000C050E050A010A020B030B0438000B05110202010700000000000000000000000000000001034C4252034C4252000403262E691EC8C7E3E23470D8C3EE26E1A70140420F00000000000400040040420F00000000000000000000000000034C425200E8764817000000020020F549A91FB9989883FB4D38B463308F3EA82074FB39EA74DAE61F62E11BF55D25405CD26F114183C44874DD3F861E0AD24B8E5D8B8C1CAA1B79C7E641C664AE3FD645E4310237A0DC046046DEFBE27C4F15CAAB55A76BBAC15E92B444431232DE0C"],"id": 1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"submit","params":["1668F6BE25668C1A17CD8CAF6B8D2F25370000000000000001E101A11CEB0B010000000701000202020403061004160205181D0735610896011000000001010000020001000003020301010004010300010501060C0108000506080005030A020A020005060C05030A020A020109000C4C696272614163636F756E741257697468647261774361706162696C6974791B657874726163745F77697468647261775F6361706162696C697479087061795F66726F6D1B726573746F72655F77697468647261775F6361706162696C69747900000000000000000000000000000001010104010C0B0011000C050E050A010A020B030B0438000B05110202010700000000000000000000000000000001034C4252034C4252000403262E691EC8C7E3E23470D8C3EE26E1A70140420F00000000000400040040420F00000000000000000000000000034C425200E8764817000000020020F549A91FB9989883FB4D38B463308F3EA82074FB39EA74DAE61F62E11BF55D25405CD26F114183C44874DD3F861E0AD24B8E5D8B8C1CAA1B79C7E641C664AE3FD645E4310237A0DC046046DEFBE27C4F15CAAB55A76BBAC15E92B444431232DE0C"],"id": 1}' https://testnet.libra.org/v1
// Response, for successful transaction submission
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/docs/type_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

```
// Request: fetches current block metadata
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_metadata","params":[],"id":1}' https://client.testnet.libra.org/v1
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"get_metadata","params":[],"id":1}' https://testnet.libra.org/v1
// Response
{
Expand Down
2 changes: 1 addition & 1 deletion json-rpc/json-rpc-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,5 @@ Unless specifically mentioned below, Libra JSON-RPC will return the default erro
## Versioning

We use URI versioning to version our API, current version is v1.
For example, to hit testnet, the server url is: https://client.testnet.libra.org/v1.
For example, to hit testnet, the server url is: https://testnet.libra.org/v1.
You may check [API-CHANGELOG.md](API-CHANGELOG.md) and learn more about our API changes.

0 comments on commit 58565a6

Please sign in to comment.