Superposition contracts

Security

Security instructions

Contributors

Contributors

Deployments

Superposition Mainnet

Superposition RPC

AMM contract deployments

Administrative deployments

Leo contract deployments

Token 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

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, address recipient) 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

cancelCampaign

cancel an ongoing campaign by amending it to have 0

only usable by the admin of the campaign

function cancelCampaign(address pool, bytes8 campaignId) external;

Parameters

campaignDetails

details of a campaign

function campaignDetails(bytes8 campaignId)
    external
    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, address recipient)
    external
    returns (CollectRewards memory collectRewards);

Parameters

divestPosition

divest a position, returning the position ID to the user

function divestPosition(uint256 positionId, address recipient) external;

Parameters

Structs

PositionDetails

struct PositionDetails {
    address token;
    uint256 id;
}

PoolRewards

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

CampaignRewards

struct CampaignRewards {
    uint256 positionId;
    address campaignToken;
    uint256 rewards;
}

CollectRewards

struct CollectRewards {
    PoolRewards[] poolRewards;
    CampaignRewards[] campaignRewards;
}

ILeoEvents

Git Source

Events

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

PositionVested2

a specific position was vested

event PositionVested2(uint256 indexed positionId, address indexed owner);

Parameters

PositionDivested2

a specific position was just divested from Leo

event PositionDivested2(uint256 indexed positionId, address indexed recipient);

Parameters

ISeawater

Git Source

Inherits: ISeawaterAMM

ISeawaterAMM

Git Source

Inherits: ISeawaterEvents, ISeawaterExecutorSwapA, ISeawaterExecutorSwapPermit2A, ISeawaterExecutorQuoteA, ISeawaterExecutorPosition, ISeawaterExecutorUpdatePosition, ISeawaterExecutorAdminExposed, ISeawaterExecutorAdjustPositionA, ISeawaterExecutorSwapPermit2B, ISeawaterExecutorAdjustPositionB, ISeawaterExecutorSwapB, ISeawaterExecutorQuoteB

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

swap2ExactInED91BB1D

swaps tokenA for tokenB

