Presets
Presets are ready-to-deploy contracts provided by the library. Since presets are intended to be very simple
and as generic as possible, there’s no support for custom or complex contracts such as ERC20Pausable
or ERC721Mintable
.
For contract customization and combination of modules you can use Wizard for Cairo, our code-generation tool. |
Available presets
List of available presets and their corresponding Sierra class hashes.
Class hashes were computed using cairo 2.6.3. |
Name | Sierra Class Hash |
---|---|
|
|
|
|
|
|
|
|
|
|
|
starkli class-hash command can be used to compute the class hash from a Sierra artifact. |
Usage
These preset contracts are ready-to-deploy which means they should already be declared on the Sepolia network. Simply deploy the preset class hash and add the appropriate constructor arguments. Deploying the ERC20 preset with starkli, for example, will look like this:
starkli deploy 0x06aff5bf77ad88f5ccadc80360e3dcdd12e1a8009160458296b8aac9de2240ff \
<CONSTRUCTOR_ARGS> \
--network="sepolia"
If a class hash has yet to be declared, copy/paste the preset contract code and declare it locally.
Start by setting up a project and installing the Contracts for Cairo library.
Copy the target preset contract from the presets directory and paste it in the new project’s src/lib.cairo
like this:
// src/lib.cairo
#[starknet::contract]
mod ERC20 {
use openzeppelin::token::erc20::ERC20Component;
use starknet::ContractAddress;
component!(path: ERC20Component, storage: erc20, event: ERC20Event);
#[abi(embed_v0)]
impl ERC20MixinImpl = ERC20Component::ERC20MixinImpl<ContractState>;
impl InternalImpl = ERC20Component::InternalImpl<ContractState>;
#[storage]
struct Storage {
#[substorage(v0)]
erc20: ERC20Component::Storage
}
#[event]
#[derive(Drop, starknet::Event)]
enum Event {
#[flat]
ERC20Event: ERC20Component::Event
}
#[constructor]
fn constructor(
ref self: ContractState,
name: ByteArray,
symbol: ByteArray,
fixed_supply: u256,
recipient: ContractAddress
) {
self.erc20.initializer(name, symbol);
self.erc20._mint(recipient, fixed_supply);
}
}
Next, compile the contract.
scarb build
Finally, declare the preset.
starkli declare target/dev/my_project_ERC20.contract_class.json \
--network="sepolia"