RPC Reference
This is an RPC reference of Matchmaker, meant to aid when building non-rust RPC clients.
JSON RPC
As a JSON RPC, the specification for communicating with the endpoints is the following:
Request
Response
Name | Type | Description |
---|---|---|
| String | RPC method name |
| Array | Array of input params to the RPC method |
| Number | Order ID if calling asynchronous methods |
| String | Version of JSON RPC specification, always "2.0" |
| depends on method | Result data of the RPC method call |
Types
All RPC endpoints, with the exception of health
and nodes
endpoints, are required to receive their parameters presigned using a (whitelisted) ECDSA private key, all contained within the SignedData type.
SignedData
A container for signed parameters.
ProofRequest
The Proof request container type.
For more information, refer to Configuration.
ProofStatus
The Proof status container type.
For more information, refer to .
Reference
All methods require headers:
Name | Value |
---|---|
Content-Type |
|
Submit Proof Request
POST
method
submitProofRequest
Submits a proof request to the network.
Params
Position | Type | Description |
---|---|---|
|
| Signed proof request. |
Response
Type | Description |
---|---|
|
Check Request Status
POST
method
checkRequestStatus
Checks a proof request status in the network.
Params
Position | Type | Description |
---|---|---|
|
| Signed proof request id. |
Response
Type | Description |
---|---|
| The current status of the proof request in the network |
Last updated