LUKSO - Foundry Template

Forge/Foundry project template to get started developing contracts from @lukso/lsp-smart-contracts.

Click the "Use this template" button from this repo's home page to create a repository based on this template.

Overview

• ⚒️ Ready to use Foundry environnement with the @lukso/lsp-smart-contracts dependencies to get started quickly building contracts using the LUKSO LSP Smart Contracts.

Getting started

1. Pre-requisites:

   • Install the bun package manager.
   • Install foundry.

2. clone the repository

git clone https://github.com/lukso-network/lukso-foundry-template

3. Install the dependencies

bun install

You can now get started building!

Development

Add new packages

You can install new packages and dependencies using bun or Foundry.

bun add @remix-project/remixd

Build

To generate the artifacts (contract ABIs and bytecode), simply run:

bun run build

The contract ABIs will placed under the artifacts/ folder.

Test

bun run test

Format Solidity code

bun run format

The formatting rules can be adjusted in the foundry.toml file, under the [fmt] section.

Help

You can run the following commands to see easily the available options with forge, anvil and cast.

forge --help
anvil --help
cast --help

Documentation

This template repository is based on Foundry, a blazing fast, portable and modular toolkit for EVM application development written in Rust. It includes:

• Forge: Ethereum testing framework (like Truffle, Hardhat and DappTools).
• Cast: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
• Anvil: Local Ethereum node, akin to Ganache, Hardhat Network.
• Chisel: Fast, utilitarian, and verbose solidity REPL.

You can find more documentation at: https://book.getfoundry.sh/