README.md

⚡ Satoru ⚡

Synthetics platform for Starknet, inspired by GMX v2 design.

⚡ About Satoru ⚡

Satoru is a cutting-edge synthetics platform for Starknet, taking inspiration from the modular design of GMX v2.

Read the Satoru Book to learn more about the project.

🛠️ Build

To build the project, run:

scarb build

Satoru compatible frontends

You can find the list of Satoru-compatible frontends, all of which have been built on top of the Satoru platform :

• Zohal

🧪 Test

To test the project, run:

snforge

🚀 Deploy

To deploy the contracts of Satoru, you first need to setup a smart wallet :

• Create a signer by following this tutorial : Signers

• Create an account by following this tutorial : Accounts

Once your smart wallet is setup, you can now run deployment files to deploy contracts, for example :

cd scripts

./deploy_contract.sh

Deployed Contracts

• RoleStore: 0x07eacab18c343f30edfa9336b8eacce9bc56303d43c92609a88e8da25177f5b3
• DataStore: 0x0549539da18f4d574211365b6abd678ef940444b579900efedcb935210c41481
• OrderVault: 0x01f1252d6d02feb14cfa88beff415e1524d1cebb31870056567aae257104b6fd
• Router: 0x00dd0912017ee7c8151555394380acd1012a814916d384b12ca64afa0eae2bc5
• EventEmitter: 0x0284ae712869c0af4f538e9297e6965d3c9ba9110830944047de8d35da7ea447
• MarketToken: 0x044391e9498f440cc41ace136ea317f6bfa2080311085d1846529e421974a1d3
• MarketFactory: 0x05766918626a91ca83f52003eb03bbf1f13174aa22e340c8057d8d5d6affbfcf
• WithdrawalVault: 0x050c83c2bc74cc50676fdd5598b40f9d0d6d5ccf6ea3478a7999e29473da03f1
• SwapHandler: 0x039aa67b479f4870878ec6d3002f9fa9b8e98d4d3d10c1f32b5d394a456aab28
• ReferralStorage: 0x0189463034c24b2cb091dcb515287bea13a4767534f09e52692a4cdc30254001
• DepositVault: 0x07d435e7ab3a5cd4b872e5725b02898833cb9a7c62e2d9a6a9db324d61e2925e

📚 Resources

Here are some resources to help you get started:

• Satoru Book
• Cairo Book
• Starknet Book
• Starknet Foundry Book
• Starknet By Example
• Starkli Book
• GMX v2 resources
  • GMX Synthetics
  • Trading on v2
  • Contracts for v2
  • Liquidity on v2

📖 License

This project is licensed under the MIT license. See LICENSE for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare 💻	sparqet 💻	zarboq 💻	drspacemn 💻	Michel 💻	delaaxe 💻	danilowhk 💻
Erim 💻	parketh 💻	Mathieu 💻	gaetbout 💻	Alex Metelli 💻	Fabien C 💻	rmzlb 💻
0xTitan 💻	Bal7hazar @ Carbonable 💻	Zizou 💻	Darlington Nnam 💻	Eytan Levy 💻	Daniel Bejarano 💻	Jordy Romuald 💻
StarkFishinator 💻	Axel Izsak 💻	Luciefer 💻	tevrat aksoy 💻	Piotr Magiera 💻	ftupas 💻	lambda-0x 💻
Tbelleng 💻	dic0de 💻	akhercha 💻	VictorONN 💻	kasteph 💻	Khaeljy 💻	JeanWoked 💻
vuittont60 💻	Arnaud Berger 💻	faytey 💻

This project follows the all-contributors specification. Contributions of any kind welcome!