Superposition contracts

Security

Security instructions

Contributors

Contributors

Longtail

Longtail is Arbitrum's cheapest and most rewarding AMM.

Deployments

Superposition Testnet

Superposition RPC

AMM contract deployments

Leo contract deployments

Useful testing token deployments

Errors

Currently, to save on space, errors generated by the contract are terse. Decode the hex to the appropriate error in this table:

If more bytes are in the error, then the issue was produced by the ERC20 token. Convert any error types to their selector form to see.

Access graph

A publicly available graph for Longtail is available. It includes documentation. https://testnet-graph.long.so.

Building

Longtail ("Seawater") is a diamond-like contract, with the frontend to access the Stylus diamond facets implemented in Solidity. So, Stylus is needed with Rust for the implementation contracts, and Foundry is needed to compile the contract.

To save on contract size, and to reduce gas overhead, this contract stores the addresses of the swap router, and the admin address, at compile-time.

So these variables must set at compile-time, like so:

Build variables

Build dependencies

Build process

make build

Testing

Testing is done with via a hosted test using cargo features with the testing flag. tests.sh is provided to run both test suites.

End to end testing is currently unavailable due to issues with the deployment toolchain.

Testing process

./tests.sh

Cargo test tracing

Some of the cargo tests have optional logging, which might help with debugging. To see these logs, enable the testing-dbg-<test> feature and run the tests without capturing stdout, ie cargo test --features=testing,testing-dbg-erc20 -- --nocapture.

Testing tools are available with the with_storage macro, which lets you set slots and maximum balances for ERC20 transfers. Reproducing on-chain transactions is possible by using a tracer on the chain the transaciton took place, then examining the storage slots that were accessed (perhaps by looking at SLOADs), and setting it explicitly with the macro.

Deployment

You can deploy the contracts using the deploy.sh script.

Test deployments

Deployments on a local node can be done with ./test-deploy.sh for simplicity.

Deployment variables

Leo

Leo (also known as the Seawater Rewards Manager) is a contract that allows users to vest their LP tokens in the form of a transferFrom using the NFTManager contract. Leo remembers who owns the LP NFTs it has, and does things like collect fees on the behalf of the owner, and knows to do so when determining "real yield" mixed with fees earned for LPing.

IERC20

Git Source

Functions

transfer

function transfer(address recipient, uint256 amount) external;

Faucet

Git Source

Inherits: IFaucet

State Variables

operator_

operator to use to send the amounts on request.

address public operator_;

EMERGENCY_COUNCIL

emergency council to use to "rescue" the funds at any point.

address immutable EMERGENCY_COUNCIL;

tokens

IERC20[] public tokens;

amounts

uint256[] private amounts;

gasTokenAmount

uint256 private gasTokenAmount;

Functions

constructor

constructor(
    address _operator,
    address _emergencyCouncil,
    IERC20[] memory _tokens,
    uint256[] memory _amounts,
    uint256 _gasTokenAmount
);

receive

receive() external payable;

sendTo

sendTo the recipients given, with the amount being randomly chosen.

will break if there's not enough to send... by design.

function sendTo(FaucetReq[] calldata _requests) external;

changeOperator

function changeOperator(address _oldOperator, address _newOperator) external;

IERC165

Git Source

Functions

supportsInterface

Query if a contract implements an interface

Interface identification is specified in ERC-165. This function uses less than 30,000 gas.

function supportsInterface(bytes4 interfaceID) external view returns (bool);

Parameters

Returns

IERC20

Git Source

Interface of the ERC20 standard as defined in the EIP.

This includes the optional name, symbol, and decimals metadata.

Functions

totalSupply

Returns the amount of tokens in existence.

function totalSupply() external view returns (uint256);

balanceOf

Returns the amount of tokens owned by account.

function balanceOf(address account) external view returns (uint256);

transfer

Moves amount tokens from the caller's account to to.

function transfer(address to, uint256 amount) external returns (bool);

allowance

Returns the remaining number of tokens that spender is allowed to spend on behalf of owner

function allowance(address owner, address spender) external view returns (uint256);

approve

Sets amount as the allowance of spender over the caller's tokens.

Be aware of front-running risks: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729

function approve(address spender, uint256 amount) external returns (bool);

transferFrom

Moves amount tokens from from to to using the allowance mechanism. amount is then deducted from the caller's allowance.

function transferFrom(address from, address to, uint256 amount) external returns (bool);

name

Returns the name of the token.

function name() external view returns (string memory);

symbol

Returns the symbol of the token.

function symbol() external view returns (string memory);

decimals

Returns the decimals places of the token.

function decimals() external view returns (uint8);

Events

Transfer

Emitted when value tokens are moved from one account (from) to another (to).

event Transfer(address indexed from, address indexed to, uint256 value);

Approval

Emitted when the allowance of a spender for an owner is set, where value is the new allowance.