function swap2ExactInED91BB1D(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

ISeawaterExecutorSwapA

Git Source

Functions

swap904369BE

swaps within a pool

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

Parameters

Returns

ISeawaterExecutorSwapPermit2A

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

ISeawaterExecutorSwapPermit2B

Git Source

Functions

swap2ExactInPermit254A7DBB1

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

permit2's max amount must be set to amount

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

Parameters

Returns

ISeawaterExecutorQuoteA

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

ISeawaterExecutorQuoteB

Git Source

Functions

quote2A9EFFCC6

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

always revert with Error(string(amountOut))

function quote2A9EFFCC6(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

ISeawaterExecutorAdminExposed

Git Source

contains just the admin functions that are exposed directly

Functions

createPool653F395E

initialises a new pool. only usable by the seawater admin

function createPool653F395E(address pool, uint256 sqrtPriceX96, uint32 fee) 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

setFeeProtocolCBD3EC35

function setFeeProtocolCBD3EC35(address pool, uint8 feeProtocol0, uint8 feeProtocol1) external;

updateNftManager9BDF41F6

set the NFT manager.

function updateNftManager9BDF41F6(address manager) external;

Parameters

updateSeawaterAdminD25D364D

set the new admin.

function updateSeawaterAdminD25D364D(address operator) external;

Parameters

updateEmergencyCouncil7D0C1C58

updateEmergencyCouncil to a new address.

function updateEmergencyCouncil7D0C1C58(address newCouncil) external;

Parameters

ISeawaterExecutorSwapB

Git Source

Functions

swap2ExactInED91BB1D

performs a two stage swap across two pools

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

Parameters

Returns

ISeawaterExecutorAdmin

Git Source

Inherits: ISeawaterExecutorAdminExposed

Functions

ctor

constructor function

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

Parameters

ISeawaterExecutorAdjustPositionA

Git Source

Functions

incrPositionE2437399

refreshes and takes a position's fees, and returns liquidity, preventing less than the minimum from being taken to be sent to the user.

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

Parameters

Returns

ISeawaterExecutorAdjustPositionB

Git Source

Functions

decrPosition9A7D32E2

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

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

Parameters

Returns

ISeawaterExecutorFallback

Git Source

ISeawaterMigrations

Git Source

StorageSlot

Git Source

Functions

getAddressSlot

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

Structs

AddressSlot

struct AddressSlot {
    address value;
}

LeoCtor

Git Source

Functions

ctor

function ctor(address) external;

LeoProxy

Git Source

Inherits: ILeo

Functions

directDelegate

function directDelegate(address to) internal;

constructor

constructor(address _admin, address _collect, address _extras, address _emergency);

createCampaign

create a campaign with the parameters given.

takes extraMax from the user of the token given

function createCampaign(bytes8, address, int32, int32, uint64, address, uint256, uint64, uint64) external;

Parameters

upgrade

function upgrade(address _collect, address _extras) external;

campaignDetails

details of a campaign

function campaignDetails(bytes8) external returns (int32, int32, uint64, address, uint256, uint256, uint64, uint64);

Parameters

cancelCampaign

cancel an ongoing campaign by amending it to have 0

only usable by the admin of the campaign

function cancelCampaign(address, bytes8) external;

Parameters

poolLp

pool LP tokens vested to Leo for this pool

function poolLp(address) external returns (uint256);

Parameters

Returns

collect

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

function collect(PositionDetails[] memory, bytes8[] memory, address) external returns (CollectRewards memory);

Parameters

vestPosition

vest a position that the caller owns.

function vestPosition(address, uint256, address) external;

Parameters

divestPosition

divest a position, returning the position ID to the user

function divestPosition(uint256, address) external;

Parameters

Events

AdminChanged

event AdminChanged(address indexed oldAdmin, address indexed newAdmin);

Upgraded

event Upgraded(address indexed extras, address indexed collect);

Constants

Git Source

ADMIN_SLOT

bytes32 constant ADMIN_SLOT = bytes32(uint256(keccak256("eip1967.proxy.admin")) - 1);

EXTRAS_SLOT

0x265c22645a278354f32cb66e6ace5ae683d2e0f04117019dbeb0727f85f1690e

bytes32 constant EXTRAS_SLOT = bytes32(uint256(keccak256("leo.impl.extras")) - 1);

COLLECT_SLOT

0x5f9cf5b10fe99c3929b5aaee8330476b5fdcda9bd9a0df70532d2c68fe1683a9

bytes32 constant COLLECT_SLOT = bytes32(uint256(keccak256("leo.impl.collect")) - 1);

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

IEIP712

Git Source

Functions

DOMAIN_SEPARATOR

function DOMAIN_SEPARATOR() external view returns (bytes32);

ISignatureTransfer

Git Source

Inherits: IEIP712

Handles ERC20 token transfers through signature based actions

Requires user's token approval on the Permit2 contract

Functions

nonceBitmap

A map from token owner address and a caller specified word index to a bitmap. Used to set bits in the bitmap to prevent against signature replay protection

Uses unordered nonces so that permit messages do not need to be spent in a certain order

The mapping is indexed first by the token owner, then by an index specified in the nonce

It returns a uint256 bitmap

The index, or wordPosition is capped at type(uint248).max

function nonceBitmap(address, uint256) external view returns (uint256);

permitTransferFrom

Transfers a token using a signed permit message

Reverts if the requested amount is greater than the permitted signed amount

function permitTransferFrom(
    PermitTransferFrom memory permit,
    SignatureTransferDetails calldata transferDetails,
    address owner,
    bytes calldata signature
) external;

Parameters

permitWitnessTransferFrom

Transfers a token using a signed permit message

Includes extra data provided by the caller to verify signature over

The witness type string must follow EIP712 ordering of nested structs and must include the TokenPermissions type definition

Reverts if the requested amount is greater than the permitted signed amount

function permitWitnessTransferFrom(
    PermitTransferFrom memory permit,
    SignatureTransferDetails calldata transferDetails,
    address owner,
    bytes32 witness,
    string calldata witnessTypeString,
    bytes calldata signature
) external;

Parameters

permitTransferFrom

Transfers multiple tokens using a signed permit message

function permitTransferFrom(
    PermitBatchTransferFrom memory permit,
    SignatureTransferDetails[] calldata transferDetails,
    address owner,
    bytes calldata signature
) external;

Parameters

permitWitnessTransferFrom

Transfers multiple tokens using a signed permit message

Includes extra data provided by the caller to verify signature over

The witness type string must follow EIP712 ordering of nested structs and must include the TokenPermissions type definition

function permitWitnessTransferFrom(
    PermitBatchTransferFrom memory permit,
    SignatureTransferDetails[] calldata transferDetails,
    address owner,
    bytes32 witness,
    string calldata witnessTypeString,
    bytes calldata signature
) external;

Parameters

invalidateUnorderedNonces

Invalidates the bits specified in mask for the bitmap at the word position

The wordPos is maxed at type(uint248).max

function invalidateUnorderedNonces(uint256 wordPos, uint256 mask) external;

Parameters

Events

UnorderedNonceInvalidation

Emits an event when the owner successfully invalidates an unordered nonce.

event UnorderedNonceInvalidation(address indexed owner, uint256 word, uint256 mask);

Errors

InvalidAmount

Thrown when the requested amount for a transfer is larger than the permissioned amount

error InvalidAmount(uint256 maxAmount);

Parameters

LengthMismatch

Thrown when the number of tokens permissioned to a spender does not match the number of tokens being transferred

If the spender does not need to transfer the number of tokens permitted, the spender can request amount 0 to be transferred

error LengthMismatch();

Structs

TokenPermissions

The token and amount details for a transfer signed in the permit transfer signature

struct TokenPermissions {
    address token;
    uint256 amount;
}

PermitTransferFrom

The signed permit message for a single token transfer

struct PermitTransferFrom {
    TokenPermissions permitted;
    uint256 nonce;
    uint256 deadline;
}

SignatureTransferDetails

Specifies the recipient address and amount for batched transfers.

Recipients and amounts correspond to the index of the signed token permissions array.

Reverts if the requested amount is greater than the permitted signed amount.

struct SignatureTransferDetails {
    address to;
    uint256 requestedAmount;
}

PermitBatchTransferFrom

Used to reconstruct the signed permit message for multiple token transfers

Do not need to pass in spender address as it is required that it is msg.sender

Note that a user still signs over a spender address

struct PermitBatchTransferFrom {
    TokenPermissions[] permitted;
    uint256 nonce;
    uint256 deadline;
}

SignatureExpired

Git Source

Shared errors between signature based transfers and allowance based transfers.

Thrown when validating an inputted signature that is stale

error SignatureExpired(uint256 signatureDeadline);

Parameters

InvalidNonce

Git Source

Thrown when validating that the inputted nonce has not been used

error InvalidNonce();

ERC20

Git Source

Authors: Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC20.sol), Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol)

