Orbital

This repository contains the core smart contracts for Orbital, an automated market maker for pools of 2, 3, or 10,000 stablecoins.

Local deployment

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

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

Using solidity interfaces

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

import '@orbital-amm/orbital-core/contracts/interfaces/IOrbitalPool.sol';

contract MyContract {
  IOrbitalPool pool;

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

Development

Requires Foundry.

forge install
forge build

Testing

forge test