swaplace-cairo's Introduction

Swaplace Starknet

💽 Install dependencies

asdf

asdf - The multiple runtime version manager. See asdf guide for more details.

Scarb

Scarb - Cairo package manager.

First, add the Scarb plugin to asdf:

asdf plugin add scarb

Install:

asdf install scarb 2.3.1
asdf global scarb 2.3.1

Starknet Foundry

Starknet Foundry - Toolchain for developing Starknet smart contracts. It helps with writing, deploying, and testing your smart contracts. It is inspired by Foundry.

First, add the Starknet Foundry plugin to asdf:

asdf plugin add starknet-foundry

Install:

asdf install starknet-foundry 0.12.0

🛠️ Build

To build the project, run:

make build

🧪 Test

To test the project, run:

make test

🚀 Deploy

To deploy follow this setup account guide, then run:

make deploy

🎯 Pre-commit

To add pre-commit the project, run:

pip install pre-commit && pre-commit install

📚 Resources

Here are some resources to help you get started:

swaplace-cairo's People

Contributors

Stargazers

swaplace-cairo's Issues

feat: add Swap Factory Contract

Implement the Swap Factory Contract.

chore: add repository best practices

Feature Request

Describe the Feature Request

Organize the documentation and configurations of the repository.

Describe Preferred Solution

Add descriptions
Add issues Template
Create and move the following into a docs folder:

CODE_OF_CONDUCT.md
CONTRIBUTING.md
SECURITY.md

feat: add Swaplace Contract

Implement the Swaplace Contract. The following is expected:

Migrate Swaplace Contract
Add OpenZeppelin dependency
Create MockERC20
Create MockERC721
Add tests (using getter functions)
Add tests (using events)
Update script deploy

chore: bump cairo version 2.4.0

Upgrade to Cairo version 2.4.0 (the latest version supported by mainnet/testnet) Ensure that the project utilizes Scarb version 2.4.0 and Foundry version 0.14.0. Additionally, update the CI.

Recommend Projects