Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
keefertaylor authored Nov 24, 2019
1 parent 36bbbc8 commit c4c8424
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Notice that you'll get the API key and endpoint on the console output. Save thes
13. Deposit a small amount of Tezos into the address that you created earlier.
## Usage and Testing
## Usage
You can use the following instructions to create an operation payload, sign it, and test it:
Expand Down Expand Up @@ -202,4 +202,16 @@ https://<snip>.execute-api.eu-west-1.amazonaws.com/prod/sign \
-d '{"op": "48e0557081272eac478ef0808ffd63c80ba8c9c864e99bb9611af415a6bd69066b00aad7200bcbbbcf8d26977fb153042865bc33edfdec09c4f98601904e0000839a7b29bb08405ff4bc731a4a3a5e45f59d96f80c262ec4a30f9289a6e7c4a16c00aad7200bcbbbcf8d26977fb153042865bc33edfda209c5f98601c350000a0000d4b265a4efc508aa6a4610969cd7fd249f9145ae00"}'
ootEYwJPFfWXsx7VwixsnmhbkWd5BfxmFZG4eDhLZ3AeHD26TYT
```
Be sure to replace the `<api-key` in the `x-api-key` header with the API key that was returned by the `serverless deploy`. The operation hash that is returned (in this example `ootEYwJPFfWXsx7VwixsnmhbkWd5BfxmFZG4eDhLZ3AeHD26TYT`) is the hash generated by the Tezos node upon successful injection of the operation. You can search for it in any Tezos block explorer, and it should be available in 1 minute or less (depending on how fast the operation is included in a block on the Tezos network).
Be sure to replace the `<api-key>` in the `x-api-key` header with the API key that was returned by the `serverless deploy`. The operation hash that is returned (in this example `ootEYwJPFfWXsx7VwixsnmhbkWd5BfxmFZG4eDhLZ3AeHD26TYT`) is the hash generated by the Tezos node upon successful injection of the operation. You can search for it in any Tezos block explorer, and it should be available in 1 minute or less (depending on how fast the operation is included in a block on the Tezos network).
# Testing
This function is extensively unit tested with [Jest](https://jestjs.io/). You can run the tests yourself with the following commands:
```shell
# Install required dependencies.
$ npm install
# Run Tests!
$ npm test
```

0 comments on commit c4c8424

Please sign in to comment.