Modern and gas efficient ERC20 + EIP-2612 implementation.

Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it.

State Variables

name

string public name;

symbol

string public symbol;

decimals

uint8 public immutable decimals;

totalSupply

uint256 public totalSupply;

balanceOf

mapping(address => uint256) public balanceOf;

allowance

mapping(address => mapping(address => uint256)) public allowance;

INITIAL_CHAIN_ID

uint256 internal immutable INITIAL_CHAIN_ID;

INITIAL_DOMAIN_SEPARATOR

bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR;

nonces

mapping(address => uint256) public nonces;

Functions

constructor

constructor(string memory _name, string memory _symbol, uint8 _decimals);

approve

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

transfer

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

transferFrom

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

permit

function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s)
    public
    virtual;

DOMAIN_SEPARATOR

function DOMAIN_SEPARATOR() public view virtual returns (bytes32);

computeDomainSeparator

function computeDomainSeparator() internal view virtual returns (bytes32);

_mint

function _mint(address to, uint256 amount) internal virtual;

_burn

function _burn(address from, uint256 amount) internal virtual;

Events

Transfer

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

Approval

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

SafeTransferLib

Git Source

Author: Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/SafeTransferLib.sol)

Safe ETH and ERC20 transfer library that gracefully handles missing return values.

Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer.

