This method checks an incoming transaction, builds the zkSNARK Merkle tree proof, and sends the transaction to the Pool contract. The transaction doesn’t process immediately because contract interaction is completed in a serial manner. Incoming transactions are put into the job queue. The method returns jobId on success
Request Body
Name
Type
Description
proof*
Dictionary
Transaction proof (built by a client)
memo*
String
Memo block, Base64-encoded
tx_type*
Integer
0: deposit, 1: transfer, 2: withdrawal
depositSignature
String
Account nullifier signature with the client's native chain private key (for withdrawal tx only)
{"jobId": "1"}
{ error:"Error while parsing the input JSON", description:"tx_type is incorrect"}
{ error:"An internal error has occured. Please try again later", description:"optional error description"}
Get the job status
GEThttp://relayer/job/:id
Returns incoming transaction processing state. jobId is returned by /transaction method
Query Parameters
Name
Type
Description
id*
Integer
Job identifier
Query transactions
GEThttp://relayer/transactions/:limit/:offset
Returns memo blocks and out commits for transactions at the specified offset. This method is used by clients to synchronize account state.
Query Parameters
Name
Type
Description
limit*
Integer
Number of transactions to query
offset*
Integer
The Index of the first transaction (in the Merkle tree, should be a multiple of 128)
Get Merkle tree proofs at the specified position
GEThttp://relayer/merkle/proof?[index]
Get Merkle tree root node at the specified index
GEThttp://relayer/merkle/root/:index
Query Parameters
Name
Type
Description
index
Integer
Calculate transaction proof
POSThttp://relayer/proof_tx
Builds zkSNARK proof for the transaction based on public and secret transaction input calculated by a client.
WARNING: This is a debug method used to decrease client overhead. DO NOT use in production, as the client should pass public and secret transactional data. This significantly decreases overall security!
