Introducing 100kSwap: An AMM protocol that advances with Ethereum

100kSwap(100kswap.com), being built on StarkNet, is an AMM protocol that advances with Ethereum. 100k aims to revolutionize the performance of the AMM protocol by leveraging the rollup feature, bringing lower fees, less friction, and ultimately better liquidity to the L2 world and advance DeFi adoption.

100kSwap is the first open source AMM deployed on StarkNet Mainnet. We trust Ethereum and StarkNet, which represents the most advanced rollup trend. With its unique Cairo-VM giving developers a new development option, higher TPS and a computational cost that can be ignored. We believe AMM will be the most direct beneficiary of these two features.

With Cairo-VM, the gas cost required to perform calculation is much lower than for state updates, and on top of this we will increase the appropriate amount of calculation to reduce the number of state updates, continue to improve contract performance, and further reduce gas costs. Ensuring that 100k brings users a lightning-fast trading experience while enjoying the security of broad consensus - that's what every DeFi user wants to see, and we look forward to exploring this magical starfield with the pioneers on StarkNet.

100kSwap has adopted an immutable scheme where the protocol does not serve centralized interests. When it is fully delivered by the creator, the power is left to the community. It is a reflection of the spirit of decentralization, and our desire to work with users to make the impossible triangle possible.

In subsequent developments, we will continue to explore the potential of zk-tech to develop an AMM that is more LP friendly and allows for finer control of liquidity distribution.

The key technology is how to use Cairo to develop the "Rich Convex Function", and we will bring the results to the community. All the development process is open source and available as reference material, hoping to motivate more Dapp developers to inspire them to get involved in the L2 ecosystem and build DeFi. The following three products will be brought to the community.

1). A summary tutorial related to development.
2). A more generic and accessible development scaffolding.
3). SDK and DeFi contract libraries to facilitate dapp development.

https://100kswap.com

git clone [email protected]:0x60018/100k_swap-contracts.git
cd 100k_swap-contracts

yarn install

npx hardhat starknet-compile contracts/l0k_factory.cairo

npx hardhat test l0k_factory.test.ts

• main Stable version
• develop New PRs and features

l0k_factory.cairo

• Mainnet Adddress: 0x01c0a36e26a8f822e0d81f20a5a562b16a8f8a3dfd99801367dd2aea8f1a87a2
• Goerli Adddress: 0x06c31f39524388c982045988de3788530605ed08b10389def2e7b1dd09d19308

func PairCreated(token0 : felt, token1 : felt, pair : felt, index : felt):
end

• token0 is guaranteed to be strictly less than token1 by sort order.
• pair token0 & token1 pair address
• index pair index, start from 0

func constructor(pairClass : felt, feeToSetter : felt):
end

• pairClass l0k_pair contract class hash
• feeToSetter feeTo address manager

func feeTo() -> (feeTo : felt):
end

• Returns feeTo

func feeToSetter() -> (feeToSetter : felt):
end

• Returns feeToSetter

func getPair(token0 : felt, token1 : felt) -> (pair : felt):
end

• token0 -
• token1 -
• Returns pair

func allPairs(index : felt) -> (pair : felt):
end

• index pair index
• Returns pair

func allPairsLength() -> (length : felt):
end

• Returns length

func createPair(tokenA : felt, tokenB : felt) -> (pair : felt):
end

• tokenA A token address
• tokenB B token address
• Returns pair
• Emits PairCreated

func setFeeTo(feeTo : felt) -> ():
end

• feeTo -

func setFeeToSetter(feeToSetter : felt) -> ():
end

• feeToSetter -

l0k_pair.cairo

• ClassHash: 0x231adde42526bad434ca2eb983efdd64472638702f87f97e6e3c084f264e06f

ERC20 functions and events based on openzeppelin cairo, click here for details.
Thanks to openzeppelin for powering cairo.

func Mint(sender : felt, amount0 : Uint256, amount1 : Uint256):
end

• sender Minter
• amount0 Token0 amount
• amount1 Token1 amount

func Burn(sender : felt, amount0 : Uint256, amount1 : Uint256, to : felt):
end

• sender Burner
• amount0 Token0 amount
• amount1 Token1 amount
• to Recipient

func Swap(
    sender : felt,
    amount0In : Uint256,
    amount1In : Uint256,
    amount0Out : Uint256,
    amount1Out : Uint256,
    to : felt,
):
end

• sender Swaper
• amount0In Token0 in amount
• amount1In Token1 in amount
• amount0Out Token0 out amount
• amount1Out Token1 out amount
• to Recipient

func Sync(reserve0 : felt, reserve1 : felt):
end

• reserve0 Token0 quantity in pair
• reserve1 Token1 quantity in pair

func MINIMUM_LIQUIDITY() -> (MINIMUM_LIQUIDITY : felt):
end

• MINIMUM_LIQUIDITY -

func factory() -> (factory : felt):
end

• factory l0k_factory contract

func token0() -> (token0 : felt):
end

• token0 -

func token1() -> (token1 : felt):
end

• token1 -

func blockTimestampLast() -> (blockTimestampLast : felt):
end

• blockTimestampLast -

func price0CumulativeLast() -> (price0CumulativeLast : felt):
end

• price0CumulativeLast -

func price1CumulativeLast() -> (price1CumulativeLast : felt):
end

• price1CumulativeLast -

func kLast() -> (kLast : felt):
end

