lukso-network / tools-mock-relayer

A mock relayer for testing purposes.

Mock Transaction Relayer ·

---

Skeleton example Transaction Relayer Service according to LSP15-TransactionRelayServiceAPI API specification.

This application is a starter project for an LSP15 Transaction Relayer Service for example and testing purposes and should not be considered production ready.

This application does not include any authentication, quota or nonce management. A real Transaction Relayer Service should consider how to manage signer key nonces appropriately to be able to handle concurrent transactions.

Usage

To begin sending transaction with the Dummy Transaction Relayer create a .env file to hold configuration parameters:

cp .env.example .env

Fill the values with real data. A SIGNER_PRIVATE_KEY must be provided with sufficient balance to execute transactions on the blockchain.

Install the dependencies:

yarn

Run the application:

yarn run dev

Transaction Gate

This project does not handle concurrent transactions. To prevent nonce reuse errors, a transaction gate is implemented which will block incoming transactions if there is already a transaction pending.

This can be turned on or off by setting ENABLE_TRANSACTION_GATE to true or false in the .env config.

LSP15 Transaction Relayer Service API Specification

POST /execute

Executes a signed transaction on behalf of a Universal Profile using executeRelayCall().

• address - The address of the Universal Profile which is executing the transaction.
• transaction - An object containing the transaction parameters which will executed with executeRelayCall.
  • abi - The abi-encoded transaction data (e.g: a function call on the Universal Profile smart contract) which will be passed as the payload parameter to the executeRelayCall function.
  • signature - The signed message according to LSP6 specification.
  • nonce - The nonce of the KeyManager fetched by calling getNonce(address address, uint128 channelId) on the LSP6 KeyManager contract.
  • validityTimestamps (optional) - Two concatenated uint128 timestamps which indicate a time duration for which the transaction will be considered valid. If no validityTimestamps parameter is passed the relayer should assume that validityTimestamps is 0 and the transaction will be valid indefinitely until it is executed.

Request body

{
  "address": "0xBB645D97B0c7D101ca0d73131e521fe89B463BFD",
  "transaction": {
    "abi": "0x7f23690c5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000596f357c6aa5a21984a83b7eef4cb0720ac1fcf5a45e9d84c653d97b71bbe89b7a728c386a697066733a2f2f516d624b43744b4d7573376741524470617744687a32506a4e36616f64346b69794e436851726d3451437858454b00000000000000",
    "signature": "0x43c958b1729586749169599d7e776f18afc6223c7da21107161477d291d497973b4fc50a724b1b2ab98f3f8cf1d5cdbbbdf3512e4fbfbdc39732229a15beb14a1b",
    "nonce": 1,
    "validityTimestamps": "0x0000000000000000000000006420f3f000000000000000000000000065ec82d0"
  }
}

Response

{
  "transactionHash": "0xBB645D97B0c7D101ca0d73131e521fe89B463BFD"
}

POST /quota

Returns the available quota left for a registered Universal Profile.

• signature is the result of signing a hash calculated as an EIP-712 hash where the message is keccak256(address, timestamp).
• address is the controller address with permissions on the Universal Profile used to create the signature value.
• timestamp represents the time the signature was created. Must be +/- 300 seconds from current time to be considered a valid request. Value should be int, int256, uint or uint256.

Request body

{
  "address": "0xBB645D97B0c7D101ca0d73131e521fe89B463BFD",
  "timestamp": 1656408193,
  "signature": "0xf480c87a352d42e49112257cc6afab0ff8365bb769424bb42e79e78cd11debf24fd5665b03407d8c2ce994cf5d718031a51a657d4308f146740e17e15b9747ef1b"
}

Response

{
  "quota": 1543091,
  "unit": "gas",
  "totalQuota": 5000000,
  "resetDate": 1656408193
}

• quota shows available balance left in units defined by unit
• unit could be gas, lyx or transactionCount depending on the business model
• totalQuota reflects total limit. i.e. available + used quota since reset
• resetDate gives date that available quota will reset, e.g. a monthly allowance

tools-mock-relayer's Issues

No overload matches this call.

Hey Team,

I attempted to clone this repo and follow the instructions but it throws error on compilation.

return new TSError(diagnosticText, diagnosticCodes, diagnostics);
           ^
TSError: ⨯ Unable to compile TypeScript:
src/modules/relayer/relayer.service.ts:46:60 - error TS2769: No overload matches this call.
  The last overload gave the following error.
    Argument of type '"executeRelayCall"' is not assignable to parameter of type '"target"'.

46   const transactionData = lsp6Interface.encodeFunctionData("executeRelayCall", [
                                                              ~~~~~~~~~~~~~~~~~~

  'types/ethers-v5'/LSP6KeyManagerInit.ts:121:3
    121   encodeFunctionData(functionFragment: "target", values?: undefined): string;
          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    The last overload is declared here.