Vite 中文文档

10Kswap Contracts for Cairo


Introducing 10KSwap: An AMM protocol that advances with Ethereum

10KSwap(10kswap.com), being built on StarkNet, is an AMM protocol that advances with Ethereum. 10K 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.

10KSwap 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 10K 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.

10KSwap 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.

10Kswap was online. To preview


https://10kswap.com

preview

Get started


Clone this repo


  1. ``` sh
  2. git clone git@github.com:0x60018/10k_swap-contracts.git
  3. cd 10k_swap-contracts

  5. ```

Install dependencies


  1. ``` sh
  2. yarn install

  4. ```

Compile a contract


  1. ``` sh
  2. npx hardhat starknet-compile contracts/l0k_factory.cairo

  4. ```

Run a test that interacts with the compiled contract


  1. ``` sh
  2. npx hardhat test l0k_factory.test.ts

  4. ```

Branches


main Stable version
develop New PRs and features

Contracts


l0k_factory


l0k_factory.cairo

Mainnet Adddress: 0x01c0a36e26a8f822e0d81f20a5a562b16a8f8a3dfd99801367dd2aea8f1a87a2
Goerli Adddress: 0x06c31f39524388c982045988de3788530605ed08b10389def2e7b1dd09d19308

Events


  1. ``` cairo
  2. func PairCreated(token0 : felt, token1 : felt, pair : felt, index : felt):
  3. end
  4. ```

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

constructor


  1. ``` cairo
  2. func constructor(pairClass : felt, feeToSetter : felt):
  3. end
  4. ```

pairClass l0k_pair contract class hash
feeToSetter feeTo address manager

Read Functions


feeTo

  1. ``` cairo
  2. func feeTo() -> (feeTo : felt):
  3. end
  4. ```

Returns feeTo

feeToSetter

  1. ``` cairo
  2. func feeToSetter() -> (feeToSetter : felt):
  3. end
  4. ```

Returns feeToSetter

getPair

  1. ``` cairo
  2. func getPair(token0 : felt, token1 : felt) -> (pair : felt):
  3. end
  4. ```

token0 -
token1 -
Returns pair

allPairs

  1. ``` cairo
  2. func allPairs(index : felt) -> (pair : felt):
  3. end
  4. ```

index pair index
Returns pair

allPairsLength

  1. ``` cairo
  2. func allPairsLength() -> (length : felt):
  3. end
  4. ```

Returns length

Write Functions


createPair

  1. ``` cairo
  2. func createPair(tokenA : felt, tokenB : felt) -> (pair : felt):
  3. end
  4. ```

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

setFeeTo

  1. ``` cairo
  2. func setFeeTo(feeTo : felt) -> ():
  3. end
  4. ```

feeTo -

setFeeToSetter

  1. ``` cairo
  2. func setFeeToSetter(feeToSetter : felt) -> ():
  3. end
  4. ```

feeToSetter -

l0k_pair


l0k_pair.cairo

ClassHash: 0x231adde42526bad434ca2eb983efdd64472638702f87f97e6e3c084f264e06f

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


Events


Mint

  1. ``` cairo
  2. func Mint(sender : felt, amount0 : Uint256, amount1 : Uint256):
  3. end
  4. ```

sender Minter
amount0 Token0 amount
amount1 Token1 amount

Burn

  1. ``` cairo
  2. func Burn(sender : felt, amount0 : Uint256, amount1 : Uint256, to : felt):
  3. end
  4. ```

sender Burner
amount0 Token0 amount
amount1 Token1 amount
to Recipient

Swap

  1. ``` cairo
  2. func Swap(
  3.     sender : felt,
  4.     amount0In : Uint256,
  5.     amount1In : Uint256,
  6.     amount0Out : Uint256,
  7.     amount1Out : Uint256,
  8.     to : felt,
  9. ):
  10. end
  11. ```

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

Sync

  1. ``` cairo
  2. func Sync(reserve0 : felt, reserve1 : felt):
  3. end
  4. ```

reserve0 Token0 quantity in pair
reserve1 Token1 quantity in pair

Read Functions


MINIMUM_LIQUIDITY

  1. ``` cairo
  2. func MINIMUM_LIQUIDITY() -> (MINIMUM_LIQUIDITY : felt):
  3. end
  4. ```

MINIMUM_LIQUIDITY -

factory

  1. ``` cairo
  2. func factory() -> (factory : felt):
  3. end
  4. ```

factory l0k_factory contract

token0

  1. ``` cairo
  2. func token0() -> (token0 : felt):
  3. end
  4. ```

token0 -

token1

  1. ``` cairo
  2. func token1() -> (token1 : felt):
  3. end
  4. ```

token1 -

blockTimestampLast

  1. ``` cairo
  2. func blockTimestampLast() -> (blockTimestampLast : felt):
  3. end
  4. ```

blockTimestampLast -

price0CumulativeLast

  1. ``` cairo
  2. func price0CumulativeLast() -> (price0CumulativeLast : felt):
  3. end
  4. ```

price0CumulativeLast -

price1CumulativeLast

  1. ``` cairo
  2. func price1CumulativeLast() -> (price1CumulativeLast : felt):
  3. end
  4. ```

