Relay

Execute Relay Transaction

POST https://gateway-relay.herokuapp.com/api/relay/execute

Headers

Name	Type	Description
Authorization*	jwt token	received via authenticating with the auth endpoints. To learn more about the authentication flow, click here.

Request Body

Name	Type	Description
keyManagerAddress*	string	address of the keymanager that controls the UP of the user sending this relay transaction
transaction.abi*	string	the encoded ABI of the transaction being sent
transaction.signature*	string	the transaction signature, signed by someone who has CALL and TRANSFER permissions to the UP involved in sending the transaction
transaction.nonce*	number	the nonce of the keymanager contract

201: Created successful operation

Example 201 Response

{
    transactionHash: '0x8fe07e8d16e284386de85b5d42883c1f7c6dfbee2047c69b4a60117466087053'
}

400: Bad Request malformed request error

Example 400 Response

{
    error: 'Malformed request, please ensure the following parameters are included: keyManagerAddress, transaction'
}

401: Unauthorized authentication error

Example 401 Response

{
    error: 'Unauthenticated call to execute. Please re-authenticate and try again.'
}

404: Not Found user not found error

Example 404 Response

{
    error: 'No user found with provided address: 0x218C2BbaaBa0D66ddcD5De942Ed2980Bbfd1f004'
}

500: Internal Server Error internal server error

Example 500 Response

{
    error: 'An internal server error occurred. Please check the request body, ensure you are authenticated, and try again.'
}

Get User Credit Quota

POST https://gateway-relay.herokuapp.com/api/relay/quota

Headers

Name	Type	Description
Authorization*	jwt token	received via authenticating with the auth endpoints. To learn more about the authentication flow, click here.

Request Body

Name	Type	Description
address*	string	UP address associated with the user in question
timestamp*	integer	timestamp of when the request is being sent +/- 5 seconds
signature*	string	a message signed by a controller key with SIGN permission on the user's UP

200: OK successful operation

Example 200 Response

{
    quota: 100, //describes current credit amount
    unit: 'credits',
    totalQuota: 100, //will be 0 if user is not subscribed
    resetDate: 1664380478 //will be -1 if user is not subscribed
}

400: Bad Request malformed request error

Example 400 Response

{
    error: 'Malformed request, please ensure the following parameters are included: quota, unit, totalQuota, resetDate'
}

404: Not Found user not found error

Example 404 Response

{
    error: 'No user found with provided address: 0x218C2BbaaBa0D66ddcD5De942Ed2980Bbfd1f004'
}

500: Internal Server Error internal server error

Example 500 Response

{
    error: 'An internal server error occurred. Please check the request body, ensure you are authenticated, and try again.'
}

401: Unauthorized authentication error

Example 401 Response

{
    error: 'Unauthenticated call to quota. Please re-authenticate and try again.'
}

Get Transaction Status

POST https://gateway-relay.herokuapp.com/api/relay/transactionStatus

Headers

Name	Type	Description
Authorization*	jwt token	received via authenticating with the auth endpoints. To learn more about the authentication flow, click here.

Request Body

Name	Type	Description
transactionHash*	string	the transaction hash associated with the transaction whose status is being received

200: OK successful operation

Example 200 Response

{
    status: 'Success',
    transactionSenderAddress: 0x218C2BbaaBa0D66ddcD5De942Ed2980Bbfd1f004,
    creditsUsed: 2.1,
    creditsBefore: 7.1,
    creditsAfter: 5
}

400: Bad Request malformed request error

Example 400 Response

{
    error: 'Malformed request, please ensure the following parameters are included: transactionHash'
}

404: Not Found transaction not found error

Example 404 Response

{
    error: 'Transaction was not sent through the Gateway Relay Service. Transaction hash: 0xcd56ff1157e172bfed0310526ac14c135d59628eb046a62ac71ed7380585cf87'
}

500: Internal Server Error internal server error

Example 500 Response

{
    error: 'An internal server error occurred. Please check the request body, ensure you are authenticated, and try again.'
}

401: Unauthorized authentication error

Example 401 Response

{
    error: 'Unauthenticated call to transactionStatus. Please re-authenticate and try again.'
}