Include /transactions endpoint in bridge API

0xSasaPrsic commented 2 weeks ago

endpoint: /transactions
queryParams: {
    ethAddress?: ""
    availAddress?: ""
    page?: 3
    pageSize?: 25
}
response: {
    result: [
        {
          sourceChain: "AVAIL", // "ETHEREUM"
          destinationChain: "ETHEREUM", // "AVAIL"
          messageId: 24,
          status:"IN PROGRESS" // "READY_TO_CLAIM" // "CLAIMED" // "FAILED"
          sourceTransactionHash: "0xabc", 
          sourceTransactionBlockNumber: 123,
          sourceTransactionIndex: 2,
          sourceTransactionTimestamp: date,
          sourceTokenAddress: "0xabc",
          destinationTransactionHash: "0xabc",
          destinationTransactionBlockNumber: 123,
          destinationTransactionTimestamp: date,
          destinationTransactionIndex: 123,
          destinationTokenAddress: "0xabc",
          depositorAddress: "0xabc",
          receiverAddress: "0xabc",
          amount: 1234,
          message: "0x",
          dataType: "ERC20",
          blockHash: "0xabc"
        }, 
        {}
    ],
    paginationData: {
        hasNextPage: true
        page: 0
        pageSize: 25
        totalCount: 100
    }
}

0xSasaPrsic commented 2 weeks ago

@abheektripathy we need additional info about the payload. query params:

what should be default values for query params?
pageSize must have upper bound.
what are mandatory fields in the response
how should be handled if the response is optional? null or to remove prop from the response?

0xSasaPrsic commented 1 week ago

PR that supports current indexer implementation: https://github.com/availproject/bridge-api/pull/22

availproject / bridge-api

Include /transactions endpoint in bridge API #21