event Approval(address indexed owner, address indexed spender, uint256 value);

IERC721Metadata

Git Source

See https://eips.ethereum.org/EIPS/eip-721 Note: the ERC-165 identifier for this interface is 0x5b5e139f.

Functions

balanceOf

Count all NFTs assigned to an owner

NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address.

function balanceOf(address _owner) external view returns (uint256);

Parameters

Returns

ownerOf

Find the owner of an NFT

NFTs assigned to zero address are considered invalid, and queries about them do throw.

function ownerOf(uint256 _tokenId) external view returns (address);

Parameters

Returns

safeTransferFrom

Transfers the ownership of an NFT from one address to another address

Throws unless msg.sender is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT. When transfer is complete, this function checks if _to is a smart contract (code size > 0). If so, it calls onERC721Received on _to and throws if the return value is not bytes4(keccak256("onERC721Received(address,address,uint256,bytes)")).

function safeTransferFrom(address _from, address _to, uint256 _tokenId, bytes calldata data) external payable;

Parameters

safeTransferFrom

Transfers the ownership of an NFT from one address to another address

This works identically to the other function with an extra data parameter, except this function just sets data to "".

function safeTransferFrom(address _from, address _to, uint256 _tokenId) external payable;

Parameters

transferFrom

Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE TO CONFIRM THAT _to IS CAPABLE OF RECEIVING NFTS OR ELSE THEY MAY BE PERMANENTLY LOST

Throws unless msg.sender is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT.

function transferFrom(address _from, address _to, uint256 _tokenId) external payable;

Parameters

approve

Change or reaffirm the approved address for an NFT

The zero address indicates there is no approved address. Throws unless msg.sender is the current NFT owner, or an authorized operator of the current owner.

function approve(address _approved, uint256 _tokenId) external payable;

Parameters

setApprovalForAll

Enable or disable approval for a third party ("operator") to manage all of msg.sender's assets

Emits the ApprovalForAll event. The contract MUST allow multiple operators per owner.

function setApprovalForAll(address _operator, bool _approved) external;

Parameters

getApproved

Get the approved address for a single NFT

Throws if _tokenId is not a valid NFT.

function getApproved(uint256 _tokenId) external view returns (address);

Parameters

Returns

isApprovedForAll

Query if an address is an authorized operator for another address

function isApprovedForAll(address _owner, address _operator) external view returns (bool);

Parameters

Returns

name

A descriptive name for a collection of NFTs in this contract

function name() external view returns (string memory);

symbol

An abbreviated name for NFTs in this contract

function symbol() external view returns (string memory);

tokenURI

A distinct Uniform Resource Identifier (URI) for a given asset.

Throws if _tokenId is not a valid NFT. URIs are defined in RFC 3986. The URI may point to a JSON file that conforms to the "ERC721 Metadata JSON Schema".

function tokenURI(uint256) external view returns (string memory);

Events

Transfer

This emits when ownership of any NFT changes by any mechanism. This event emits when NFTs are created (from == 0) and destroyed (to == 0). Exception: during contract creation, any number of NFTs may be created and assigned without emitting Transfer. At the time of any transfer, the approved address for that NFT (if any) is reset to none.

event Transfer(address indexed _from, address indexed _to, uint256 indexed _tokenId);

Approval

This emits when the approved address for an NFT is changed or reaffirmed. The zero address indicates there is no approved address. When a Transfer event emits, this also indicates that the approved address for that NFT (if any) is reset to none.

event Approval(address indexed _owner, address indexed _approved, uint256 indexed _tokenId);

ApprovalForAll

This emits when an operator is enabled or disabled for an owner. The operator can manage all NFTs of the owner.

event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved);

IERC721TokenReceiver

Git Source

Functions

onERC721Received

Handle the receipt of an NFT

The ERC721 smart contract calls this function on the recipient after a transfer. This function MAY throw to revert and reject the transfer. Return of other than the magic value MUST result in the transaction being reverted. Note: the contract address is always the message sender.

function onERC721Received(address _operator, address _from, uint256 _tokenId, bytes calldata _data)
    external
    returns (bytes4);

Parameters

Returns

IFaucet

Git Source

Functions

sendTo

sendTo the recipients given, with the amount being randomly chosen.

will break if there's not enough to send... by design.

will break if it tries to send to a contract. The callee should verify that they're not being asked to send to contracts.

function sendTo(FaucetReq[] calldata _requests) external;

Structs

FaucetReq

struct FaucetReq {
    address recipient;
    bool isStaker;
}

ILeo

Git Source

Inherits: ILeoEvents

Functions

vestPosition

vest a position that the caller owns.

function vestPosition(address pool, uint256 id) external;

Parameters

createCampaign

create a campaign with the parameters given.

takes extraMax from the user of the token given

function createCampaign(
    bytes8 campaignId,
    address pool,
    int32 tickLower,
    int32 tickUpper,
    uint64 perSecond,
    address token,
    uint256 extraMax,
    uint64 starting,
    uint64 ending
) external;

