AirSwap Protocols

The @airswap/staking package is part of the AirSwap peer-to-peer trading network.

⚠️ Warning: This package may contain unaudited code. For production use, always refer to the Deployed Contracts documentation to ensure you are interacting with verified deployments.

You can execute the test suite and generate coverage reports using the following commands. Ensure artifacts are compiled first via yarn compile in the airswap-protocols root.

yarn test
yarn test:ci
yarn coverage

Each package includes scripts to deploy and verify contracts on a specific network. You must provide the --network flag to specify the target network (e.g., sepolia).

Authentication: The account used for deployment and verification is derived from the PRIVATE_KEY environment variable defined in the .env file located in the repository root.

yarn deploy --network sepolia
yarn verify --network sepolia

Before running tests locally within the source/pool directory, you must ensure that the required artifacts are built. To do this, run the compilation command from the airswap-protocols project root.

1. Navigate to the airswap-protocols root directory.
2. Execute yarn compile to build the necessary artifacts.

Use the following commands to manage the SwapERC20 package. Note that environment variables should be configured in an .env file located in the repository root.

yarn           # Install dependencies
yarn clean      # Delete the contract build folder
yarn compile     # Compile all contracts to build folder
yarn coverage    # Report test coverage
yarn test        # Run all tests in test folder
yarn test:ci     # Run ci tests in test folder
yarn deploy --network <network_name> # Deploy on a network
yarn verify --network <network_name> # Verify on a network

The @airswap/utils package provides utility functions for AirSwap developers.

To use it in your project, install it via yarn:

yarn add @airswap/utils

Then, import the required functions into your TypeScript application. Common utilities include toDecimalString and toAtomicString for handling numeric conversions.

import { toDecimalString, toAtomicString } from '@airswap/utils';

To run tests for the BatchCall contract locally, follow these steps:

1. Build Artifacts: In the airswap-protocols project root, run yarn compile to ensure all required artifacts are built.
2. Start Local Blockchain: In a separate shell from the root repository, start a local blockchain instance using yarn ganache.
3. Execute Tests: Run yarn test from the root repository to execute the contract tests.

# Step 1: Build artifacts (from root)
yarn compile

# Step 2: Start blockchain (in a new shell)
yarn ganache

# Step 3: Run tests (from root)
yarn test

To run tests for the SwapERC20 package, you must first ensure that the required artifacts are built. Run yarn compile in the airswap-protocols project root before executing tests locally.

# Step 1: Build artifacts in the project root
yarn compile

# Step 2: Run tests in the swap-erc20 directory
yarn test

Use the following commands to manage the BatchCall package within the airswap-protocols repository:

• yarn: Install all necessary dependencies.
• yarn clean: Remove the contract build folder.
• yarn compile: Compile all contracts into the build folder.
• yarn test: Execute all contract tests located in the test folder.

Use the following commands to manage the @airswap/delegate-erc20 package. Note that environment variables must be configured in an .env file located in the repository root.

Dependency Management

• yarn: Install dependencies.
• yarn clean: Delete the contract build folder.

Compilation and Testing

• yarn compile: Compile all contracts to the build folder.
• yarn test: Run all tests in the test folder.
• yarn test:ci: Run CI tests in the test folder.
• yarn coverage: Report test coverage.

Note: Before running tests locally, you must run yarn compile in the airswap-protocols project root to build the required artifacts.

# Install dependencies
yarn

# Compile contracts
yarn compile

# Run tests
yarn test