Note that none of the functions in this library check that a token has code at all! That responsibility is delegated to the caller.

Functions

safeTransferETH

function safeTransferETH(address to, uint256 amount) internal;

safeTransferFrom

function safeTransferFrom(ERC20 token, address from, address to, uint256 amount) internal;

safeTransfer

function safeTransfer(ERC20 token, address to, uint256 amount) internal;

safeApprove

function safeApprove(ERC20 token, address to, uint256 amount) internal;

IERC1271

Git Source

Functions

isValidSignature

Should return whether the signature provided is valid for the provided data

function isValidSignature(bytes32 hash, bytes memory signature) external view returns (bytes4 magicValue);

Parameters

Returns

SignatureVerification

Git Source

State Variables

UPPER_BIT_MASK

bytes32 constant UPPER_BIT_MASK = (0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);

Functions

verify

function verify(bytes calldata signature, bytes32 hash, address claimedSigner) internal view;

Errors

InvalidSignatureLength

Thrown when the passed in signature is not a valid length

error InvalidSignatureLength();

InvalidSignature

Thrown when the recovered signer is equal to the zero address

error InvalidSignature();

InvalidSigner

Thrown when the recovered signer does not equal the claimedSigner

error InvalidSigner();

InvalidContractSignature

Thrown when the recovered contract signature is incorrect

error InvalidContractSignature();

IAllowanceTransfer

Git Source

Inherits: IEIP712

Handles ERC20 token permissions through signature based allowance setting and ERC20 token transfers by checking allowed amounts

Requires user's token approval on the Permit2 contract

Functions

allowance

A mapping from owner address to token address to spender address to PackedAllowance struct, which contains details and conditions of the approval.

The mapping is indexed in the above order see: allowance[ownerAddress][tokenAddress][spenderAddress]

The packed slot holds the allowed amount, expiration at which the allowed amount is no longer valid, and current nonce thats updated on any signature based approvals.

function allowance(address user, address token, address spender)
    external
    view
    returns (uint160 amount, uint48 expiration, uint48 nonce);

approve

Approves the spender to use up to amount of the specified token up until the expiration

The packed allowance also holds a nonce, which will stay unchanged in approve

Setting amount to type(uint160).max sets an unlimited approval

function approve(address token, address spender, uint160 amount, uint48 expiration) external;

Parameters

permit

Permit a spender to a given amount of the owners token via the owner's EIP-712 signature

May fail if the owner's nonce was invalidated in-flight by invalidateNonce

function permit(address owner, PermitSingle memory permitSingle, bytes calldata signature) external;

Parameters

permit

Permit a spender to the signed amounts of the owners tokens via the owner's EIP-712 signature

May fail if the owner's nonce was invalidated in-flight by invalidateNonce

function permit(address owner, PermitBatch memory permitBatch, bytes calldata signature) external;

Parameters

transferFrom

Transfer approved tokens from one address to another

Requires the from address to have approved at least the desired amount of tokens to msg.sender.

function transferFrom(address from, address to, uint160 amount, address token) external;

Parameters

transferFrom

Transfer approved tokens in a batch

Requires the from addresses to have approved at least the desired amount of tokens to msg.sender.

function transferFrom(AllowanceTransferDetails[] calldata transferDetails) external;

Parameters

lockdown

Enables performing a "lockdown" of the sender's Permit2 identity by batch revoking approvals

function lockdown(TokenSpenderPair[] calldata approvals) external;

Parameters

invalidateNonces

Invalidate nonces for a given (token, spender) pair

Can't invalidate more than 2**16 nonces per transaction.

function invalidateNonces(address token, address spender, uint48 newNonce) external;

Parameters

Events

NonceInvalidation

Emits an event when the owner successfully invalidates an ordered nonce.