• kLast -

func getReserves() -> (reserve0 : felt, reserve1 : felt, blockTimestampLast : felt):
end

• reserve0 Token0 quantity in pair
• reserve1 reserve1 quantity in pair
• blockTimestampLast -

func initialize() -> (token0 : felt, token1 : felt):
end

called once by the factory at time of deployment

• token0 -
• token1 -

func mint(to : felt) -> (liquidity : Uint256):
end

• to Recipient
• RETURNS: liquidity Pair token quantity
• Emits Mint, Sync, Transfer_ERC20

func burn(to : felt) -> (amount0 : Uint256, amount1 : Uint256):
end

• to Recipient
• RETURNS: amount0 Received token0 quantity, amount1 Received token0 quantity
• Emits Burn, Sync, Transfer_ERC20

func swap(amount0Out : Uint256, amount1Out : Uint256, to : felt) -> ():
end

• amount0Out -
• amount1Out -
• to Recipient
• Emits Swap, Sync

func skim() -> (to : felt):
end

• to Recipient

func sync() -> ():
end

• Emits Sync

l0k_router.cairo

• Mainnet Adddress: 0x07a6f98c03379b9513ca84cca1373ff452a7462a3b61598f0af5bb27ad7f76d1
• Goerli Adddress: 0x00975910cd99bc56bd289eaaa5cee6cd557f0ddafdb2ce6ebea15b158eb2c664

func factory() -> (factory : felt):
end

• factory l0k_factory contract

func quote(amountA : Uint256, reserveA : felt, reserveB : felt) -> (amountB : Uint256):
end

• amountA TokenA quantity
• reserveA TokenA quantity in pair
• reserveB TokenB quantity in pair
• Returns amountB Received tokenB quantity

func getAmountOut(amountIn : Uint256, reserveIn : felt, reserveOut : felt) -> (amountOut : Uint256):
end

• amountIn TokenIn quantity
• reserveIn TokenIn quantity in pair
• reserveOut TokenOut quantity in pair
• Returns amountOut Received tokenOut quantity

func getAmountOut(amountOut : Uint256, reserveIn : felt, reserveOut : felt) -> (amountIn : Uint256):
end

• amountOut TokenOut quantity
• reserveIn TokenIn quantity in pair
• reserveOut TokenOut quantity in pair
• Returns amountIn Received tokenIn quantity

func getAmountsOut(amountIn : Uint256, path_len : felt, path : felt*) -> (amounts_len : felt, amounts : Uint256*):
end

• amountIn TokenIn quantity
• path_len Path's length
• path [TokenA, TokenB, ...]
• Returns amounts_len amounts's length, amounts received tokens amount

func getAmountsIn(amountOut : Uint256, path_len : felt, path : felt*) -> (amounts_len : felt, amounts : Uint256*):
end

• amountOut TokenOut quantity
• path_len Path's length
• path [TokenB, TokenA, ...]
• Returns amounts_len amounts's length, amounts send tokens amount

func addLiquidity(
    tokenA : felt,
    tokenB : felt,
    amountADesired : Uint256,
    amountBDesired : Uint256,
    amountAMin : Uint256,
    amountBMin : Uint256,
    to : felt,
    deadline : felt,
) -> (amountA : Uint256, amountB : Uint256, liquidity : Uint256):
end

• tokenA TokenA address
• tokenB TokenB address
• amountADesired -
• amountBDesired -
• amountAMin -
• amountBMin -
• to Recipient
• deadline Expired timestamp(unix)
• Returns amountA Used tokenA quantity, amountB Used tokenB quantity, liquidity Pair token quantity

func removeLiquidity(
    tokenA : felt,
    tokenB : felt,
    liquidity : Uint256,
    amountAMin : Uint256,
    amountBMin : Uint256,
    to : felt,
    deadline : felt,
) -> (amountA : Uint256, amountB : Uint256):
end

• tokenA TokenA address
• tokenB TokenB address
• liquidity Pair token quantity
• amountAMin -
• amountBMin -
• to Recipient
• deadline Expired timestamp(unix)
• Returns amountA Received tokenA quantity, amountB Received tokenB quantity

func swapExactTokensForTokens(
    amountIn : Uint256,
    amountOutMin : Uint256,
    path_len : felt,
    path : felt*,
    to : felt,
    deadline : felt,
) -> (amounts_len : felt, amounts : Uint256*):
end

• amountIn -
• amountOutMin -
• path_len -
• path -
• to Recipient
• deadline Expired timestamp(unix)
• Returns amounts_len amounts's length, amounts received tokens amount

func swapTokensForExactTokens(
    amountOut : Uint256,
    amountInMax : Uint256,
    path_len : felt,
    path : felt*,
    to : felt,
    deadline : felt,
) -> (amounts_len : felt, amounts : Uint256*):
end

• amountOut -
• amountInMax -
• path_len -
• path -
• to Recipient
• deadline Expired timestamp(unix)
• Returns amounts_len amounts's length, amounts send tokens amount

func swapExactTokensForTokensSupportingFeeOnTransferTokens(
    amountIn : Uint256,
    amountOutMin : Uint256,
    path_len : felt,
    path : felt*,
    to : felt,
    deadline : felt,
):
end

• amountIn -
• amountOutMin -
• path_len -
• path -
• to Recipient
• deadline Expired timestamp(unix)
• Returns amounts_len amounts's length, amounts send tokens amount