Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkCherepovskyi committed Sep 11, 2024
1 parent b937edd commit d269b3f
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Description

Relayer service that makes calls to the smart contracts. Now it is used to work with such endpoints:
- `/integrations/voting-relayer/v1/register` - it takes calldata in hex encoided format from Rarime mobile applications and makes call to the smart contract.
- POST `/integrations/voting-relayer/v1/register` - it takes calldata in hex encoided format from Rarime mobile applications and makes call to the smart contract.

Request body example:
```json
Expand All @@ -15,6 +15,46 @@ Relayer service that makes calls to the smart contracts. Now it is used to work
}
```

- GET `/integrations/voting-relayer/v1/operations/latest` - it returnes info about latest transited root
Response body example

```json
{
"data": {
"id": "",
"type": "",
"attributes": {
"block_height": 0,
"destination_chain": "",
"operation_id": "",
"proof": "",
"tx_hash": ""
}
},
"included": []
}
```

- GET `/integrations/voting-relayer/v1/operations/{root}` - it returnes info about transited root, where root is lower case hex string with 0x prefix
Response body example

```json
{
"data": {
"id": "",
"type": "",
"attributes": {
"block_height": 0,
"destination_chain": "",
"operation_id": "",
"proof": "",
"tx_hash": ""
}
},
"included": []
}
```

## Install

```
Expand Down

0 comments on commit d269b3f

Please sign in to comment.