event NonceInvalidation(
    address indexed owner, address indexed token, address indexed spender, uint48 newNonce, uint48 oldNonce
);

Approval

Emits an event when the owner successfully sets permissions on a token for the spender.

event Approval(
    address indexed owner, address indexed token, address indexed spender, uint160 amount, uint48 expiration
);

Permit

Emits an event when the owner successfully sets permissions using a permit signature on a token for the spender.

event Permit(
    address indexed owner,
    address indexed token,
    address indexed spender,
    uint160 amount,
    uint48 expiration,
    uint48 nonce
);

Lockdown

Emits an event when the owner sets the allowance back to 0 with the lockdown function.

event Lockdown(address indexed owner, address token, address spender);

Errors

AllowanceExpired

Thrown when an allowance on a token has expired.

error AllowanceExpired(uint256 deadline);

Parameters

InsufficientAllowance

Thrown when an allowance on a token has been depleted.

error InsufficientAllowance(uint256 amount);

Parameters

ExcessiveInvalidation

Thrown when too many nonces are invalidated.

error ExcessiveInvalidation();

Structs

PermitDetails

The permit data for a token

struct PermitDetails {
    address token;
    uint160 amount;
    uint48 expiration;
    uint48 nonce;
}

PermitSingle

The permit message signed for a single token allowance

struct PermitSingle {
    PermitDetails details;
    address spender;
    uint256 sigDeadline;
}

PermitBatch

The permit message signed for multiple token allowances

struct PermitBatch {
    PermitDetails[] details;
    address spender;
    uint256 sigDeadline;
}

PackedAllowance

The saved permissions

This info is saved per owner, per token, per spender and all signed over in the permit message

Setting amount to type(uint160).max sets an unlimited approval

struct PackedAllowance {
    uint160 amount;
    uint48 expiration;
    uint48 nonce;
}

TokenSpenderPair

A token spender pair.

struct TokenSpenderPair {
    address token;
    address spender;
}

AllowanceTransferDetails

Details for a token transfer.

struct AllowanceTransferDetails {
    address from;
    address to;
    uint160 amount;
    address token;
}

PermitHash

Git Source

State Variables

_PERMIT_DETAILS_TYPEHASH

bytes32 public constant _PERMIT_DETAILS_TYPEHASH =
    keccak256("PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)");

_PERMIT_SINGLE_TYPEHASH

bytes32 public constant _PERMIT_SINGLE_TYPEHASH = keccak256(
    "PermitSingle(PermitDetails details,address spender,uint256 sigDeadline)PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)"
);

_PERMIT_BATCH_TYPEHASH

bytes32 public constant _PERMIT_BATCH_TYPEHASH = keccak256(
    "PermitBatch(PermitDetails[] details,address spender,uint256 sigDeadline)PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)"
);

_TOKEN_PERMISSIONS_TYPEHASH

bytes32 public constant _TOKEN_PERMISSIONS_TYPEHASH = keccak256("TokenPermissions(address token,uint256 amount)");

_PERMIT_TRANSFER_FROM_TYPEHASH

bytes32 public constant _PERMIT_TRANSFER_FROM_TYPEHASH = keccak256(
    "PermitTransferFrom(TokenPermissions permitted,address spender,uint256 nonce,uint256 deadline)TokenPermissions(address token,uint256 amount)"
);

_PERMIT_BATCH_TRANSFER_FROM_TYPEHASH

bytes32 public constant _PERMIT_BATCH_TRANSFER_FROM_TYPEHASH = keccak256(
    "PermitBatchTransferFrom(TokenPermissions[] permitted,address spender,uint256 nonce,uint256 deadline)TokenPermissions(address token,uint256 amount)"
);

_TOKEN_PERMISSIONS_TYPESTRING

string public constant _TOKEN_PERMISSIONS_TYPESTRING = "TokenPermissions(address token,uint256 amount)";

_PERMIT_TRANSFER_FROM_WITNESS_TYPEHASH_STUB

string public constant _PERMIT_TRANSFER_FROM_WITNESS_TYPEHASH_STUB =
    "PermitWitnessTransferFrom(TokenPermissions permitted,address spender,uint256 nonce,uint256 deadline,";

