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
Deployment nameDeployment address
Longtail AMM0xd706b85c571330af8495174664d04D6d8551F9D5
Longtail NFT manager0x7AD12Ef3578D5eb845883d156D8dFB2eA39448B5
Permit2 router0x2246431582087b930F2CE561c34deb8E7e5c44bE
Swaps implementation0x7717e32db762818b86b47a213c1461c56ab2d4b6
Swaps permit2 A implementation0x5992090411265add042b29dc361dee05e5606db6
Quotes implementation0xf6120b79c5541806b1b4c619fbb8dcfdf32cfa20
Positions implementation0x0721157b712f90085a006eb56f44e5b22b374501
Update position implementation0x149c6ead35c4e60a090dad3dcb458f2b2e5f18a8
Admin implementation0x09251054f9f91a26c51459d0af373fcd5d01d993
Adjust position implementation0x6de9c5025c107057b63ffe15dcfe28604f27e4f1
Swaps permit2 B implementation0x03af6a949f68e1ede06b63c8b43e6082689171cf
Leo contract deployments
Deployment nameDeployment address
Implementation0xe8c1d28a4c16225c7188d0d812690a451e9c818a
Useful testing token deployments
Deployment nameDeployment address
fUSDC0xA8EA92c819463EFbEdDFB670FEfC881A480f0115
WETH0xde104342B32BCa03ec995f999181f7Cf1fFc04d7
USDC0x6437fdc89cED41941b97A9f1f8992D88718C81c5
WSPN0x22b9fa698b68bBA071B513959794E9a47d19214c
CATBUX0x36c116a8851869cf8a99b3Bda0Fad42453D32B99

Errors

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

NoHexExplanation
00x00Denominator is 0
10x01Result is U256::MAX
20x02Sqrt price is 0
30x03Sqrt price is less than or equal to quotient
40x04Can not get most significant bit or least significant bit on zero value
50x05Liquidity is 0
60x06require((product = amount * sqrtPX96) / amount == sqrtPX96 && numerator1 > product);
70x07Denominator is less than or equal to prod_1
80x08Liquidity Sub
90x09Liquidity Add
100x0aThe given tick must be less than, or equal to, the maximum tick
110x0bSecond inequality must be < because the price can never reach the price at the max tick
120x0cOverflow when casting to U160
130x0dLiquidity higher than max
140x0eFee growth sub overflow
150x0fERC20 call reverted
160x10ERC20 call reverted with no data
170x11Pool is already initialised
180x12Contract is already initialised
190x13Price limit too high
200x14Price limit too low
210x15Checked abs called on an unexpected positive number
220x16Checked abs called on an unexpected negative number
230x17Checked abs called on uint.min
240x18Fee result too high
250x19Swap result too high
260x1aInternal swap amounts not matched
270x1bInternal swap result was positive
280x1cMinimum out not reached
290x1dOnly the position owner can use this
300x1eOnly the NFT manager can use this
310x1fOnly the Seawater admin can use this
320x20Operation unavailable when the pool is disabled
330x21Invalid tick spacing
340x22Swap result too low
350x23Liquidity too low or high to be a int128
360x24Invalid tick
370x25Pool enabled when it should be disabled for this action
380x26Position is empty when it shouldn't be
390x27Liquidity that was almost taken was too low when it didn't need to be
400x28Fee growth that tried to be calculated was bad internally for a tick

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

NameDescription
FLU_SEAWATER_PERMIT2_ADDRUniswap Permit2 router
FLU_SEAWATER_FUSDC_ADDRUSDC Super Asset to route every trade through

Build dependencies

NameSource
Rust (nightly version)Installer
Cargo Stylus subcommandRepo
FoundryInstaller
Makebuild-essentials if you're on Linux

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

NameDescription
SEAWATER_PROXY_ADMINAddress that's permitted to administrate the code, including deploying updates, and creating pools.
STYLUS_ENDPOINTURL to access the Stylus node.
STYLUS_PRIVATE_KEYPrivate key to use for deployment.
FLU_SEAWATER_FUSDC_ADDRSuper USDC address to use as the base asset for each pool.

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.