Parameters

updateCampaign

create a campaign with the parameters given.

takes extraMax from the user of the token given

function updateCampaign(
    bytes8 campaignId,
    address pool,
    int32 tickLower,
    int32 tickUpper,
    uint64 perSecond,
    address token,
    uint256 extraMax,
    uint64 starting,
    uint64 ending
) external;

Parameters

campaignRevisions

the amount of times this campaign was modified for the pool

function campaignRevisions(address pool, bytes8 campaignId) external view returns (uint256);

Parameters

Returns

cancelCampaign

cancel an ongoing campaign by amending it to have 0

only usable by the admin of the pool

function cancelCampaign(address pool, bytes8 campaignId) external;

Parameters

campaignDetails

details of a campaign

function campaignDetails(address pool, bytes8 campaignId)
    external
    view
    returns (
        int32 tickLower,
        int32 tickUpper,
        uint64 perSecond,
        address token,
        uint256 distributed,
        uint256 maximum,
        uint64 startingTimestamp,
        uint64 endingTimestamp
    );

Parameters

poolLp

pool LP tokens vested to Leo for this pool

function poolLp(address pool) external returns (uint256 lp);

Parameters

Returns

collect

collect rewards for a position vested in a pool with the campaigns given

function collect(PositionDetails[] memory positionDetails, bytes8[] memory campaignIds)
    external
    returns (PoolRewards[] memory poolRewards, CampaignRewards[] memory campaignRewards);

Parameters

divestPosition

divest a position, returning the position ID to the user

function divestPosition(address pool, uint256 positionId) external;

Parameters

Structs

PositionDetails

struct PositionDetails {
    address token;
    uint256 id;
}

PoolRewards

struct PoolRewards {
    address pool;
    uint128 amount0Lp;
    uint128 amount1Lp;
}

CampaignRewards

struct CampaignRewards {
    address campaignToken;
    uint256 rewards;
}

ILeoEvents

Git Source

Events

CampaignBalanceUpdated

a campaign's balance was updated to reflect a new amount to give out max

event CampaignBalanceUpdated(bytes8 indexed identifier, uint256 indexed newMaximum);

Parameters

CampaignCreated

a campaign was created. Includes the details.

event CampaignCreated(
    bytes8 indexed identifier, address indexed pool, address indexed token, uint256 details, uint256 times
);

Parameters

CampaignUpdated

a campaign was updated. Includes the new settings.

event CampaignUpdated(bytes8 indexed identifier, address indexed pool, uint256 indexed perSecond, uint256 extras);

Parameters

PositionVested

a specific position was vested

event PositionVested(uint256 indexed positionId);

Parameters

PositionDivested

a specific position was just divested from Leo

event PositionDivested(uint256 indexed positionId);

Parameters

ISeawater

Git Source

Inherits: ISeawaterAMM

ISeawaterAMM

Git Source

Inherits: ISeawaterEvents, ISeawaterExecutorSwap, ISeawaterExecutorSwapPermit2, ISeawaterExecutorQuote, ISeawaterExecutorPosition, ISeawaterExecutorUpdatePosition, ISeawaterExecutorAdminExposed

Functions

swapIn32502CA71

swaps _token for USDC

function swapIn32502CA71(address _token, uint256 _amount, uint256 _minOut) external returns (int256, int256);

Parameters

Returns

swapInPermit2CEAAB576

swaps _token for USDC

function swapInPermit2CEAAB576(
    address _token,
    uint256 _amount,
    uint256 _minOut,
    uint256 _nonce,
    uint256 _deadline,
    uint256 _maxAmount,
    bytes memory _sig
) external returns (int256, int256);

Parameters

Returns

swapOut5E08A399

swaps USDC for _token

function swapOut5E08A399(address _token, uint256 _amount, uint256 _minOut) external returns (int256, int256);

Parameters

Returns

swapOutPermit23273373B

swaps USDC for _token

function swapOutPermit23273373B(
    address _token,
    uint256 _amount,
    uint256 _minOut,
    uint256 _nonce,
    uint256 _deadline,
    uint256 _maxAmount,
    bytes memory _sig
) external returns (int256, int256);

Parameters

Returns

swap2ExactIn41203F1D

swaps tokenA for tokenB

function swap2ExactIn41203F1D(address _tokenA, address _tokenB, uint256 _amount, uint256 _minOut)
    external
    returns (uint256, uint256);

Parameters

Returns

ISeawaterEvents

Git Source

Events

MintPosition

emitted when a new position is minted

event MintPosition(uint256 indexed id, address indexed owner, address indexed pool, int32 lower, int32 upper);

Parameters

BurnPosition

emitted when a position is burned

event BurnPosition(uint256 indexed id, address indexed owner);

Parameters

TransferPosition

emitted when a position changes owners

