YAS is Yet Another Swap on Starknet but bringing the best prices and yield to Degens.
YAS is Yet Another Swap on Starknet 😝. It's an AMM based on Uniswap v3 that will add some new features to the Starknet ecosystem.
At YAS we believe product quality should always be a priority so we are commited to provide the best experience for users that want to put Starknet to the limit.
This project will be built in the open, it's still in development. We love the Starknet developer ecosystem and we know that a lot of smart and hungry developers would like to collaborate in the future of Starknet. If that's your case you are more than welcome to join us!
Follow us on Twitter
Currently, the project is in a development stage, it has not been audited yet
and is not ready for production. We are also using our
fork of
Orion
signed integer
implementation until all features are implemented and supported
in the latest version of Cairo.
Note: In our Orion fork, we've added the capability for signed integers to be stored in a smart contract.
Visit the rustup website and follow the instructions on the page or run the following command in the terminal:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Check the version;
rustc --version
cargo --version
Starkli is CLI tool for Starknet. For install;
curl https://get.starkli.sh | sh
Update starkli
simply by running;
starkliup
Run the following command:
make deps
This will end up installing:
Run the following command:
make build
This command executes the Scarb build process, resulting in the creation of a Sierra program.
Run the following command to run all tests:
make test
You can also filter the tests to run, by module or even by individual test name, for example to run tests within the Mint module, execute:
make test Mint
Or to run only the "test_invalid_max_tick" function:
make test test_invalid_max_tick
Be careful though, this parameters is case-sensitive
This guide will help you declare and deploy contracts on a testnet. Please note that you won't be able to use the commands in the Makefile unless you follow these instructions.
A smart wallet consists of two parts: a Signer and an Account Descriptor. The Signer is a smart contract capable of signing transactions (for which we need its private key). The Account Descriptor is a JSON file containing information about the smart wallet, such as its address and public key.
Follow the steps below to set up a testnet smart wallet using starkli
:
Connect to a Provider: to interact with the network you need an RPC Provider. For our project we will be using Alchemy's free tier in Goerli Testnet.
Go to Alchemy website and create an account.
It will ask which network you want to develop on and choose Starknet.
Select the Free version of the service (we will only need access to send some transactions to deploy the contracts)
Once the account creation process is done, go to My apps and create a new Application. Choose Starknet as a Chain and Goerli Starknet as a Network.
Click on View key on the new Starknet Application and copy the HTTPS url.
On your terminal run:
export STARKNET_RPC="<ALCHEMY_API_HTTPS_URL>"
Create a Keystore: A Keystore is a encrypted json
file that stores the
private keys.
Create a hidden folder: Use the following command:
mkdir -p ~/.starkli-wallets
Generate a new Keystore file: Run the following command to create a new private key stored in the file. It will ask for a password to encrypt the file:
starkli signer keystore new ~/.starkli-wallets/keystore.json
The command will return the Public Key of your account, copy it to your clipboard to fund the account.
Set STARKNET_ACCOUNT: To set the environment variable just run:
export STARKNET_KEYSTORE="~/.starkli-wallets/keystore.json"
Account Creation: In Starknet every account is a smart contract, so to create one it will need to be deployed.
Initiate the account with the Open Zeppelin Account contract:
starkli account oz init --keystore ~/.starkli-wallets/keystore.json ~/.starkli-wallets/account.json
Deploy the account by running:
starkli account deploy --keystore ~/.starkli-wallets/keystore.json ~/.starkli-wallets/account.json
For the deployment starkli
will ask you to fund an account. To do so
you will need to fund the address given by starkli
with the
Goerli Starknet Faucet
Setting Up Environment Variables: There are two primary environment variables vital for effective usage of Starkli’s CLI. These are the location of the keystore file for the Signer, and the location of the Account Descriptor file:
export STARKNET_ACCOUNT=~/.starkli-wallets/account.json
export STARKNET_KEYSTORE=~/.starkli-wallets/keystore.json
By following the previous two steps, you should now have a account funded on the Goerli testnet.
Now we are going to declare the contracts YASRouter, YASFactory, and YASPool. We are also going to deploy the contracts YASRouter and YASFactory on Testnet.
On Starknet, the deployment process is in two steps:
Updated .env
file: Please modify the variables with your Testnet account and your RPC provider.
ACCOUNT_ADDRESS=<ACCOUNT_ADDRESS>
ACCOUNT_PRIVATE_KEY=<ACCOUNT_PRIVATE_KEY>
ACCOUNT_SRC=~/.starkli-wallets/account.json
RPC_URL=<STARKNET_RPC_HTTPS_URL>
Build the project
make build
Declare and Deploy: We sequentially declare and deploy the contracts.
make deploy
Note: To obtain your private key, you need to execute the following command:
starkli signer keystore inspect-private ~/.starkli-wallets/account.json
The contract address we see in the above command belongs to one of Katana's pre-funded accounts. Now we are ready to declare and deploy our contracts in Katana.
Katana provides us with pre-funded accounts. We will use one of them for deployment. Katana generates the same accounts, and since we know the port it's running on, we can now complete the .env
file.
Updated .env
file:
# Katana Prefunded Account
ACCOUNT_ADDRESS=0x517ececd29116499f4a1b64b094da79ba08dfd54a3edaa316134c41f8160973
ACCOUNT_PRIVATE_KEY=0x1800000000300000180000000000030000000000003006001800006600
ACCOUNT_SRC=~/.starkli-wallets/account_katana.json
RPC_URL=http://0.0.0.0:5050
Build the project
make build
Start Local Testnet
make start-katana
Setup Katana Account: This step, which involves setting up the Katana account, only needs to be done the first time.
make setup-katana-account
Declare and Deploy: We sequentially declare and deploy the contracts. Local deployment needs katana
running. The account used for deployment is a pre-funded one.
make deploy
This demo will perform the following steps:
Updated .env
file:
# Katana Prefunded Account
ACCOUNT_ADDRESS=0x517ececd29116499f4a1b64b094da79ba08dfd54a3edaa316134c41f8160973
ACCOUNT_PRIVATE_KEY=0x1800000000300000180000000000030000000000003006001800006600
ACCOUNT_SRC=~/.starkli-wallets/account_katana.json
RPC_URL=http://0.0.0.0:5050
Build the project
make build
Start Local Testnet
make start-katana
Run Local Demo
make demo-local
0x06c3b1076e09b1d16642808b0bfef750a683ad06724f9e4f1aaaca17bc44fad5
0x0490c81e19516eba9eb531b48e58f9876259ac9396444dc759a84e4a8aefa628
0x016648670892a29b68b66c98892f408ab2e174ffb827c023ad9f4ca0eff816eb
main
branch (library from Giza)This project is licensed under the Apache 2.0 license. See LICENSE for more information.
Thanks goes to these wonderful people (emoji key):
Roberto Catalan 💻 |
Damián Piñones 💻 |
Santiago Galván (Dub) 💻 |
Santiago Pittella 💻 |
Francisco Strambini 💻 |
Musa AbdulKareem 💻 |
dblanco 💻 |
Nadai 💻 |
Daniel Bejarano 💻 |
ftupas 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!