Skip to content

Commit

Permalink
readme v0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
KowalewskiPawel committed Mar 29, 2023
1 parent a974518 commit a629f91
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1>Substrate Smart Contracts Caller</h1>
<strong>Ver. 0.2</strong>
<strong>Ver. 0.3</strong>
</div>

## About
Expand Down Expand Up @@ -61,6 +61,24 @@ PORT=<Port_for_the_app_instance>
}
```

- GET `api/contract/txUrl` - Previously executed transaction's block url

**REQUEST BODY**

```
{
"txId": "previously_executed_transaction_id",
}
```

**RESPONSE BODY**

```
{
"transactionBlockUrl": "https://test.azero.dev/?rpc=wss%3A%2F%2Fws.test.azero.dev#/explorer/query/<block_hash>"
}
```

- POST `api/contract/write` - Execution of the write method on the given smart contract

**REQUEST BODY**
Expand All @@ -72,6 +90,18 @@ PORT=<Port_for_the_app_instance>
}
```

#### Accounts

- GET `api/account/publicKey` - Account's Public Key

**RESPONSE BODY**

```
{
"accountPublicKey": "public_key"
}
```

#### Signatures

- GET `api/signature/verify` - Verification of the given signature
Expand All @@ -86,6 +116,14 @@ PORT=<Port_for_the_app_instance>
}
```

**RESPONSE BODY**

```
{
"isSignatureValid": boolean
}
```

## License

* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

0 comments on commit a629f91

Please sign in to comment.