event TransferPosition(address indexed from, address indexed to, uint256 indexed id);

Parameters

UpdatePositionLiquidity

emitted when the liquidity in a position is changed.

event UpdatePositionLiquidity(uint256 indexed id, int256 token0, int256 token1);

Parameters

CollectFees

emitted when a liquidity provider collects the fees associated with a position

event CollectFees(uint256 indexed id, address indexed pool, address indexed to, uint128 amount0, uint128 amount1);

Parameters

NewPool

emitted when a new pool is created

event NewPool(address indexed token, uint32 indexed fee, uint8 decimals, uint8 tickSpacing);

Parameters

CollectProtocolFees

emitted when a protocol admin collects protocol fees

event CollectProtocolFees(address indexed pool, address indexed to, uint128 amount0, uint128 amount1);

Parameters

Swap2

emitted when a user swaps a nonfluid token for a nonfluid token (2-step swap)

event Swap2(
    address indexed user,
    address indexed from,
    address indexed to,
    uint256 amountIn,
    uint256 amountOut,
    uint256 fluidVolume,
    int32 finalTick0,
    int32 finalTick1
);

Parameters

Swap1

emitted when a user swaps a token for the pool's fluid token, or vice-versa

event Swap1(
    address indexed user, address indexed pool, bool zeroForOne, uint256 amount0, uint256 amount1, int32 finalTick
);

Parameters

NewFees

new fees were set!

event NewFees(address indexed pool, uint8 indexed feeProtocol);

Parameters

ISeawaterExecutorSwap

Git Source

Functions

swap904369BE

swaps within a pool

function swap904369BE(address pool, bool zeroForOne, int256 amount, uint256 priceLimit)
    external
    returns (int256, int256);

Parameters

Returns

swap2ExactIn41203F1D

performs a two stage swap across two pools

function swap2ExactIn41203F1D(address from, address to, uint256 amount, uint256 minOut)
    external
    returns (uint256, uint256);

Parameters

Returns

ISeawaterExecutorSwapPermit2

Git Source

Functions

swapPermit2EE84AD91

swaps within a pool using permit2 for token transfers

function swapPermit2EE84AD91(
    address pool,
    bool zeroForOne,
    int256 amount,
    uint256 priceLimit,
    uint256 nonce,
    uint256 deadline,
    uint256 maxAmount,
    bytes memory sig
) external returns (int256, int256);

Parameters

Returns

swap2ExactInPermit236B2FDD8

performs a two stage swap across two pools using permit2 for token transfers

permit2's max amount must be set to amount

function swap2ExactInPermit236B2FDD8(
    address from,
    address to,
    uint256 amount,
    uint256 minOut,
    uint256 nonce,
    uint256 deadline,
    bytes memory sig
) external returns (uint256, uint256);

Parameters

Returns

ISeawaterExecutorQuote

Git Source

Functions

quote72E2ADE7

reverts with the expected amount of fUSDC or pool token for a swap with the given parameters

always revert with Error(string(amountOut))

function quote72E2ADE7(address pool, bool zeroForOne, int256 amount, uint256 priceLimit) external;

Parameters

quote2CD06B86E

reverts with the expected amount of tokenOut for a 2-token swap with the given parameters

always revert with Error(string(amountOut))

function quote2CD06B86E(address from, address to, uint256 amount, uint256 minOut) external;

Parameters

ISeawaterExecutorPosition

Git Source

Functions

mintPositionBC5B086D

creates a new position

function mintPositionBC5B086D(address pool, int32 lower, int32 upper) external returns (uint256 id);

Parameters

transferPositionEEC7A3CD

transferPosition transfers a position. usable only by the NFT manager

function transferPositionEEC7A3CD(uint256 id, address from, address to) external;

Parameters

positionOwnerD7878480

gets the owner of a position

function positionOwnerD7878480(uint256 id) external returns (address);

Parameters

Returns

positionBalance4F32C7DB

gets the number of positions owned by a user

function positionBalance4F32C7DB(address user) external returns (uint256);

Parameters

Returns

positionLiquidity8D11C045

gets the amount of liquidity in a position

function positionLiquidity8D11C045(address pool, uint256 id) external returns (uint128);

Parameters

Returns

positionTickLower2F77CCE1

get the lower tick of the position id

function positionTickLower2F77CCE1(address pool, uint256 id) external returns (int32);

Parameters

Returns

positionTickUpper67FD55BA

get the upper tick of the position id

function positionTickUpper67FD55BA(address pool, uint256 id) external returns (int32);

Parameters

Returns

collectSingleTo6D76575F

collect a single position's yield

function collectSingleTo6D76575F(address pool, uint256 id, address recipient)
    external
    returns (uint128 amount0, uint128 amount1);

Parameters

Returns

collect7F21947C

collects fees from from positions

function collect7F21947C(address[] memory pools, uint256[] memory ids) external returns (CollectResult[] memory);

Parameters

Structs

