onlyswaps-js

A Typescript client for making cross-chain token transfers using the only swaps protocol built on the dcipher network.

Build

npm run build

Test

To run integration tests, you must have Docker installed and available in your system's PATH.

Check if Docker is installed by running:

docker --version

If this command fails, install Docker before proceeding.

You can run the integration tests using the convenience bash script: ./scripts/run-integration-tests.sh.

This script will:

• Spin up a local Anvil instance using Docker.
• Deploy the contracts.
• Initialize the contracts.
• Run the integration tests.

Lint

To check the linting: npm run lint

To fix any linter issues: npm run lint:fix

Maintenance

When updating the onlyswaps-solidity submodule

• switch to the latest commit
• compile and add the ABI to the ABI file
• bump the version

Known Issues

tsc throws a Type instantiation is excessively deep and possibly infinite. error

This appears to be an issue in viem. The easiest workaround is to update your tsconfig to use the following:

// tsconfig.json
{
  "compilerOptions": {
    "skipLibCheck": true
  }
}