@connext/nxtp-txservice
TypeScript icon, indicating that this package has built-in type declarations

2.4.0 • Public • Published

TransactionService

TransactionService is a transaction relayer that should work with any chain and ensure that a tx gets submitted.

Key differences with Vector

  1. Impossible to double-collateralize: because of how the contracts are written, we do not have to ensure that a tx gets submitted to chain with only one nonce. Submitting multiple times will just result in a revert that can easily be handled.
  2. No offchain DB -- the TransactionService should be fully stateless. The router (responsible for calling TransactionService) whould be responsible for calling TransactionService on init if there are pending transfers that need to be completed.
  3. Should be as generalized as possible. Params should take in arbitrary calldata. That way, we can iterate on biz logic mostly inside the router and keep TransactionService untouched.

All in all, this means the TransactionService should be as "dumb" as possible. It should simply relay transactions to chain with gas bump + retries return a success EITHER when it notices an onchain event was emitted OR when the txs revert onchain bc they were already submitted.

It should also natively support multiple providers, rotating through them if it fails to receive success responses.

Dependencies

Services:

  • Chain RPC Providers
  • Signer
  • Config (contains multiple providers and block confirmation requirements per chain)

Params:

  • config:
  • log: Logger (BaseLog)
  • Signer

Each transaction method should take in as params:

  • chainId: chain ID number
  • tx: Tx to, from, data

Test Vectors

The fundamental design principle of the txService is that it should only handle chain-submission-related issues and nothing else. This will make it much easier to test.

We need to make sure that the txService is resilient to all sorts of possible chain-related failures:

  1. Reorgs
  2. Providers unresponsive
  3. Providers returning errors
  4. Providers out of sync with the chain
  5. Txs underpriced
  6. Txs stuck in mempool
  7. Txs overpriced (max gas price)
  8. Nonce already used

Bc the txService is fairly generalized, we should be able to easily unit test handling all of the above cases by writing a mock provider. We can pull logs from vector to understand more about what kinds of errors providers will return that we should be accounting for.

Readme

Keywords

none

Package Sidebar

Install

npm i @connext/nxtp-txservice

Weekly Downloads

223

Version

2.4.0

License

MIT

Unpacked Size

524 kB

Total Files

72

Last publish

Collaborators

  • just-a-node
  • rhlsthrm
  • arjunbhuptani
  • sanchaymittal
  • laynehaber