CollectResult

struct CollectResult {
    uint128 amount0;
    uint128 amount1;
}

ISeawaterExecutorUpdatePosition

Git Source

Functions

updatePositionC7F1F740

refreshes a position's fees, and adds or removes liquidity

function updatePositionC7F1F740(address pool, uint256 id, int128 delta) external returns (int256, int256);

Parameters

Returns

incrPosD3521721

refreshes a position's fees, and adds liquidity, preventing less than the minimum from being taken.

function incrPosD3521721(
    address pool,
    uint256 id,
    uint256 amount0Min,
    uint256 amount1Min,
    uint256 amount0Desired,
    uint256 amount1Desired
) external returns (uint256, uint256);

Parameters

Returns

decrPosition09293696

refreshes a position's fees, and takes liquidity, preventing less than the minimum from being taken.

function decrPosition09293696(
    address pool,
    uint256 id,
    uint256 amount0Min,
    uint256 amount1Min,
    uint256 amount0Max,
    uint256 amount1Max
) external returns (uint256, uint256);

Parameters

Returns

ISeawaterExecutorAdminExposed

Git Source

contains just the admin functions that are exposed directly

Functions

createPoolD650E2D0

initialises a new pool. only usable by the seawater admin

function createPoolD650E2D0(
    address pool,
    uint256 sqrtPriceX96,
    uint32 fee,
    uint8 tickSpacing,
    uint128 maxLiquidityPerTick
) external;

Parameters

collectProtocol7540FA9F

collects protocol fees. only usable by the seawater admin

function collectProtocol7540FA9F(address pool, uint128 amount0, uint128 amount1, address recipient)
    external
    returns (uint128, uint128);

Parameters

Returns

feesOwed22F28DBD

feesOwed to a position ID given.

function feesOwed22F28DBD(address pool, uint256 id) external returns (uint128, uint128);

Parameters

Returns

sqrtPriceX967B8F5FC5

gets the current sqrt price of the pool

function sqrtPriceX967B8F5FC5(address pool) external returns (uint256);

Parameters

Returns

curTick181C6FD9

gets the currently used tick of the pool

function curTick181C6FD9(address pool) external returns (int32);

Parameters

Returns

tickSpacing653FE28F

gets the tick spacing of the pool

function tickSpacing653FE28F(address pool) external returns (uint8);

Parameters

Returns

feeBB3CF608

gets the fee for a specific pool

function feeBB3CF608(address pool) external returns (uint32);

Parameters

Returns

feeGrowthGlobal038B5665B

gets the fee growth for token 0

function feeGrowthGlobal038B5665B(address pool) external returns (uint256);

Parameters

Returns

feeGrowthGlobal1A33A5A1B

gets the fee growth for token 1

function feeGrowthGlobal1A33A5A1B(address pool) external returns (uint256);

Parameters

Returns

enablePool579DA658

enables or disables a pool

function enablePool579DA658(address pool, bool enabled) external;

Parameters

authoriseEnabler5B17C274

authorise an address to create and enable pools on its own

function authoriseEnabler5B17C274(address enabler, bool enabled) external;

Parameters

setSqrtPriceFF4DB98C

set the sqrt price for a pool in the event of misconfiguration.

function setSqrtPriceFF4DB98C(address pool, uint256 price) external;

Parameters

updateNftManager9BDF41F6

set the NFT manager.

function updateNftManager9BDF41F6(address manager) external;

Parameters

updateEmergencyCouncil7D0C1C58

updateEmergencyCouncil to a new address.

function updateEmergencyCouncil7D0C1C58(address newCouncil) external;

Parameters

ISeawaterExecutorAdmin

Git Source

Inherits: ISeawaterExecutorAdminExposed

Functions

ctor

constructor function

function ctor(address seawaterAdmin, address nftManager, address emergencyCouncil) external;

Parameters

ISeawaterExecutorFallback

Git Source

ISeawaterMigrations

Git Source

OwnershipNFTs

Git Source

Inherits: IERC721Metadata, IERC165

State Variables

SEAWATER

ISeawaterAMM public immutable SEAWATER;

TOKEN_URI

TOKEN_URI to set as the default token URI for every NFT

immutable in practice (not set anywhere)

string public TOKEN_URI;

name

name of the NFT, set by the constructor

string public name;

symbol

symbol of the NFT, set during the constructor

string public symbol;

getApproved_

getApproved that can spend the id of the tokens given

required in the NFT spec and we simplify the use here by naming the storage slot as such

mapping(uint256 => address) private getApproved_;

isApprovedForAll

Query if an address is an authorized operator for another address

mapping(address => mapping(address => bool)) public isApprovedForAll;

Functions

constructor

constructor(string memory _name, string memory _symbol, string memory _tokenURI, ISeawaterAMM _seawater);

ownerOf

Find the owner of an NFT

NFTs assigned to zero address are considered invalid, and queries about them do throw.

