1.0.3 • Published 1 year ago

@ethaf/ethaf-periphery v1.0.3

Weekly downloads
-
License
GPL-2.0-or-later
Repository
github
Last release
1 year ago

ETH AF Periphery

Peripheral smart contracts for interacting with ETH AF

Tests Lint

This repository contains the periphery smart contracts for the ETH AF Protocol. For the lower level core contracts, see the ethaf-core repository.

Bug bounty

This repository is subject to the ETH AF bug bounty program, per the terms defined here.

Local deployment

In order to deploy this code to a local testnet, you should install the npm package @ethaf/ethaf-periphery and import bytecode imported from artifacts located at @ethaf/ethaf-periphery/artifacts/contracts/*/*.json. For example:

import {
  abi as SWAP_ROUTER_ABI,
  bytecode as SWAP_ROUTER_BYTECODE,
} from '@ethaf/ethaf-periphery/artifacts/contracts/SwapRouter.sol/SwapRouter.json'

// deploy the bytecode

This will ensure that you are testing against the same bytecode that is deployed to mainnet and public testnets, and all ETH AF code will correctly interoperate with your local deployment.

Using solidity interfaces

The ETH AF periphery interfaces are available for import into solidity smart contracts via the npm artifact @ethaf/ethaf-periphery, e.g.:

import '@ethaf/ethaf-periphery/contracts/interfaces/ISwapRouter.sol';

contract MyContract {
  ISwapRouter router;

  function doSomethingWithSwapRouter() {
    // router.exactInput(...);
  }
}