Skip to content

Commit 029790c

Browse files
immrsdericglau
immrsd
and
ericglau
authored
Cairo: decimals customization (#654)
Co-authored-by: Eric Lau <ericglau@outlook.com>
1 parent 41d5c74 commit 029790c

File tree

21 files changed

+345
-51
lines changed

21 files changed

+345
-51
lines changed

‎.changeset/swift-eels-repair.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@openzeppelin/wizard-cairo': minor
3+
'@openzeppelin/wizard-common': patch
4+
'@openzeppelin/contracts-mcp': patch
5+
---
6+
7+
Support decimals customization for ERC20 Cairo contracts

‎packages/common/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@
2121
"@types/node": "^20.0.0",
2222
"typescript": "^5.0.0"
2323
}
24-
}
24+
}

‎packages/common/src/ai/descriptions/cairo.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ export const cairoRoyaltyInfoDescriptions = {
3636

3737
export const cairoERC20Descriptions = {
3838
premint: 'The number of tokens to premint for the deployer.',
39+
decimals: 'The number of decimals to use for the contract. Defaults to 18.',
3940
votes:
4041
"Whether to keep track of historical balances for voting in on-chain governance, with a way to delegate one's voting power to a trusted account.",
4142
};

‎packages/core/cairo/src/erc20.test.ts‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,21 @@ testERC20('erc20 premint of 0', {
6969
premint: '0',
7070
});
7171

72+
testERC20('erc20 votes, custom decimals', {
73+
decimals: '6',
74+
});
75+
76+
test('erc20 votes, decimals too high', async t => {
77+
const error = t.throws(() =>
78+
buildERC20({
79+
name: 'MyToken',
80+
symbol: 'MTK',
81+
decimals: '256',
82+
}),
83+
);
84+
t.is((error as OptionsError).messages.decimals, 'Value is greater than u8 max value');
85+
});
86+
7287
testERC20('erc20 mintable', {
7388
mintable: true,
7489
access: 'ownable',
@@ -158,11 +173,12 @@ testERC20('erc20 full upgradeable with roles', {
158173

159174
testAPIEquivalence('erc20 API default');
160175

161-
testAPIEquivalence('erc20 API basic', { name: 'CustomToken', symbol: 'CTK' });
176+
testAPIEquivalence('erc20 API basic', { name: 'CustomToken', symbol: 'CTK', decimals: '6' });
162177

163178
testAPIEquivalence('erc20 API full upgradeable', {
164179
name: 'CustomToken',
165180
symbol: 'CTK',
181+
decimals: '6',
166182
premint: '2000',
167183
access: 'roles',
168184
burnable: true,

‎packages/core/cairo/src/erc20.test.ts.md‎

Lines changed: 105 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Generated by [AVA](https://avajs.dev).
1313
␊
1414
#[starknet::contract]␊
1515
mod MyToken {␊
16-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
16+
use openzeppelin::token::erc20::{␊
17+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
18+
};␊
1719
␊
1820
component!(path: ERC20Component, storage: erc20, event: ERC20Event);␊
1921
␊
@@ -54,7 +56,9 @@ Generated by [AVA](https://avajs.dev).
5456
#[starknet::contract]␊
5557
mod MyToken {␊
5658
use openzeppelin::access::ownable::OwnableComponent;␊
57-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
59+
use openzeppelin::token::erc20::{␊
60+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
61+
};␊
5862
use openzeppelin::upgrades::interface::IUpgradeable;␊
5963
use openzeppelin::upgrades::UpgradeableComponent;␊
6064
use starknet::{ClassHash, ContractAddress};␊
@@ -125,7 +129,9 @@ Generated by [AVA](https://avajs.dev).
125129
#[starknet::contract]␊
126130
mod MyToken {␊
127131
use openzeppelin::access::ownable::OwnableComponent;␊
128-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
132+
use openzeppelin::token::erc20::{␊
133+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
134+
};␊
129135
use openzeppelin::upgrades::interface::IUpgradeable;␊
130136
use openzeppelin::upgrades::UpgradeableComponent;␊
131137
use starknet::{ClassHash, ContractAddress, get_caller_address};␊
@@ -206,7 +212,7 @@ Generated by [AVA](https://avajs.dev).
206212
mod MyToken {␊
207213
use openzeppelin::access::ownable::OwnableComponent;␊
208214
use openzeppelin::security::pausable::PausableComponent;␊
209-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
215+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
210216
use openzeppelin::upgrades::interface::IUpgradeable;␊
211217
use openzeppelin::upgrades::UpgradeableComponent;␊
212218
use starknet::{ClassHash, ContractAddress};␊
@@ -318,7 +324,7 @@ Generated by [AVA](https://avajs.dev).
318324
use openzeppelin::access::accesscontrol::{AccessControlComponent, DEFAULT_ADMIN_ROLE};␊
319325
use openzeppelin::introspection::src5::SRC5Component;␊
320326
use openzeppelin::security::pausable::PausableComponent;␊
321-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
327+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
322328
use openzeppelin::upgrades::interface::IUpgradeable;␊
323329
use openzeppelin::upgrades::UpgradeableComponent;␊
324330
use starknet::{ClassHash, ContractAddress};␊
@@ -441,7 +447,7 @@ Generated by [AVA](https://avajs.dev).
441447
mod MyToken {␊
442448
use openzeppelin::access::ownable::OwnableComponent;␊
443449
use openzeppelin::security::pausable::PausableComponent;␊
444-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
450+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
445451
use openzeppelin::upgrades::interface::IUpgradeable;␊
446452
use openzeppelin::upgrades::UpgradeableComponent;␊
447453
use starknet::{ClassHash, ContractAddress, get_caller_address};␊
@@ -553,7 +559,9 @@ Generated by [AVA](https://avajs.dev).
553559
#[starknet::contract]␊
554560
mod MyToken {␊
555561
use openzeppelin::access::ownable::OwnableComponent;␊
556-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
562+
use openzeppelin::token::erc20::{␊
563+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
564+
};␊
557565
use openzeppelin::upgrades::interface::IUpgradeable;␊
558566
use openzeppelin::upgrades::UpgradeableComponent;␊
559567
use starknet::{ClassHash, ContractAddress};␊
@@ -626,7 +634,9 @@ Generated by [AVA](https://avajs.dev).
626634
#[starknet::contract]␊
627635
mod MyToken {␊
628636
use openzeppelin::access::ownable::OwnableComponent;␊
629-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
637+
use openzeppelin::token::erc20::{␊
638+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
639+
};␊
630640
use openzeppelin::upgrades::interface::IUpgradeable;␊
631641
use openzeppelin::upgrades::UpgradeableComponent;␊
632642
use starknet::{ClassHash, ContractAddress};␊
@@ -687,6 +697,81 @@ Generated by [AVA](https://avajs.dev).
687697
}␊
688698
`
689699

700+
## erc20 votes, custom decimals
701+
702+
> Snapshot 1
703+
704+
`// SPDX-License-Identifier: MIT␊
705+
// Compatible with OpenZeppelin Contracts for Cairo ^2.0.0␊
706+
␊
707+
#[starknet::contract]␊
708+
mod MyToken {␊
709+
use openzeppelin::access::ownable::OwnableComponent;␊
710+
use openzeppelin::token::erc20::{ERC20Component, ERC20HooksEmptyImpl};␊
711+
use openzeppelin::upgrades::interface::IUpgradeable;␊
712+
use openzeppelin::upgrades::UpgradeableComponent;␊
713+
use starknet::{ClassHash, ContractAddress};␊
714+
␊
715+
component!(path: ERC20Component, storage: erc20, event: ERC20Event);␊
716+
component!(path: UpgradeableComponent, storage: upgradeable, event: UpgradeableEvent);␊
717+
component!(path: OwnableComponent, storage: ownable, event: OwnableEvent);␊
718+
␊
719+
// External␊
720+
#[abi(embed_v0)]␊
721+
impl ERC20MixinImpl = ERC20Component::ERC20MixinImpl<ContractState>;␊
722+
#[abi(embed_v0)]␊
723+
impl OwnableMixinImpl = OwnableComponent::OwnableMixinImpl<ContractState>;␊
724+
␊
725+
// Internal␊
726+
impl ERC20InternalImpl = ERC20Component::InternalImpl<ContractState>;␊
727+
impl UpgradeableInternalImpl = UpgradeableComponent::InternalImpl<ContractState>;␊
728+
impl OwnableInternalImpl = OwnableComponent::InternalImpl<ContractState>;␊
729+
␊
730+
#[storage]␊
731+
struct Storage {␊
732+
#[substorage(v0)]␊
733+
erc20: ERC20Component::Storage,␊
734+
#[substorage(v0)]␊
735+
upgradeable: UpgradeableComponent::Storage,␊
736+
#[substorage(v0)]␊
737+
ownable: OwnableComponent::Storage,␊
738+
}␊
739+
␊
740+
#[event]␊
741+
#[derive(Drop, starknet::Event)]␊
742+
enum Event {␊
743+
#[flat]␊
744+
ERC20Event: ERC20Component::Event,␊
745+
#[flat]␊
746+
UpgradeableEvent: UpgradeableComponent::Event,␊
747+
#[flat]␊
748+
OwnableEvent: OwnableComponent::Event,␊
749+
}␊
750+
␊
751+
#[constructor]␊
752+
fn constructor(ref self: ContractState, owner: ContractAddress) {␊
753+
self.erc20.initializer("MyToken", "MTK");␊
754+
self.ownable.initializer(owner);␊
755+
}␊
756+
␊
757+
impl ERC20ImmutableConfig of ERC20Component::ImmutableConfig {␊
758+
const DECIMALS: u8 = 6;␊
759+
}␊
760+
␊
761+
//␊
762+
// Upgradeable␊
763+
//␊
764+
␊
765+
#[abi(embed_v0)]␊
766+
impl UpgradeableImpl of IUpgradeable<ContractState> {␊
767+
fn upgrade(ref self: ContractState, new_class_hash: ClassHash) {␊
768+
self.ownable.assert_only_owner();␊
769+
self.upgradeable.upgrade(new_class_hash);␊
770+
}␊
771+
}␊
772+
}␊
773+
`
774+
690775
## erc20 mintable
691776

692777
> Snapshot 1
@@ -697,7 +782,9 @@ Generated by [AVA](https://avajs.dev).
697782
#[starknet::contract]␊
698783
mod MyToken {␊
699784
use openzeppelin::access::ownable::OwnableComponent;␊
700-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
785+
use openzeppelin::token::erc20::{␊
786+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
787+
};␊
701788
use openzeppelin::upgrades::interface::IUpgradeable;␊
702789
use openzeppelin::upgrades::UpgradeableComponent;␊
703790
use starknet::{ClassHash, ContractAddress};␊
@@ -782,7 +869,9 @@ Generated by [AVA](https://avajs.dev).
782869
mod MyToken {␊
783870
use openzeppelin::access::accesscontrol::{AccessControlComponent, DEFAULT_ADMIN_ROLE};␊
784871
use openzeppelin::introspection::src5::SRC5Component;␊
785-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component, ERC20HooksEmptyImpl};␊
872+
use openzeppelin::token::erc20::{␊
873+
DefaultConfig as ERC20DefaultConfig, ERC20Component, ERC20HooksEmptyImpl␊
874+
};␊
786875
use openzeppelin::upgrades::interface::IUpgradeable;␊
787876
use openzeppelin::upgrades::UpgradeableComponent;␊
788877
use starknet::{ClassHash, ContractAddress};␊
@@ -879,7 +968,7 @@ Generated by [AVA](https://avajs.dev).
879968
mod MyToken {␊
880969
use openzeppelin::access::ownable::OwnableComponent;␊
881970
use openzeppelin::governance::votes::VotesComponent;␊
882-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
971+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
883972
use openzeppelin::upgrades::interface::IUpgradeable;␊
884973
use openzeppelin::upgrades::UpgradeableComponent;␊
885974
use openzeppelin::utils::cryptography::nonces::NoncesComponent;␊
@@ -994,7 +1083,7 @@ Generated by [AVA](https://avajs.dev).
9941083
mod MyToken {␊
9951084
use openzeppelin::access::ownable::OwnableComponent;␊
9961085
use openzeppelin::governance::votes::VotesComponent;␊
997-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
1086+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
9981087
use openzeppelin::upgrades::interface::IUpgradeable;␊
9991088
use openzeppelin::upgrades::UpgradeableComponent;␊
10001089
use openzeppelin::utils::cryptography::nonces::NoncesComponent;␊
@@ -1108,7 +1197,7 @@ Generated by [AVA](https://avajs.dev).
11081197
#[starknet::contract]␊
11091198
mod MyToken {␊
11101199
use openzeppelin::governance::votes::VotesComponent;␊
1111-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
1200+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
11121201
use openzeppelin::utils::cryptography::nonces::NoncesComponent;␊
11131202
use openzeppelin::utils::cryptography::snip12::SNIP12Metadata;␊
11141203
use starknet::ContractAddress;␊
@@ -1195,7 +1284,7 @@ Generated by [AVA](https://avajs.dev).
11951284
use openzeppelin::access::ownable::OwnableComponent;␊
11961285
use openzeppelin::governance::votes::VotesComponent;␊
11971286
use openzeppelin::security::pausable::PausableComponent;␊
1198-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
1287+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
11991288
use openzeppelin::utils::cryptography::nonces::NoncesComponent;␊
12001289
use openzeppelin::utils::cryptography::snip12::SNIP12Metadata;␊
12011290
use starknet::{ContractAddress, get_caller_address};␊
@@ -1338,7 +1427,7 @@ Generated by [AVA](https://avajs.dev).
13381427
use openzeppelin::access::ownable::OwnableComponent;␊
13391428
use openzeppelin::governance::votes::VotesComponent;␊
13401429
use openzeppelin::security::pausable::PausableComponent;␊
1341-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
1430+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
13421431
use openzeppelin::upgrades::interface::IUpgradeable;␊
13431432
use openzeppelin::upgrades::UpgradeableComponent;␊
13441433
use openzeppelin::utils::cryptography::nonces::NoncesComponent;␊
@@ -1506,7 +1595,7 @@ Generated by [AVA](https://avajs.dev).
15061595
use openzeppelin::governance::votes::VotesComponent;␊
15071596
use openzeppelin::introspection::src5::SRC5Component;␊
15081597
use openzeppelin::security::pausable::PausableComponent;␊
1509-
use openzeppelin::token::erc20::{DefaultConfig, ERC20Component};␊
1598+
use openzeppelin::token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20Component};␊
15101599
use openzeppelin::upgrades::interface::IUpgradeable;␊
15111600
use openzeppelin::upgrades::UpgradeableComponent;␊
15121601
use openzeppelin::utils::cryptography::nonces::NoncesComponent;␊

‎packages/core/cairo/src/erc20.test.ts.snap‎

99 Bytes
Binary file not shown.

‎packages/core/cairo/src/erc20.ts‎

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { Contract } from './contract';
1+
import type { BaseImplementedTrait, Contract } from './contract';
22
import { ContractBuilder } from './contract';
33
import type { Access } from './set-access-control';
44
import { requireAccessControl, setAccessControl } from './set-access-control';
@@ -16,9 +16,12 @@ import { externalTrait } from './external-trait';
1616
import { toByteArray, toFelt252, toUint } from './utils/convert-strings';
1717
import { addVotesComponent } from './common-components';
1818

19+
const DEFAULT_DECIMALS = BigInt(18);
20+
1921
export const defaults: Required<ERC20Options> = {
2022
name: 'MyToken',
2123
symbol: 'MTK',
24+
decimals: DEFAULT_DECIMALS.toString(),
2225
burnable: false,
2326
pausable: false,
2427
premint: '0',
@@ -38,6 +41,7 @@ export function printERC20(opts: ERC20Options = defaults): string {
3841
export interface ERC20Options extends CommonContractOptions {
3942
name: string;
4043
symbol: string;
44+
decimals?: string;
4145
burnable?: boolean;
4246
pausable?: boolean;
4347
premint?: string;
@@ -51,6 +55,7 @@ function withDefaults(opts: ERC20Options): Required<ERC20Options> {
5155
return {
5256
...opts,
5357
...withCommonContractDefaults(opts),
58+
decimals: opts.decimals ?? defaults.decimals,
5459
burnable: opts.burnable ?? defaults.burnable,
5560
pausable: opts.pausable ?? defaults.pausable,
5661
premint: opts.premint || defaults.premint,
@@ -67,14 +72,14 @@ export function isAccessControlRequired(opts: Partial<ERC20Options>): boolean {
6772

6873
export function buildERC20(opts: ERC20Options): Contract {
6974
const c = new ContractBuilder(opts.name);
70-
7175
const allOpts = withDefaults(opts);
76+
const decimals = toUint(allOpts.decimals, 'decimals', 'u8');
7277

73-
addBase(c, toByteArray(allOpts.name), toByteArray(allOpts.symbol));
78+
addBase(c, toByteArray(allOpts.name), toByteArray(allOpts.symbol), decimals);
7479
addERC20Mixin(c);
7580

7681
if (allOpts.premint) {
77-
addPremint(c, allOpts.premint);
82+
addPremint(c, allOpts.premint, decimals);
7883
}
7984

8085
if (allOpts.pausable) {
@@ -183,9 +188,26 @@ function addERC20Mixin(c: ContractBuilder) {
183188
});
184189
}
185190

186-
function addBase(c: ContractBuilder, name: string, symbol: string) {
187-
c.addUseClause('openzeppelin::token::erc20', 'DefaultConfig');
191+
function addBase(c: ContractBuilder, name: string, symbol: string, decimals: bigint) {
192+
// Add ERC20 component
188193
c.addComponent(components.ERC20Component, [name, symbol], true);
194+
195+
// Add config with decimals
196+
if (decimals === DEFAULT_DECIMALS) {
197+
c.addUseClause('openzeppelin::token::erc20', 'DefaultConfig', { alias: 'ERC20DefaultConfig' });
198+
} else {
199+
const trait: BaseImplementedTrait = {
200+
name: 'ERC20ImmutableConfig',
201+
of: 'ERC20Component::ImmutableConfig',
202+
tags: [],
203+
};
204+
c.addImplementedTrait(trait);
205+
c.addSuperVariableToTrait(trait, {
206+
name: 'DECIMALS',
207+
type: 'u8',
208+
value: decimals.toString(),
209+
});
210+
}
189211
}
190212

191213
function addBurnable(c: ContractBuilder) {
@@ -195,15 +217,15 @@ function addBurnable(c: ContractBuilder) {
195217

196218
export const premintPattern = /^(\d*\.?\d*)$/;
197219

198-
function addPremint(c: ContractBuilder, amount: string) {
220+
function addPremint(c: ContractBuilder, amount: string, decimals: bigint) {
199221
if (amount !== undefined && amount !== '0') {
200222
if (!premintPattern.test(amount)) {
201223
throw new OptionsError({
202224
premint: 'Not a valid number',
203225
});
204226
}
205227

206-
const premintAbsolute = toUint(getInitialSupply(amount, 18), 'premint', 'u256');
228+
const premintAbsolute = toUint(getInitialSupply(amount, Number(decimals)), 'premint', 'u256');
207229

208230
c.addUseClause('starknet', 'ContractAddress');
209231
c.addConstructorArgument({ name: 'recipient', type: 'ContractAddress' });

0 commit comments

Comments
 (0)