function ownerOf(uint256 _tokenId) public view returns (address);

Parameters

Returns

getApproved

Get the approved address for a single NFT

Throws if _tokenId is not a valid NFT.

function getApproved(uint256 _tokenId) external view returns (address);

Parameters

Returns

_onTransferReceived

_onTransferReceived by calling the callback onERC721Received in the recipient if they have codesize > 0. if the callback doesn't return the selector, revert!

function _onTransferReceived(address _sender, address _from, address _to, uint256 _tokenId) internal;

Parameters

_requireAuthorised

function _requireAuthorised(address _from, uint256 _tokenId) internal view;

_transfer

function _transfer(address _from, address _to, uint256 _tokenId) internal;

transferFrom

Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE TO CONFIRM THAT _to IS CAPABLE OF RECEIVING NFTS OR ELSE THEY MAY BE PERMANENTLY LOST

Throws unless msg.sender is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT.

function transferFrom(address _from, address _to, uint256 _tokenId) external payable;

Parameters

safeTransferFrom

Transfers the ownership of an NFT from one address to another address

Throws unless msg.sender is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT. When transfer is complete, this function checks if _to is a smart contract (code size > 0). If so, it calls onERC721Received on _to and throws if the return value is not bytes4(keccak256("onERC721Received(address,address,uint256,bytes)")).

function safeTransferFrom(address _from, address _to, uint256 _tokenId) external payable;

Parameters

safeTransferFrom

Transfers the ownership of an NFT from one address to another address

Throws unless msg.sender is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT. When transfer is complete, this function checks if _to is a smart contract (code size > 0). If so, it calls onERC721Received on _to and throws if the return value is not bytes4(keccak256("onERC721Received(address,address,uint256,bytes)")).

function safeTransferFrom(address _from, address _to, uint256 _tokenId, bytes calldata) external payable;

Parameters

approve

Change or reaffirm the approved address for an NFT

The zero address indicates there is no approved address. Throws unless msg.sender is the current NFT owner, or an authorized operator of the current owner.

function approve(address _approved, uint256 _tokenId) external payable;

Parameters

setApprovalForAll

Enable or disable approval for a third party ("operator") to manage all of msg.sender's assets

Emits the ApprovalForAll event. The contract MUST allow multiple operators per owner.

function setApprovalForAll(address _operator, bool _approved) external;

Parameters

balanceOf

Count all NFTs assigned to an owner

NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address.

function balanceOf(address _spender) external view returns (uint256);

Parameters

Returns

tokenURI

A distinct Uniform Resource Identifier (URI) for a given asset.

Throws if _tokenId is not a valid NFT. URIs are defined in RFC 3986. The URI may point to a JSON file that conforms to the "ERC721 Metadata JSON Schema".

function tokenURI(uint256) external view returns (string memory);

supportsInterface

Query if a contract implements an interface

Interface identification is specified in ERC-165. This function uses less than 30,000 gas.

function supportsInterface(bytes4 _interfaceId) external pure returns (bool);

Parameters

Returns

StorageSlot

Git Source

Functions

getAddressSlot

function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r);

Structs

AddressSlot

struct AddressSlot {
    address value;
}

SeawaterAMM

Git Source

Inherits: ISeawaterAMM

Functions

onlyProxyAdmin

modifier onlyProxyAdmin();

constructor

constructor function, sets proxy details and then forwards to the seawater initialiser

constructor(
    address _proxyAdmin,
    address _seawaterAdmin,
    address _nftManager,
    address _emergencyCouncil,
    ISeawaterExecutorSwap _executorSwap,
    ISeawaterExecutorSwapPermit2 _executorSwapPermit2,
    ISeawaterExecutorQuote _executorQuote,
    ISeawaterExecutorPosition _executorPosition,
    ISeawaterExecutorUpdatePosition _executorUpdatePosition,
    ISeawaterExecutorAdmin _executorAdmin,
    ISeawaterExecutorFallback _executorFallback
);

Parameters

updateProxyAdmin

updates the proxy admin. only usable by the proxy admin

function updateProxyAdmin(address newAdmin) public onlyProxyAdmin;

Parameters

updateExecutors

updates the addresses of the executors. only usable by the proxy admin

function updateExecutors(
    ISeawaterExecutorSwap executorSwap,
    ISeawaterExecutorSwapPermit2 executorSwapPermit2,
    ISeawaterExecutorQuote executorQuote,
    ISeawaterExecutorPosition executorPosition,
    ISeawaterExecutorUpdatePosition executorUpdatePosition,
    ISeawaterExecutorAdmin executorAdmin,
    ISeawaterExecutorFallback executorFallback
) public onlyProxyAdmin;

Parameters

directDelegate

function directDelegate(address to) internal;

createPoolD650E2D0

initialises a new pool. only usable by the seawater admin

function createPoolD650E2D0(address, uint256, uint32, uint8, uint128) external;