_PERMIT_BATCH_WITNESS_TRANSFER_FROM_TYPEHASH_STUB

string public constant _PERMIT_BATCH_WITNESS_TRANSFER_FROM_TYPEHASH_STUB =
    "PermitBatchWitnessTransferFrom(TokenPermissions[] permitted,address spender,uint256 nonce,uint256 deadline,";

Functions

hash

function hash(IAllowanceTransfer.PermitSingle memory permitSingle) internal pure returns (bytes32);

hash

function hash(IAllowanceTransfer.PermitBatch memory permitBatch) internal pure returns (bytes32);

hash

function hash(ISignatureTransfer.PermitTransferFrom memory permit) internal view returns (bytes32);

hash

function hash(ISignatureTransfer.PermitBatchTransferFrom memory permit) internal view returns (bytes32);

hashWithWitness

function hashWithWitness(
    ISignatureTransfer.PermitTransferFrom memory permit,
    bytes32 witness,
    string calldata witnessTypeString
) internal view returns (bytes32);

hashWithWitness

function hashWithWitness(
    ISignatureTransfer.PermitBatchTransferFrom memory permit,
    bytes32 witness,
    string calldata witnessTypeString
) internal view returns (bytes32);

_hashPermitDetails

function _hashPermitDetails(IAllowanceTransfer.PermitDetails memory details) private pure returns (bytes32);

_hashTokenPermissions

function _hashTokenPermissions(ISignatureTransfer.TokenPermissions memory permitted) private pure returns (bytes32);

EIP712

Git Source

Inherits: IEIP712

EIP712 helpers for permit2

Maintains cross-chain replay protection in the event of a fork

Reference: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/cryptography/EIP712.sol

State Variables

_CACHED_DOMAIN_SEPARATOR

bytes32 private immutable _CACHED_DOMAIN_SEPARATOR;

_CACHED_CHAIN_ID

uint256 private immutable _CACHED_CHAIN_ID;

_HASHED_NAME

bytes32 private constant _HASHED_NAME = keccak256("Permit2");

_TYPE_HASH

bytes32 private constant _TYPE_HASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)");

Functions

constructor

constructor();

DOMAIN_SEPARATOR

Returns the domain separator for the current chain.

Uses cached version if chainid and address are unchanged from construction.

function DOMAIN_SEPARATOR() public view override returns (bytes32);

_buildDomainSeparator

Builds a domain separator using the current chainId and contract address.

function _buildDomainSeparator(bytes32 typeHash, bytes32 nameHash) private view returns (bytes32);

_hashTypedData

Creates an EIP-712 typed data hash

function _hashTypedData(bytes32 dataHash) internal view returns (bytes32);

SignatureTransfer

Git Source

Inherits: ISignatureTransfer, EIP712

State Variables

nonceBitmap

A map from token owner address and a caller specified word index to a bitmap. Used to set bits in the bitmap to prevent against signature replay protection

Uses unordered nonces so that permit messages do not need to be spent in a certain order

mapping(address => mapping(uint256 => uint256)) public nonceBitmap;

Functions

permitTransferFrom

Transfers a token using a signed permit message

Reverts if the requested amount is greater than the permitted signed amount

function permitTransferFrom(
    PermitTransferFrom memory permit,
    SignatureTransferDetails calldata transferDetails,
    address owner,
    bytes calldata signature
) external;

Parameters

permitWitnessTransferFrom

Transfers a token using a signed permit message

The witness type string must follow EIP712 ordering of nested structs and must include the TokenPermissions type definition

function permitWitnessTransferFrom(
    PermitTransferFrom memory permit,
    SignatureTransferDetails calldata transferDetails,
    address owner,
    bytes32 witness,
    string calldata witnessTypeString,
    bytes calldata signature
) external;

Parameters

_permitTransferFrom

Transfers a token using a signed permit message.

function _permitTransferFrom(
    PermitTransferFrom memory permit,
    SignatureTransferDetails calldata transferDetails,
    address owner,
    bytes32 dataHash,
    bytes calldata signature
) private;

