This repository provides a robust, extensible boilerplate for developing, testing, and deploying smart contracts across multiple blockchains. It currently supports Aptos (Move) and is structured for easy extension to Solana and other chains in the future.
- Multichain Ready: Unified structure for Aptos, Solana, and more.
- Modular Contracts: Organized by chain, with clear separation of sources, scripts, and tests.
- Developer Experience: Node.js scripts for compilation, testing, deployment, and ABI management.
- Extensible: Add new chains by following the established folder and script patterns.
smart-contracts/
contracts/
aptos/
contract/
Move.toml
README.md
sources/
swap/
router.move
swap.move
swap_utils.move
utils/
Math.move
u256.move
tests/
swap_test.move
test_coins.move
scripts/
compile.js
get_abi.js
publish.js
test.js
upgrade.js
solana/
contract/ # Placeholder for Solana smart contracts
scripts/ # Placeholder for Solana deployment/testing scripts
package.json
README.md
test-scripts/
hello-world.js
- swap.move: Core Uniswap v2-like AMM logic (pair creation, liquidity, swaps, LP tokens).
- router.move: User-facing entry points for creating pairs, adding/removing liquidity, and swapping tokens.
- swap_utils.move: Math and type utilities for swap calculations and token sorting.
- Math.move: General math utilities (sqrt, min, max, pow).
- u256.move: 256-bit integer arithmetic for high-precision calculations.
- swap_test.move: Comprehensive tests for swap, liquidity, and edge cases.
- test_coins.move: Test coin definitions and minting utilities for local testing.
All scripts are in contracts/aptos/scripts/ and can be run via npm scripts (see below):
- compile.js: Compile Move contracts using Aptos TS SDK.
- test.js: Run Move unit tests.
- publish.js: Publish the Move package to Aptos (writes module address to
.env). - upgrade.js: Upgrade an already published Move package.
- get_abi.js: Fetch and save ABI for deployed modules.
Defined in package.json:
npm run aptos:compile— Compile Move contractsnpm run aptos:test— Run Move unit testsnpm run aptos:publish— Publish contract and fetch ABInpm run aptos:upgrade— Upgrade contract and fetch ABI
Create a .env file in the root with the following variables:
PROJECT_NAME=my-aptos-dapp
NEXT_PUBLIC_APP_NETWORK=testnet
NEXT_PUBLIC_APTOS_API_KEY=""
NEXT_MODULE_PUBLISHER_ACCOUNT_ADDRESS=
NEXT_MODULE_PUBLISHER_ACCOUNT_PRIVATE_KEY=
NEXT_PUBLIC_MODULE_ADDRESS=
CIFARM_ACCOUNT_ADDRESS=
DEV_ACCOUNT_ADDRESS=
DEFAULT_ADMIN_ACCOUNT_ADDRESS=
NEXT_PUBLIC_MODULE_ADDRESSis set automatically after publishing.- Never commit private keys to public repositories.
- Install dependencies
npm install
- Initialize your Aptos account
aptos init # Follows prompts to set up .aptos/config.yaml - Fund your account (testnet)
aptos account fund-with-faucet --account <your_account_address> --amount 100000000
- Compile contracts
npm run aptos:compile
- Run tests
npm run aptos:test
- Publish contract
npm run aptos:publish # This will update NEXT_PUBLIC_MODULE_ADDRESS in your .env - Upgrade contract
npm run aptos:upgrade
[package]
name = "CifarmSwap"
version = "1.0.0"
[addresses]
test_coin = "0x16"
zero = "0000000000000000000000000000000000000000000000000000000000000000"
cifarm = "<your_resource_account>"
dev = "<your_original_account>"
default_admin = "<admin_account>"
[dependencies]
AptosFramework = { git = "https://git
692B
hub.com/aptos-labs/aptos-core.git", subdir = "aptos-move/framework/aptos-framework/", rev = "main" }
AptosStdlib = { git = "https://github.com/aptos-labs/aptos-core.git", subdir = "aptos-move/framework/aptos-stdlib/", rev = "2a458b5ffaaf6a9de6fac679a53912c0be9fe217" }
- All core logic is covered by Move unit tests in
swap_test.move. - Run tests with
npm run aptos:test.
A simple script to check Aptos node connectivity:
node test-scripts/hello-world.js
- The Solana contract and script folders are present as placeholders for future development.
- Solana support will include Rust smart contracts and deployment/testing scripts, following a similar structure to Aptos.
- Contributions for Solana and other chains are welcome!
To add support for a new blockchain:
- Create a new subfolder under
contracts/(e.g.,contracts/evm/for Ethereum-compatible chains). - Add
contract/andscripts/subfolders for your new chain. - Follow the patterns established for Aptos and Solana for organization and scripting.
- Update this README to document the new chain's setup and usage.
- Aptos Move Book
- Aptos TS SDK
- Aptos CLI
- Solana Docs (Solana support coming soon)
For more details, see contracts/aptos/contract/README.md and the Move source files.