Parameters

collectProtocol7540FA9F

collects protocol fees. only usable by the seawater admin

function collectProtocol7540FA9F(address, uint128, uint128, address) external returns (uint128, uint128);

Parameters

Returns

enablePool579DA658

enables or disables a pool

function enablePool579DA658(address, bool) external;

Parameters

authoriseEnabler5B17C274

authorise an address to create and enable pools on its own

function authoriseEnabler5B17C274(address, bool) external;

Parameters

setSqrtPriceFF4DB98C

set the sqrt price for a pool in the event of misconfiguration.

function setSqrtPriceFF4DB98C(address, uint256) external;

Parameters

updateNftManager9BDF41F6

set the NFT manager.

function updateNftManager9BDF41F6(address) external;

Parameters

updateEmergencyCouncil7D0C1C58

updateEmergencyCouncil to a new address.

function updateEmergencyCouncil7D0C1C58(address) external;

Parameters

swap904369BE

swaps within a pool

function swap904369BE(address, bool, int256, uint256) external returns (int256, int256);

Parameters

Returns

quote72E2ADE7

reverts with the expected amount of fUSDC or pool token for a swap with the given parameters

function quote72E2ADE7(address, bool, int256, uint256) external;

Parameters

quote2CD06B86E

reverts with the expected amount of tokenOut for a 2-token swap with the given parameters

function quote2CD06B86E(address, address, uint256, uint256) external;

Parameters

swapPermit2EE84AD91

swaps within a pool using permit2 for token transfers

function swapPermit2EE84AD91(address, bool, int256, uint256, uint256, uint256, uint256, bytes memory)
    external
    returns (int256, int256);

Parameters

Returns

swap2ExactIn41203F1D

performs a two stage swap across two pools

function swap2ExactIn41203F1D(address, address, uint256, uint256) external returns (uint256, uint256);

Parameters

Returns

swap2ExactInPermit236B2FDD8

performs a two stage swap across two pools using permit2 for token transfers

function swap2ExactInPermit236B2FDD8(address, address, uint256, uint256, uint256, uint256, bytes memory)
    external
    returns (uint256, uint256);

Parameters

Returns

swapIn32502CA71

swaps _token for USDC

function swapIn32502CA71(address token, uint256 amountIn, uint256 minOut) external returns (int256, int256);

Parameters

Returns

swapInPermit2CEAAB576

swaps _token for USDC

function swapInPermit2CEAAB576(
    address token,
    uint256 amountIn,
    uint256 minOut,
    uint256 nonce,
    uint256 deadline,
    uint256 maxAmount,
    bytes memory sig
) external returns (int256, int256);

Parameters

Returns

swapOut5E08A399

swaps USDC for _token

function swapOut5E08A399(address token, uint256 amountIn, uint256 minOut) external returns (int256, int256);

Parameters

Returns

swapOutPermit23273373B

swaps USDC for _token

function swapOutPermit23273373B(
    address token,
    uint256 amountIn,
    uint256 minOut,
    uint256 nonce,
    uint256 deadline,
    uint256 maxAmount,
    bytes memory sig
) external returns (int256, int256);

Parameters

Returns

mintPositionBC5B086D

creates a new position

function mintPositionBC5B086D(address, int32, int32) external returns (uint256);

Parameters

positionOwnerD7878480

gets the owner of a position

function positionOwnerD7878480(uint256) external returns (address);

Parameters

Returns

transferPositionEEC7A3CD

transferPosition transfers a position. usable only by the NFT manager

function transferPositionEEC7A3CD(uint256, address, address) external;

Parameters

positionBalance4F32C7DB

gets the number of positions owned by a user

function positionBalance4F32C7DB(address) external returns (uint256);

Parameters

Returns

positionLiquidity8D11C045

gets the amount of liquidity in a position

function positionLiquidity8D11C045(address, uint256) external returns (uint128);

Parameters

Returns

positionTickLower2F77CCE1

get the lower tick of the position id

function positionTickLower2F77CCE1(address, uint256) external returns (int32);

Parameters

Returns

positionTickUpper67FD55BA

get the upper tick of the position id

function positionTickUpper67FD55BA(address, uint256) external returns (int32);

Parameters

Returns

sqrtPriceX967B8F5FC5

gets the current sqrt price of the pool

function sqrtPriceX967B8F5FC5(address) external returns (uint256);

Parameters

Returns

feesOwed22F28DBD

feesOwed to a position ID given.

function feesOwed22F28DBD(address, uint256) external returns (uint128, uint128);

Parameters

Returns

curTick181C6FD9

gets the currently used tick of the pool

function curTick181C6FD9(address) external returns (int32);

Parameters

Returns

tickSpacing653FE28F

gets the tick spacing of the pool

function tickSpacing653FE28F(address) external returns (uint8);

Parameters

Returns

feeBB3CF608

gets the fee for a specific pool

