Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Move TODOs to PR 732 for tracking:
#732
  • Loading branch information
Clay-Mysten authored Mar 22, 2022
1 parent 7a70b4f commit deab7fd
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,10 @@ Sui Explorer is a chain explorer for the Sui network, similiar in functionality
## Data source / RPC URL
The Sui Explorer front end can use any Sui RPC URL as a backend, but it must have Cross-Origin Resource Sharing (CORS) set up.

TODO: Link to guidance for how we want this done. Something generic resembling:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html

To change the RPC URL, pass a [url-encoded](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding) URL to the RPC parameter. So to use http://127.0.0.1:5000, the Sui REST API's default local port, use the URL:

http://127.0.0.1:3000?rpc=http%3A%2F%2F127.0.0.1%3A5000%2F

TODO: Find out if we need the "%2F" URL at the end. Also, can we include the URL without character substitution?

This defaults to https://demo-rpc.sui.io (for now).

The RPC URL preference will be remembered for three hours before being discarded - this way, it's not necessary to continually pass it on every page.
Expand Down Expand Up @@ -57,8 +52,6 @@ Chrome doesn't let you make requests without CORS on the local host, but **Firef
## no more about running locally
## ----------------------------------------------------------------------

TODO: Remove or populate the header above.

## Proposed basic architecture

This is described in order of how data flows, from the source network to the end user. Browser front end is a standard React app, powered by the HTTP API:
Expand Down

0 comments on commit deab7fd

Please sign in to comment.