Parameters

permitTransferFrom

Transfers a token using a signed permit message

Reverts if the requested amount is greater than the permitted signed amount

function permitTransferFrom(
    PermitBatchTransferFrom memory permit,
    SignatureTransferDetails[] calldata transferDetails,
    address owner,
    bytes calldata signature
) external;

Parameters

permitWitnessTransferFrom

Transfers a token using a signed permit message

The witness type string must follow EIP712 ordering of nested structs and must include the TokenPermissions type definition

function permitWitnessTransferFrom(
    PermitBatchTransferFrom memory permit,
    SignatureTransferDetails[] calldata transferDetails,
    address owner,
    bytes32 witness,
    string calldata witnessTypeString,
    bytes calldata signature
) external;

Parameters

_permitTransferFrom

Transfers tokens using a signed permit messages

function _permitTransferFrom(
    PermitBatchTransferFrom memory permit,
    SignatureTransferDetails[] calldata transferDetails,
    address owner,
    bytes32 dataHash,
    bytes calldata signature
) private;

Parameters

invalidateUnorderedNonces

Invalidates the bits specified in mask for the bitmap at the word position

The wordPos is maxed at type(uint248).max

function invalidateUnorderedNonces(uint256 wordPos, uint256 mask) external;

Parameters

bitmapPositions

Returns the index of the bitmap and the bit position within the bitmap. Used for unordered nonces

The first 248 bits of the nonce value is the index of the desired bitmap

The last 8 bits of the nonce value is the position of the bit in the bitmap

function bitmapPositions(uint256 nonce) private pure returns (uint256 wordPos, uint256 bitPos);

Parameters

Returns

_useUnorderedNonce

Checks whether a nonce is taken and sets the bit at the bit position in the bitmap at the word position

function _useUnorderedNonce(address from, uint256 nonce) internal;

Parameters

Allowance

Git Source

State Variables

BLOCK_TIMESTAMP_EXPIRATION

uint256 private constant BLOCK_TIMESTAMP_EXPIRATION = 0;

Functions

updateAll

Sets the allowed amount, expiry, and nonce of the spender's permissions on owner's token.

Nonce is incremented.

If the inputted expiration is 0, the stored expiration is set to block.timestamp

function updateAll(IAllowanceTransfer.PackedAllowance storage allowed, uint160 amount, uint48 expiration, uint48 nonce)
    internal;

updateAmountAndExpiration

Sets the allowed amount and expiry of the spender's permissions on owner's token.

Nonce does not need to be incremented.

function updateAmountAndExpiration(
    IAllowanceTransfer.PackedAllowance storage allowed,
    uint160 amount,
    uint48 expiration
) internal;

pack

Computes the packed slot of the amount, expiration, and nonce that make up PackedAllowance

function pack(uint160 amount, uint48 expiration, uint48 nonce) internal pure returns (uint256 word);

AllowanceTransfer

Git Source

Inherits: IAllowanceTransfer, EIP712

State Variables

allowance

Maps users to tokens to spender addresses and information about the approval on the token

Indexed in the order of token owner address, token address, spender address

The stored word saves the allowed amount, expiration on the allowance, and nonce

mapping(address => mapping(address => mapping(address => PackedAllowance))) public allowance;

Functions

approve

Approves the spender to use up to amount of the specified token up until the expiration

The packed allowance also holds a nonce, which will stay unchanged in approve

function approve(address token, address spender, uint160 amount, uint48 expiration) external;

Parameters

permit

Permit a spender to a given amount of the owners token via the owner's EIP-712 signature

May fail if the owner's nonce was invalidated in-flight by invalidateNonce

function permit(address owner, PermitSingle memory permitSingle, bytes calldata signature) external;

Parameters

permit

Permit a spender to a given amount of the owners token via the owner's EIP-712 signature

May fail if the owner's nonce was invalidated in-flight by invalidateNonce

function permit(address owner, PermitBatch memory permitBatch, bytes calldata signature) external;

Parameters

