Merge branch 'feat/config' of github.com:NeokingdomDAO/whitelabel int…

…o feat/config

contracts/extensions/IProxyAdmin.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts v4.4.1 (proxy/transparent/ProxyAdmin.sol)
+
+pragma solidity ^0.8.16;
+
+interface IProxyAdmin {
+    /**
+     * @dev Transfers ownership of the contract to a new account (`newOwner`).
+     * Can only be called by the current owner.
+     */
+    function transferOwnership(address newOwner) external;
+}

lib/internal/core.ts

@@ -132,9 +132,18 @@ export abstract class NeokingdomDAO {
     for (let i = nextStep; i < s.length; i++) {
       const context = await c(this);
       const step = s[i];
+
       if (this.config.verbose) {
-        console.log(`${i + 1}/${s.length}: ${step.toString()}`);
+        console.log(
+          `${i + 1}/${s.length}: ${step ? step.toString() : "step is empty"}`
+        );
+      }
+
+      // If a step is null, it's skipped
+      if (step === null) {
+        continue;
       }
+
       let tx: TransactionResponse | null = null;
       try {
         tx = await step(context);

lib/internal/types.ts

@@ -1,7 +1,4 @@
 import { TransactionResponse } from "@ethersproject/providers";
-import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
-import { Wallet } from "ethers";
-import { HardhatRuntimeEnvironment } from "hardhat/types";
 
 import {
   DAORoles,
@@ -46,7 +43,9 @@ export type Contributor = {
   name?: string;
   address: string;
   status: "contributor" | "board" | "investor";
-  tokens: string;
+  shareBalance: string;
+  balance?: string;
+  vestingBalance?: string;
 };
 
 export type Address = `0x${string}`;
@@ -63,6 +62,7 @@ export type DAOConfig = {
   reserveAddress: Address;
   usdcAddress: Address;
   diaOracleAddress: Address;
+  shareCapital: string;
   contributors: Contributor[];
 };
 
@@ -87,19 +87,21 @@ export type Context = {};
 
 export type ContractContext = Context & NeokingdomContracts;
 
-export type Step<T extends Context> = (c: T) => Promise<TransactionResponse>;
+export type Step<T extends Context> = (
+  c: T
+) => Promise<TransactionResponse> | null;
 
 export type StepWithExpandable<T extends Context> =
   | ExpandableStep<T>
-  | ((c: T) => Promise<TransactionResponse>);
+  | ((c: T) => Promise<TransactionResponse> | null);
 
 export type ExpandableStep<T extends Context> = {
   expandableFunction: (c: T) => ProcessedSequence<T>;
 };
 
 export type Sequence<T extends Context> = StepWithExpandable<T>[];
 
-export type ProcessedSequence<T extends Context> = Step<T>[];
+export type ProcessedSequence<T extends Context> = (Step<T> | null)[];
 
 // FIXME: There Must Be A Better Way™ to do this in TypeScript
 export const CONTRACT_NAMES = [
@@ -126,26 +128,3 @@ export function isNeokingdomContracts(
   }
   return true;
 }
-
-export type SetupContext = ContractContext & {
-  deployer: Wallet | SignerWithAddress;
-  contributors: Contributor[];
-  hre: HardhatRuntimeEnvironment;
-};
-
-export function generateSetupContext(
-  contributors: Contributor[],
-  hre: HardhatRuntimeEnvironment
-) {
-  async function _generateSetupContext(n: NeokingdomDAO) {
-    const contracts = (await n.loadContractsPartial()) as NeokingdomContracts;
-    const context: SetupContext = {
-      ...contracts,
-      contributors: contributors,
-      deployer: n.config.deployer,
-      hre: hre,
-    };
-    return context;
-  }
-  return _generateSetupContext;
-}

lib/sequence/deploy.ts

@@ -4,29 +4,17 @@ import { Wallet } from "ethers";
 
 import { NeokingdomDAO } from "../internal/core";
 import type {
-  ContextGenerator,
   ContractContext,
   ContractNames,
+  DAOConfig,
   NeokingdomContracts,
   Sequence,
 } from "../internal/types";
 import { ROLES } from "../utils";
 
-export type DeployConfig = {
-  tokenName: string;
-  tokenSymbol: string;
-  governanceTokenName: string;
-  governanceTokenSymbol: string;
-  shareTokenName: string;
-  shareTokenSymbol: string;
-  reserveAddress: string;
-  usdcAddress: string;
-  diaOracleAddress: string;
-};
-
 export type DeployContext = ContractContext & {
   deployer: Wallet | SignerWithAddress;
-  config: DeployConfig;
+  config: DAOConfig;
   deploy: (
     contractName: ContractNames,
     args?: any[]
@@ -37,7 +25,7 @@ export type DeployContext = ContractContext & {
   ) => Promise<TransactionResponse>;
 };
 
-export function generateDeployContext(config: DeployConfig) {
+export function generateDeployContext(config: DAOConfig) {
   async function _generateDeployContext(neokingdomDAO: NeokingdomDAO) {
     const contracts =
       (await neokingdomDAO.loadContractsPartial()) as NeokingdomContracts;