Refactor stablecoin to build based on erc20 (#434)

OpenZeppelin · Feb 5, 2025 · ac93b6c · ac93b6c
1 parent f17b18f
commit ac93b6c
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 276 deletions.
diff --git a/packages/core/src/build-generic.ts b/packages/core/src/build-generic.ts
@@ -4,6 +4,7 @@ import { ERC721Options, buildERC721 } from './erc721';
 import { ERC1155Options, buildERC1155 } from './erc1155';
 import { StablecoinOptions, buildStablecoin } from './stablecoin';
 import { GovernorOptions, buildGovernor } from './governor';
+import { Contract } from './contract';
 
 export interface KindedOptions {
   ERC20:    { kind: 'ERC20' }    & ERC20Options;
@@ -17,7 +18,7 @@ export interface KindedOptions {
 
 export type GenericOptions = KindedOptions[keyof KindedOptions];
 
-export function buildGeneric(opts: GenericOptions) {
+export function buildGeneric(opts: GenericOptions): Contract {
   switch (opts.kind) {
     case 'ERC20':
       return buildERC20(opts);

diff --git a/packages/core/src/erc20.ts b/packages/core/src/erc20.ts
@@ -39,7 +39,7 @@ export const defaults: Required<ERC20Options> = {
   info: commonDefaults.info,
 } as const;
 
-function withDefaults(opts: ERC20Options): Required<ERC20Options> {
+export function withDefaults(opts: ERC20Options): Required<ERC20Options> {
   return {
     ...opts,
     ...withCommonDefaults(opts),
@@ -61,7 +61,7 @@ export function isAccessControlRequired(opts: Partial<ERC20Options>): boolean {
   return opts.mintable || opts.pausable || opts.upgradeable === 'uups';
 }
 
-export function buildERC20(opts: ERC20Options): Contract {
+export function buildERC20(opts: ERC20Options): ContractBuilder {
   const allOpts = withDefaults(opts);
 
   const c = new ContractBuilder(allOpts.name);
@@ -118,6 +118,7 @@ function addBase(c: ContractBuilder, name: string, symbol: string) {
   );
 
   c.addOverride(ERC20, functions._update);
+  c.addOverride(ERC20, functions._approve); // allows override from stablecoin
 }
 
 function addPausableExtension(c: ContractBuilder, access: Access) {
@@ -202,7 +203,7 @@ function addFlashMint(c: ContractBuilder) {
   });
 }
 
-const functions = defineFunctions({
+export const functions = defineFunctions({
   _update: {
     kind: 'internal' as const,
     args: [
@@ -212,6 +213,16 @@ const functions = defineFunctions({
     ],
   },
 
+  _approve: {
+    kind: 'internal' as const,
+    args: [
+      { name: 'owner', type: 'address' },
+      { name: 'spender', type: 'address' },
+      { name: 'value', type: 'uint256' },
+      { name: 'emitEvent', type: 'bool' },
+    ],
+  },
+
   mint: {
     kind: 'public' as const,
     args: [

diff --git a/packages/core/src/stablecoin.test.ts.md b/packages/core/src/stablecoin.test.ts.md
@@ -315,11 +315,11 @@ Generated by [AVA](https://avajs.dev).
     import {ERC20Permit} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";␊
     import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";␊
     ␊
-    contract MyStablecoin is ERC20, ERC20Custodian, Ownable, ERC20Permit {␊
+    contract MyStablecoin is ERC20, ERC20Permit, ERC20Custodian, Ownable {␊
         constructor(address initialOwner)␊
             ERC20("MyStablecoin", "MST")␊
-            Ownable(initialOwner)␊
             ERC20Permit("MyStablecoin")␊
+            Ownable(initialOwner)␊
         {}␊
     ␊
         function _isCustodian(address user) internal view override returns (bool) {␊
@@ -350,11 +350,11 @@ Generated by [AVA](https://avajs.dev).
     import {ERC20Permit} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";␊
     import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";␊
     ␊
-    contract MyStablecoin is ERC20, ERC20Allowlist, Ownable, ERC20Permit {␊
+    contract MyStablecoin is ERC20, ERC20Permit, ERC20Allowlist, Ownable {␊
         constructor(address initialOwner)␊
             ERC20("MyStablecoin", "MST")␊
-            Ownable(initialOwner)␊
             ERC20Permit("MyStablecoin")␊
+            Ownable(initialOwner)␊
         {}␊
     ␊
         function allowUser(address user) public onlyOwner {␊
@@ -396,11 +396,11 @@ Generated by [AVA](https://avajs.dev).
     import {ERC20Permit} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";␊
     import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";␊
     ␊
-    contract MyStablecoin is ERC20, ERC20Blocklist, Ownable, ERC20Permit {␊
+    contract MyStablecoin is ERC20, ERC20Permit, ERC20Blocklist, Ownable {␊
         constructor(address initialOwner)␊
             ERC20("MyStablecoin", "MST")␊
-            Ownable(initialOwner)␊
             ERC20Permit("MyStablecoin")␊
+            Ownable(initialOwner)␊
         {}␊
     ␊
         function blockUser(address user) public onlyOwner {␊

diff --git a/packages/core/src/stablecoin.test.ts.snap b/packages/core/src/stablecoin.test.ts.snap