History

Jon Cinque de8433e815 ci: Split out test-bpf into separate workflows for each program (#1893 ) * ci: Split token, token-swap, and token-lending out * Remove token lending js in main runner * token-swap: Update proptest to trigger build * Remove unused Cargo.lock file * lending: Update proptest to trigger lending build * Fix lending test * Try re-using action * binary-oracle-pair: Bump token version to trigger build * Reference action differently * Add checkout step before local action * Move out cargo test bpf step * Add more programs * Update example file to trigger job * Update library file to trigger build * Update name-service file to trigger build * Update record file to trigger build * Update shared memory file to trigger build * Add pull request runners for each probram / library * Fix pull-request yml file referencing unknown step		2021-06-11 22:35:00 +02:00
..
js	build(deps-dev): bump start-server-and-test in /token-swap/js (#1878 )	2021-06-07 11:04:14 +00:00
program	ci: Split out test-bpf into separate workflows for each program (#1893 )	2021-06-11 22:35:00 +02:00
proposals	Add pausable proposal (#1506 )	2021-03-25 16:38:36 -05:00
README.md	token-swap: Document owner address in README (#1368 )	2021-03-04 20:24:43 +01:00

README.md

Token Swap Program

A Uniswap-like exchange for the Token program on the Solana blockchain, deployed to SwaPpA9LAaLfeLi3a68M4DjnLqgtticKg6CnyNwgAC8 on all networks.

Full documentation is available at https://spl.solana.com/token-swap

JavaScript bindings are available in the ./js directory.

Building

To build a development version of the Token Swap program, you can use the normal build command for Solana programs:

cargo build-bpf

For production versions, the Token Swap Program contains a production feature to fix constraints on fees and fee account owner. A developer can deploy the program, allow others to create pools, and earn a "protocol fee" on all activity.

Since Solana programs cannot contain any modifiable state, we must hard-code all constraints into the program. SwapConstraints in program/src/constraints.rs contains all hard-coded fields for fees. Additionally the SWAP_PROGRAM_OWNER_FEE_ADDRESS environment variable specifies the public key that must own all fee accounts.

You can build the production version of Token Swap running on devnet, testnet, and mainnet-beta using the following command:

SWAP_PROGRAM_OWNER_FEE_ADDRESS=HfoTxFR1Tm6kGmWgYWD6J7YHVy1UwqSULUGVLXkJqaKN cargo build-bpf --features=production

Testing

Unit tests

Run unit tests from ./program/ using:

cargo test

Fuzz tests

Using the Rust version of honggfuzz, we "fuzz" the Token Swap program every night. Install honggfuzz with:

cargo install honggfuzz

From there, run fuzzing from ./program/fuzz with:

cargo hfuzz run token-swap-instructions

If the program crashes or errors, honggfuzz dumps a .fuzz file in the workspace, so you can debug the failing input using:

cargo hfuzz run-debug token-swap-instructions hfuzz_workspace/token-swap-instructions/*fuzz

This command attaches a debugger to the test, allowing you to easily see the exact problem.

Integration tests

You can test the JavaScript bindings and on-chain interactions using solana-test-validator, included in the Solana Tool Suite. See the CLI installation instructions.

From ./js, install the required modules:

npm i

Then run all tests:

npm run start-with-test-validator

If you are testing a production build, use:

SWAP_PROGRAM_OWNER_FEE_ADDRESS="HfoTxFR1Tm6kGmWgYWD6J7YHVy1UwqSULUGVLXkJqaKN" npm run start-with-test-validator