price1CumulativeLast -

kLast

  1. ``` cairo
  2. func kLast() -> (kLast : felt):
  3. end
  4. ```

kLast -

getReserves

  1. ``` cairo
  2. func getReserves() -> (reserve0 : felt, reserve1 : felt, blockTimestampLast : felt):
  3. end
  4. ```

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

Write Functions


initialize

  1. ``` cairo
  2. func initialize() -> (token0 : felt, token1 : felt):
  3. end
  4. ```

called once by the factory at time of deployment


token0 -
token1 -

mint

  1. ``` cairo
  2. func mint(to : felt) -> (liquidity : Uint256):
  3. end
  4. ```

to Recipient
RETURNS: liquidity Pair token quantity
Emits Mint, Sync, Transfer ERC20

burn

  1. ``` cairo
  2. func burn(to : felt) -> (amount0 : Uint256, amount1 : Uint256):
  3. end
  4. ```

to Recipient
RETURNS: amount0 Received token0 quantity, amount1 Received token0 quantity
Emits Burn, Sync, Transfer ERC20

swap

  1. ``` cairo
  2. func swap(amount0Out : Uint256, amount1Out : Uint256, to : felt) -> ():
  3. end
  4. ```

amount0Out -
amount1Out -
to Recipient
Emits Swap, Sync

skim

  1. ``` cairo
  2. func skim() -> (to : felt):
  3. end
  4. ```

to Recipient

sync

  1. ``` cairo
  2. func sync() -> ():
  3. end
  4. ```

Emits Sync

l0k_router


l0k_router.cairo

Mainnet Adddress: 0x07a6f98c03379b9513ca84cca1373ff452a7462a3b61598f0af5bb27ad7f76d1
Goerli Adddress: 0x00975910cd99bc56bd289eaaa5cee6cd557f0ddafdb2ce6ebea15b158eb2c664

Read Functions


factory

  1. ``` cairo
  2. func factory() -> (factory : felt):
  3. end
  4. ```

factory l0k_factory contract

quote

  1. ``` cairo
  2. func quote(amountA : Uint256, reserveA : felt, reserveB : felt) -> (amountB : Uint256):
  3. end
  4. ```

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

getAmountOut

  1. ``` cairo
  2. func getAmountOut(amountIn : Uint256, reserveIn : felt, reserveOut : felt) -> (amountOut : Uint256):
  3. end
  4. ```

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

getAmountIn

  1. ``` cairo
  2. func getAmountOut(amountOut : Uint256, reserveIn : felt, reserveOut : felt) -> (amountIn : Uint256):
  3. end
  4. ```

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

getAmountsOut

  1. ``` cairo
  2. func getAmountsOut(amountIn : Uint256, path_len : felt, path : felt*) -> (amounts_len : felt, amounts : Uint256*):
  3. end
  4. ```

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

getAmountsIn

  1. ``` cairo
  2. func getAmountsIn(amountOut : Uint256, path_len : felt, path : felt*) -> (amounts_len : felt, amounts : Uint256*):
  3. end
  4. ```

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

Write Functions


addLiquidity

  1. ``` cairo
  2. func addLiquidity(
  3.     tokenA : felt,
  4.     tokenB : felt,
  5.     amountADesired : Uint256,
  6.     amountBDesired : Uint256,
  7.     amountAMin : Uint256,
  8.     amountBMin : Uint256,
  9.     to : felt,
  10.     deadline : felt,
  11. ) -> (amountA : Uint256, amountB : Uint256, liquidity : Uint256):
  12. end
  13. ```

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

removeLiquidity

  1. ``` cairo
  2. func removeLiquidity(
  3.     tokenA : felt,
  4.     tokenB : felt,
  5.     liquidity : Uint256,
  6.     amountAMin : Uint256,
  7.     amountBMin : Uint256,
  8.     to : felt,
  9.     deadline : felt,
  10. ) -> (amountA : Uint256, amountB : Uint256):
  11. end
  12. ```

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

swapExactTokensForTokens

  1. ``` cairo
  2. func swapExactTokensForTokens(
  3.     amountIn : Uint256,
  4.     amountOutMin : Uint256,
  5.     path_len : felt,
  6.     path : felt*,
  7.     to : felt,
  8.     deadline : felt,
  9. ) -> (amounts_len : felt, amounts : Uint256*):
  10. end
  11. ```

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

swapTokensForExactTokens

  1. ``` cairo
  2. func swapTokensForExactTokens(
  3.     amountOut : Uint256,
  4.     amountInMax : Uint256,
  5.     path_len : felt,
  6.     path : felt*,
  7.     to : felt,
  8.     deadline : felt,
  9. ) -> (amounts_len : felt, amounts : Uint256*):
  10. end
  11. ```

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

swapExactTokensForTokensSupportingFeeOnTransferTokens

  1. ``` cairo
  2. func swapExactTokensForTokensSupportingFeeOnTransferTokens(
  3.     amountIn : Uint256,
  4.     amountOutMin : Uint256,
  5.     path_len : felt,
  6.     path : felt*,
  7.     to : felt,
  8.     deadline : felt,
  9. ):
  10. end
  11. ```

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