@aztea/v3-core

1.0.0 • Public • Published

Local deployment

In order to deploy this code to a local testnet, you should install the npm package @forbitswap/v3-core and import the factory bytecode located at @forbitswap/v3-core/artifacts/contracts/ForbitswapV3Factory.sol/ForbitswapV3Factory.json. For example:

import {
  abi as FACTORY_ABI,
  bytecode as FACTORY_BYTECODE,
} from '@forbitswap/v3-core/artifacts/contracts/ForbitswapV3Factory.sol/ForbitswapV3Factory.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 forbitswap code will correctly interoperate with your local deployment.

Using solidity interfaces

The forbitswap v3 interfaces are available for import into solidity smart contracts via the npm artifact @forbitswap/v3-core, e.g.:

import '@forbitswap/v3-core/contracts/interfaces/IForbitswapV3Pool.sol';

contract MyContract {
  IForbitswapV3Pool pool;

  function doSomethingWithPool() {
    // pool.swap(...);
  }
}

Licensing

The primary license for forbitswap V3 Core is the Business Source License 1.1 (BUSL-1.1), see LICENSE.

Exceptions

  • All files in contracts/interfaces/ are licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see contracts/interfaces/LICENSE
  • Several files in contracts/libraries/ are licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see contracts/libraries/LICENSE_GPL
  • contracts/libraries/FullMath.sol is licensed under MIT (as indicated in its SPDX header), see contracts/libraries/LICENSE_MIT
  • All files in contracts/test remain unlicensed.

Install

DownloadsWeekly Downloads

4

Version

1.0.0

License

BUSL-1.1

Unpacked Size

425 kB

Total Files

76

Last publish

Collaborators

  • shayha