function feeBB3CF608(address) external returns (uint32);

Parameters

Returns

feeGrowthGlobal038B5665B

gets the fee growth for token 0

function feeGrowthGlobal038B5665B(address) external returns (uint256);

Parameters

Returns

feeGrowthGlobal1A33A5A1B

gets the fee growth for token 1

function feeGrowthGlobal1A33A5A1B(address) external returns (uint256);

Parameters

Returns

collectSingleTo6D76575F

collect a single position's yield

function collectSingleTo6D76575F(address, uint256, address) external returns (uint128, uint128);

Parameters

Returns

collect7F21947C

collects fees from from positions

function collect7F21947C(address[] memory, uint256[] memory) external returns (CollectResult[] memory);

Parameters

updatePositionC7F1F740

refreshes a position's fees, and adds or removes liquidity

function updatePositionC7F1F740(address, uint256, int128) external returns (int256, int256);

Parameters

Returns

incrPosD3521721

refreshes a position's fees, and adds liquidity, preventing less than the minimum from being taken.

function incrPosD3521721(address, uint256, uint256, uint256, uint256, uint256) external returns (uint256, uint256);

Parameters

Returns

decrPosition09293696

refreshes a position's fees, and takes liquidity, preventing less than the minimum from being taken.

function decrPosition09293696(address, uint256, uint256, uint256, uint256, uint256)
    external
    returns (uint256, uint256);

Parameters

Returns

fallback

fallback() external;

_getExecutorSwap

function _getExecutorSwap() internal view returns (address);

_getExecutorSwapPermit2

function _getExecutorSwapPermit2() internal view returns (address);

_getExecutorQuote

function _getExecutorQuote() internal view returns (address);

_getExecutorPosition

function _getExecutorPosition() internal view returns (address);

_getExecutorUpdatePosition

function _getExecutorUpdatePosition() internal view returns (address);

_getExecutorAdmin

function _getExecutorAdmin() internal view returns (address);

_getExecutorFallback

function _getExecutorFallback() internal view returns (address);

_setProxyAdmin

function _setProxyAdmin(address newAdmin) internal;

_setProxies

function _setProxies(
    ISeawaterExecutorSwap executorSwap,
    ISeawaterExecutorSwapPermit2 executorSwapPermit2,
    ISeawaterExecutorQuote executorQuote,
    ISeawaterExecutorPosition executorPosition,
    ISeawaterExecutorUpdatePosition executorUpdatePosition,
    ISeawaterExecutorAdmin executorAdmin,
    ISeawaterExecutorFallback executorFallback
) internal;

Constants

Git Source

EXECUTOR_SWAP_SLOT

0xb27456616f8c77c635d3551b8179f6887795e920c5c4421a6fa3c3c76fc90fa8

bytes32 constant EXECUTOR_SWAP_SLOT = bytes32(uint256(keccak256("seawater.impl.swap")) - 1);

EXECUTOR_SWAP_PERMIT2_SLOT

0x70879b7e5737e63f52eca3402c644a487e49ffeb7d78b75e54b18301a4f376ac

bytes32 constant EXECUTOR_SWAP_PERMIT2_SLOT = bytes32(uint256(keccak256("seawater.impl.swap_permit2")) - 1);

EXECUTOR_QUOTE_SLOT

0x031aae58aa658a4a607141f8a509c1b56789f013acaf58a8e12eb86456e099e4

bytes32 constant EXECUTOR_QUOTE_SLOT = bytes32(uint256(keccak256("seawater.impl.quote")) - 1);

EXECUTOR_POSITION_SLOT

0x75711a1f12071de4ad9b405fd0234f84fcd9d494050d3a5169de3ad4fd942476

bytes32 constant EXECUTOR_POSITION_SLOT = bytes32(uint256(keccak256("seawater.impl.position")) - 1);

EXECUTOR_UPDATE_POSITION_SLOT

0x81e9c7c70971b5eb969cec21a82e6deed42e7c6736e0e83ced66d72297d9f1d7

bytes32 constant EXECUTOR_UPDATE_POSITION_SLOT = bytes32(uint256(keccak256("seawater.impl.update_position")) - 1);

EXECUTOR_ADMIN_SLOT

0x344c13190645d452a52856ca1efc42b3609893d92b93219c8820b76f3aa11288

bytes32 constant EXECUTOR_ADMIN_SLOT = bytes32(uint256(keccak256("seawater.impl.admin")) - 1);

EXECUTOR_FALLBACK_SLOT

0xa77145850668b2edbbe1c458388a99e3dca3d62b8335520225dc4d03b2e2bfe0

bytes32 constant EXECUTOR_FALLBACK_SLOT = bytes32(uint256(keccak256("seawater.impl.fallback")) - 1);

PROXY_ADMIN_SLOT

bytes32 constant PROXY_ADMIN_SLOT = bytes32(uint256(keccak256("seawater.role.proxy.admin")) - 1);