transferFrom

Transfer approved tokens from one address to another

Requires the from address to have approved at least the desired amount of tokens to msg.sender.

function transferFrom(address from, address to, uint160 amount, address token) external;

Parameters

transferFrom

Transfer approved tokens from one address to another

Requires the from address to have approved at least the desired amount of tokens to msg.sender.

function transferFrom(AllowanceTransferDetails[] calldata transferDetails) external;

Parameters

_transfer

Internal function for transferring tokens using stored allowances

Will fail if the allowed timeframe has passed

function _transfer(address from, address to, uint160 amount, address token) private;

lockdown

Enables performing a "lockdown" of the sender's Permit2 identity by batch revoking approvals

function lockdown(TokenSpenderPair[] calldata approvals) external;

Parameters

invalidateNonces

Invalidate nonces for a given (token, spender) pair

Can't invalidate more than 2**16 nonces per transaction.

function invalidateNonces(address token, address spender, uint48 newNonce) external;

Parameters

_updateApproval

Sets the new values for amount, expiration, and nonce.

Will check that the signed nonce is equal to the current nonce and then incrememnt the nonce value by 1.

Emits a Permit event.

function _updateApproval(PermitDetails memory details, address owner, address spender) private;

Permit2

Git Source

Inherits: SignatureTransfer, AllowanceTransfer

Permit2 handles signature-based transfers in SignatureTransfer and allowance-based transfers in AllowanceTransfer.

Users must approve Permit2 before calling any of the transfer functions.

PositionHandler

Git Source

State Variables

LONGTAIL

ISeawaterAMM immutable LONGTAIL;

LEO

ILeo immutable LEO;

NFT_MANAGER

OwnershipNFTs immutable NFT_MANAGER;

FUSDC

IERC20 immutable FUSDC;

Functions

constructor

constructor(ISeawaterAMM longtail, ILeo leo, OwnershipNFTs nftManager, IERC20 fusdcAddr);

proxyVestIncr

function proxyVestIncr(
    address pool,
    int32 lower,
    int32 upper,
    uint256 amount0Min,
    uint256 fusdcMin,
    uint256 amount0Max,
    uint256 fusdcMax,
    bool shouldVest,
    address recipient
) external returns (uint256);

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,
    ISeawaterExecutorSwapA _executorSwapA,
    ISeawaterExecutorSwapPermit2A _executorSwapPermit2A,
    ISeawaterExecutorQuoteA _executorQuoteA,
    ISeawaterExecutorPosition _executorPosition,
    ISeawaterExecutorUpdatePosition _executorUpdatePosition,
    ISeawaterExecutorAdmin _executorAdmin,
    ISeawaterExecutorAdjustPositionA _executorAdjustPositionsA,
    ISeawaterExecutorSwapPermit2B _executorSwapPermit2B,
    ISeawaterExecutorAdjustPositionB _executorAdjustPositionsB,
    ISeawaterExecutorSwapB _executorSwapB,
    ISeawaterExecutorQuoteB _executorQuoteB,
    ISeawaterExecutorFallback _executorFallback
);

Parameters

updateProxyAdmin

updates the proxy admin. only usable by the proxy admin

function updateProxyAdmin(address newAdmin) public onlyProxyAdmin;

Parameters

directDelegate

function directDelegate(address to) internal;

createPool653F395E

initialises a new pool. only usable by the seawater admin

function createPool653F395E(address, uint256, uint32) 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

setFeeProtocolCBD3EC35

function setFeeProtocolCBD3EC35(address, uint8, uint8) external;

updateNftManager9BDF41F6

set the NFT manager.

function updateNftManager9BDF41F6(address) external;

Parameters

updateSeawaterAdminD25D364D

set the new admin.

function updateSeawaterAdminD25D364D(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

quote2A9EFFCC6

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

function quote2A9EFFCC6(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

swap2ExactInPermit254A7DBB1

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

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

Parameters

Returns

swap2ExactInED91BB1D

performs a two stage swap across two pools

function swap2ExactInED91BB1D(address, address, uint256, uint256) 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