@descartes-network/falcon-dex NPM

Falcon DEX

Falcon DEX is a Uniswap-v2-like AMM on Solana. The AMM implementation is heavily relying on Uniswap v2.

Beside that, we also add some extra features to help leverage others on-top application in the future. You can find details in the Implementation.

Preresiquite

anchor-lang

Please follow this link https://www.anchor-lang.com/docs/installation to setup anchor-lang on your machine.

pnpm

Due to some conlicts between yarn and anchor-lang, we decided to migrate yarn to pnpm within this project. Follow https://pnpm.io/installation to setup pnpm and run the below commands to install the project's dependencies

pnpm install

Versions

There are many people experienced unexpected issues due to the version compatibility of rustc, solana, anchor. To reduce the problem, You SHOULD follow the well-tested set of following versions.

Name	Version
rustc	1.74.0
solana	1.16.19
pnpm	8.11.0
anchor	0.29.0

How to run?

Build

To build the program,

pnpm build

Test

To run the testcase,

pnpm test

For more details about the test cases, you can explore it Falcon DEX Testing.

Implementation

Folder Structure

Folder name	Description
`src/falcon-dex`	The smart contract implementation
`src/falcon-dex/instructions`	The smart contract's processors. Each instruction from users will be navigated to the relevant processor.
`src/falcon-dex/schema`	Defines program account schema.
`app`	The Falcon DEX's SDK to help developers to interact with the smart contract.
`migrations`	Contains smart contract deployment scripts.
`tests`	Contains testcases for both the smart contract and the SDK.
`.github`	Defines Github workflows