Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CaisManai authored Oct 19, 2023
1 parent a25b5b4 commit f27e6d9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions tools/walletextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ It uses a container to wrap the services that are required to allow the wallet e
### Running Wallet Extension with Docker

To build a docker image use docker build command. Please note that you need to run it from the root of the repository.
Ro run the container you can use `./docker_run.sh`. You can add parameters to the script, and they are passed to wallet extension
To run the container you can use `./docker_run.sh`. You can add parameters to the script, and they are passed to the wallet extension
(example: `-host=0.0.0.0` to be able to access wallet extension endpoints via localhost).


### HTTP Endpoints

For interacting with Obscuro Gateway, there are the following HTTP endpoint available:
For interacting with Obscuro Gateway, there are the following HTTP endpoints available:

- `GET /v1/join`

Expand All @@ -40,14 +40,14 @@ It generates and returns userID which needs to be added as a query parameter "u"

- `POST /v1/authenticate?u=$UserId`

With this endpoint, you submit a signed message in a format `Register <userID> for <account>`
With this endpoint, you submit a signed message in the format `Register <userID> for <account>`
from that account which proves that you hold private keys for it, and it links that account with your userID.

- `GET /v1/query/address?u=$UserId&a=$Address`

This endpoint responds with a json of true or false if the address "a" is already registered for user "u"
This endpoint responds with a JSON of true or false if the address "a" is already registered for user "u"


- `POST "/v1/revoke?u=$UserId"`

When this endpoint is triggered, the userId with the authenticated viewing keys should be deleted.
When this endpoint is triggered, the userId with the authenticated viewing keys should be deleted.

0 comments on commit f27e6d9

Please sign in to comment.