@gooddollar/goodcollective-contracts 1.2.0 → 1.3.0

package/typechain-types/contracts/UBI/{UBIPool.sol/UBIPool.ts → UBIPool.ts}

@@ -26,30 +26,30 @@ import type {
   TypedListener,
   OnEvent,
   PromiseOrValue,
-} from "../../../common";
+} from "../../common";
+
+export type PoolSettingsStruct = {
+  manager: PromiseOrValue<string>;
+  membersValidator: PromiseOrValue<string>;
+  uniquenessValidator: PromiseOrValue<string>;
+  rewardToken: PromiseOrValue<string>;
+};
+
+export type PoolSettingsStructOutput = [string, string, string, string] & {
+  manager: string;
+  membersValidator: string;
+  uniquenessValidator: string;
+  rewardToken: string;
+};
 
 export declare namespace UBIPool {
-  export type PoolSettingsStruct = {
-    manager: PromiseOrValue<string>;
-    membersValidator: PromiseOrValue<string>;
-    uniquenessValidator: PromiseOrValue<string>;
-    rewardToken: PromiseOrValue<string>;
-  };
-
-  export type PoolSettingsStructOutput = [string, string, string, string] & {
-    manager: string;
-    membersValidator: string;
-    uniquenessValidator: string;
-    rewardToken: string;
-  };
-
   export type UBISettingsStruct = {
     cycleLengthDays: PromiseOrValue<BigNumberish>;
     claimPeriodDays: PromiseOrValue<BigNumberish>;
     minActiveUsers: PromiseOrValue<BigNumberish>;
     claimForEnabled: PromiseOrValue<boolean>;
     maxClaimAmount: PromiseOrValue<BigNumberish>;
-    maxClaimers: PromiseOrValue<BigNumberish>;
+    maxMembers: PromiseOrValue<BigNumberish>;
     onlyMembers: PromiseOrValue<boolean>;
   };
 
@@ -67,9 +67,21 @@ export declare namespace UBIPool {
     minActiveUsers: number;
     claimForEnabled: boolean;
     maxClaimAmount: BigNumber;
-    maxClaimers: number;
+    maxMembers: number;
     onlyMembers: boolean;
   };
+
+  export type ExtendedSettingsStruct = {
+    maxPeriodClaimers: PromiseOrValue<BigNumberish>;
+    minClaimAmount: PromiseOrValue<BigNumberish>;
+    managerFeeBps: PromiseOrValue<BigNumberish>;
+  };
+
+  export type ExtendedSettingsStructOutput = [number, BigNumber, number] & {
+    maxPeriodClaimers: number;
+    minClaimAmount: BigNumber;
+    managerFeeBps: number;
+  };
 }
 
 export declare namespace HelperLibrary {
@@ -116,8 +128,11 @@ export interface UBIPoolInterface extends utils.Interface {
     "claim()": FunctionFragment;
     "claimFor(address,bool)": FunctionFragment;
     "currentDayInCycle()": FunctionFragment;
+    "distributionFormula()": FunctionFragment;
     "estimateNextDailyUBI()": FunctionFragment;
+    "extendedSettings()": FunctionFragment;
     "getCurrentDay()": FunctionFragment;
+    "getManagerFee()": FunctionFragment;
     "getRealtimeContribution(address)": FunctionFragment;
     "getRealtimeStats()": FunctionFragment;
     "getRegistry()": FunctionFragment;
@@ -127,7 +142,7 @@ export interface UBIPoolInterface extends utils.Interface {
     "hasClaimed(address)": FunctionFragment;
     "hasRole(bytes32,address)": FunctionFragment;
     "host()": FunctionFragment;
-    "initialize((address,address,address,address),(uint32,uint32,uint32,bool,uint256,uint32,bool),address)": FunctionFragment;
+    "initialize((address,address,address,address),(uint32,uint32,uint32,bool,uint256,uint32,bool),(uint32,uint256,uint32),address)": FunctionFragment;
     "isAcceptedSuperToken(address)": FunctionFragment;
     "nextClaimTime()": FunctionFragment;
     "onTokenTransfer(address,uint256,bytes)": FunctionFragment;
@@ -137,7 +152,7 @@ export interface UBIPoolInterface extends utils.Interface {
     "renounceRole(bytes32,address)": FunctionFragment;
     "revokeRole(bytes32,address)": FunctionFragment;
     "setPoolSettings((address,address,address,address))": FunctionFragment;
-    "setUBISettings((uint32,uint32,uint32,bool,uint256,uint32,bool))": FunctionFragment;
+    "setUBISettings((uint32,uint32,uint32,bool,uint256,uint32,bool),(uint32,uint256,uint32))": FunctionFragment;
     "settings()": FunctionFragment;
     "stats()": FunctionFragment;
     "status()": FunctionFragment;
@@ -173,8 +188,11 @@ export interface UBIPoolInterface extends utils.Interface {
       | "claim"
       | "claimFor"
       | "currentDayInCycle"
+      | "distributionFormula"
       | "estimateNextDailyUBI"
+      | "extendedSettings"
       | "getCurrentDay"
+      | "getManagerFee"
       | "getRealtimeContribution"
       | "getRealtimeStats"
       | "getRegistry"
@@ -315,14 +333,26 @@ export interface UBIPoolInterface extends utils.Interface {
     functionFragment: "currentDayInCycle",
     values?: undefined
   ): string;
+  encodeFunctionData(
+    functionFragment: "distributionFormula",
+    values?: undefined
+  ): string;
   encodeFunctionData(
     functionFragment: "estimateNextDailyUBI",
     values?: undefined
   ): string;
+  encodeFunctionData(
+    functionFragment: "extendedSettings",
+    values?: undefined
+  ): string;
   encodeFunctionData(
     functionFragment: "getCurrentDay",
     values?: undefined
   ): string;
+  encodeFunctionData(
+    functionFragment: "getManagerFee",
+    values?: undefined
+  ): string;
   encodeFunctionData(
     functionFragment: "getRealtimeContribution",
     values: [PromiseOrValue<string>]
@@ -363,8 +393,9 @@ export interface UBIPoolInterface extends utils.Interface {
   encodeFunctionData(
     functionFragment: "initialize",
     values: [
-      UBIPool.PoolSettingsStruct,
+      PoolSettingsStruct,
       UBIPool.UBISettingsStruct,
+      UBIPool.ExtendedSettingsStruct,
       PromiseOrValue<string>
     ]
   ): string;
@@ -403,11 +434,11 @@ export interface UBIPoolInterface extends utils.Interface {
   ): string;
   encodeFunctionData(
     functionFragment: "setPoolSettings",
-    values: [UBIPool.PoolSettingsStruct]
+    values: [PoolSettingsStruct]
   ): string;
   encodeFunctionData(
     functionFragment: "setUBISettings",
-    values: [UBIPool.UBISettingsStruct]
+    values: [UBIPool.UBISettingsStruct, UBIPool.ExtendedSettingsStruct]
   ): string;
   encodeFunctionData(functionFragment: "settings", values?: undefined): string;
   encodeFunctionData(functionFragment: "stats", values?: undefined): string;
@@ -518,14 +549,26 @@ export interface UBIPoolInterface extends utils.Interface {
     functionFragment: "currentDayInCycle",
     data: BytesLike
   ): Result;
+  decodeFunctionResult(
+    functionFragment: "distributionFormula",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
     functionFragment: "estimateNextDailyUBI",
     data: BytesLike
   ): Result;
+  decodeFunctionResult(
+    functionFragment: "extendedSettings",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
     functionFragment: "getCurrentDay",
     data: BytesLike
   ): Result;
+  decodeFunctionResult(
+    functionFragment: "getManagerFee",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
     functionFragment: "getRealtimeContribution",
     data: BytesLike
@@ -671,10 +714,10 @@ export type InitializedEvent = TypedEvent<[number], InitializedEventObject>;
 export type InitializedEventFilter = TypedEventFilter<InitializedEvent>;
 
 export interface PoolSettingsChangedEventObject {
-  settings: UBIPool.PoolSettingsStructOutput;
+  settings: PoolSettingsStructOutput;
 }
 export type PoolSettingsChangedEvent = TypedEvent<
-  [UBIPool.PoolSettingsStructOutput],
+  [PoolSettingsStructOutput],
   PoolSettingsChangedEventObject
 >;
 
@@ -915,10 +958,30 @@ export interface UBIPool extends BaseContract {
 
     currentDayInCycle(overrides?: CallOverrides): Promise<[BigNumber]>;
 
-    estimateNextDailyUBI(overrides?: CallOverrides): Promise<[BigNumber]>;
+    distributionFormula(
+      overrides?: Overrides & { from?: PromiseOrValue<string> }
+    ): Promise<ContractTransaction>;
+
+    estimateNextDailyUBI(
+      overrides?: CallOverrides
+    ): Promise<[BigNumber] & { nextDailyUbi: BigNumber }>;
+
+    extendedSettings(
+      overrides?: CallOverrides
+    ): Promise<
+      [number, BigNumber, number] & {
+        maxPeriodClaimers: number;
+        minClaimAmount: BigNumber;
+        managerFeeBps: number;
+      }
+    >;
 
     getCurrentDay(overrides?: CallOverrides): Promise<[BigNumber]>;
 
+    getManagerFee(
+      overrides?: CallOverrides
+    ): Promise<[string, number] & { feeRecipient: string; feeBps: number }>;
+
     getRealtimeContribution(
       _user: PromiseOrValue<string>,
       overrides?: CallOverrides
@@ -927,11 +990,22 @@ export interface UBIPool extends BaseContract {
     getRealtimeStats(
       overrides?: CallOverrides
     ): Promise<
-      [BigNumber, BigNumber, BigNumber, BigNumber] & {
+      [
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber
+      ] & {
         netIncome: BigNumber;
         totalFees: BigNumber;
+        protocolFees: BigNumber;
+        managerFees: BigNumber;
         incomeFlowRate: BigNumber;
         feeRate: BigNumber;
+        managerFeeRate: BigNumber;
       }
     >;
 
@@ -969,8 +1043,9 @@ export interface UBIPool extends BaseContract {
     host(overrides?: CallOverrides): Promise<[string]>;
 
     initialize(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       _registry: PromiseOrValue<string>,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<ContractTransaction>;
@@ -1011,12 +1086,13 @@ export interface UBIPool extends BaseContract {
     ): Promise<ContractTransaction>;
 
     setPoolSettings(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<ContractTransaction>;
 
     setUBISettings(
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<ContractTransaction>;
 
@@ -1034,12 +1110,24 @@ export interface UBIPool extends BaseContract {
     stats(
       overrides?: CallOverrides
     ): Promise<
-      [BigNumber, BigNumber, BigNumber, string, BigNumber] & {
+      [
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        string,
+        BigNumber,
+        string,
+        BigNumber,
+        BigNumber
+      ] & {
         netIncome: BigNumber;
         totalFees: BigNumber;
         lastUpdate: BigNumber;
         lastFeeRecipient: string;
         lastIncomeRate: BigNumber;
+        lastManagerFeeRecipient: string;
+        protocolFees: BigNumber;
+        managerFees: BigNumber;
       }
     >;
 
@@ -1063,7 +1151,7 @@ export interface UBIPool extends BaseContract {
         currentCycleLength: BigNumber;
         periodClaimers: BigNumber;
         periodDistributed: BigNumber;
-        claimersCount: number;
+        membersCount: number;
       }
     >;
 
@@ -1110,7 +1198,7 @@ export interface UBIPool extends BaseContract {
         minActiveUsers: number;
         claimForEnabled: boolean;
         maxClaimAmount: BigNumber;
-        maxClaimers: number;
+        maxMembers: number;
         onlyMembers: boolean;
       }
     >;
@@ -1228,10 +1316,28 @@ export interface UBIPool extends BaseContract {
 
   currentDayInCycle(overrides?: CallOverrides): Promise<BigNumber>;
 
+  distributionFormula(
+    overrides?: Overrides & { from?: PromiseOrValue<string> }
+  ): Promise<ContractTransaction>;
+
   estimateNextDailyUBI(overrides?: CallOverrides): Promise<BigNumber>;
 
+  extendedSettings(
+    overrides?: CallOverrides
+  ): Promise<
+    [number, BigNumber, number] & {
+      maxPeriodClaimers: number;
+      minClaimAmount: BigNumber;
+      managerFeeBps: number;
+    }
+  >;
+
   getCurrentDay(overrides?: CallOverrides): Promise<BigNumber>;
 
+  getManagerFee(
+    overrides?: CallOverrides
+  ): Promise<[string, number] & { feeRecipient: string; feeBps: number }>;
+
   getRealtimeContribution(
     _user: PromiseOrValue<string>,
     overrides?: CallOverrides
@@ -1240,11 +1346,22 @@ export interface UBIPool extends BaseContract {
   getRealtimeStats(
     overrides?: CallOverrides
   ): Promise<
-    [BigNumber, BigNumber, BigNumber, BigNumber] & {
+    [
+      BigNumber,
+      BigNumber,
+      BigNumber,
+      BigNumber,
+      BigNumber,
+      BigNumber,
+      BigNumber
+    ] & {
       netIncome: BigNumber;
       totalFees: BigNumber;
+      protocolFees: BigNumber;
+      managerFees: BigNumber;
       incomeFlowRate: BigNumber;
       feeRate: BigNumber;
+      managerFeeRate: BigNumber;
     }
   >;
 
@@ -1282,8 +1399,9 @@ export interface UBIPool extends BaseContract {
   host(overrides?: CallOverrides): Promise<string>;
 
   initialize(
-    _settings: UBIPool.PoolSettingsStruct,
+    _settings: PoolSettingsStruct,
     _ubiSettings: UBIPool.UBISettingsStruct,
+    _extendedSettings: UBIPool.ExtendedSettingsStruct,
     _registry: PromiseOrValue<string>,
     overrides?: Overrides & { from?: PromiseOrValue<string> }
   ): Promise<ContractTransaction>;
@@ -1324,12 +1442,13 @@ export interface UBIPool extends BaseContract {
   ): Promise<ContractTransaction>;
 
   setPoolSettings(
-    _settings: UBIPool.PoolSettingsStruct,
+    _settings: PoolSettingsStruct,
     overrides?: Overrides & { from?: PromiseOrValue<string> }
   ): Promise<ContractTransaction>;
 
   setUBISettings(
     _ubiSettings: UBIPool.UBISettingsStruct,
+    _extendedSettings: UBIPool.ExtendedSettingsStruct,
     overrides?: Overrides & { from?: PromiseOrValue<string> }
   ): Promise<ContractTransaction>;
 
@@ -1347,12 +1466,24 @@ export interface UBIPool extends BaseContract {
   stats(
     overrides?: CallOverrides
   ): Promise<
-    [BigNumber, BigNumber, BigNumber, string, BigNumber] & {
+    [
+      BigNumber,
+      BigNumber,
+      BigNumber,
+      string,
+      BigNumber,
+      string,
+      BigNumber,
+      BigNumber
+    ] & {
       netIncome: BigNumber;
       totalFees: BigNumber;
       lastUpdate: BigNumber;
       lastFeeRecipient: string;
       lastIncomeRate: BigNumber;
+      lastManagerFeeRecipient: string;
+      protocolFees: BigNumber;
+      managerFees: BigNumber;
     }
   >;
 
@@ -1376,7 +1507,7 @@ export interface UBIPool extends BaseContract {
       currentCycleLength: BigNumber;
       periodClaimers: BigNumber;
       periodDistributed: BigNumber;
-      claimersCount: number;
+      membersCount: number;
     }
   >;
 
@@ -1423,7 +1554,7 @@ export interface UBIPool extends BaseContract {
       minActiveUsers: number;
       claimForEnabled: boolean;
       maxClaimAmount: BigNumber;
-      maxClaimers: number;
+      maxMembers: number;
       onlyMembers: boolean;
     }
   >;
@@ -1539,10 +1670,26 @@ export interface UBIPool extends BaseContract {
 
     currentDayInCycle(overrides?: CallOverrides): Promise<BigNumber>;
 
+    distributionFormula(overrides?: CallOverrides): Promise<BigNumber>;
+
     estimateNextDailyUBI(overrides?: CallOverrides): Promise<BigNumber>;
 
+    extendedSettings(
+      overrides?: CallOverrides
+    ): Promise<
+      [number, BigNumber, number] & {
+        maxPeriodClaimers: number;
+        minClaimAmount: BigNumber;
+        managerFeeBps: number;
+      }
+    >;
+
     getCurrentDay(overrides?: CallOverrides): Promise<BigNumber>;
 
+    getManagerFee(
+      overrides?: CallOverrides
+    ): Promise<[string, number] & { feeRecipient: string; feeBps: number }>;
+
     getRealtimeContribution(
       _user: PromiseOrValue<string>,
       overrides?: CallOverrides
@@ -1551,11 +1698,22 @@ export interface UBIPool extends BaseContract {
     getRealtimeStats(
       overrides?: CallOverrides
     ): Promise<
-      [BigNumber, BigNumber, BigNumber, BigNumber] & {
+      [
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        BigNumber
+      ] & {
         netIncome: BigNumber;
         totalFees: BigNumber;
+        protocolFees: BigNumber;
+        managerFees: BigNumber;
         incomeFlowRate: BigNumber;
         feeRate: BigNumber;
+        managerFeeRate: BigNumber;
       }
     >;
 
@@ -1593,8 +1751,9 @@ export interface UBIPool extends BaseContract {
     host(overrides?: CallOverrides): Promise<string>;
 
     initialize(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       _registry: PromiseOrValue<string>,
       overrides?: CallOverrides
     ): Promise<void>;
@@ -1635,12 +1794,13 @@ export interface UBIPool extends BaseContract {
     ): Promise<void>;
 
     setPoolSettings(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       overrides?: CallOverrides
     ): Promise<void>;
 
     setUBISettings(
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       overrides?: CallOverrides
     ): Promise<void>;
 
@@ -1658,12 +1818,24 @@ export interface UBIPool extends BaseContract {
     stats(
       overrides?: CallOverrides
     ): Promise<
-      [BigNumber, BigNumber, BigNumber, string, BigNumber] & {
+      [
+        BigNumber,
+        BigNumber,
+        BigNumber,
+        string,
+        BigNumber,
+        string,
+        BigNumber,
+        BigNumber
+      ] & {
         netIncome: BigNumber;
         totalFees: BigNumber;
         lastUpdate: BigNumber;
         lastFeeRecipient: string;
         lastIncomeRate: BigNumber;
+        lastManagerFeeRecipient: string;
+        protocolFees: BigNumber;
+        managerFees: BigNumber;
       }
     >;
 
@@ -1687,7 +1859,7 @@ export interface UBIPool extends BaseContract {
         currentCycleLength: BigNumber;
         periodClaimers: BigNumber;
         periodDistributed: BigNumber;
-        claimersCount: number;
+        membersCount: number;
       }
     >;
 
@@ -1734,7 +1906,7 @@ export interface UBIPool extends BaseContract {
         minActiveUsers: number;
         claimForEnabled: boolean;
         maxClaimAmount: BigNumber;
-        maxClaimers: number;
+        maxMembers: number;
         onlyMembers: boolean;
       }
     >;
@@ -1976,10 +2148,18 @@ export interface UBIPool extends BaseContract {
 
     currentDayInCycle(overrides?: CallOverrides): Promise<BigNumber>;
 
+    distributionFormula(
+      overrides?: Overrides & { from?: PromiseOrValue<string> }
+    ): Promise<BigNumber>;
+
     estimateNextDailyUBI(overrides?: CallOverrides): Promise<BigNumber>;
 
+    extendedSettings(overrides?: CallOverrides): Promise<BigNumber>;
+
     getCurrentDay(overrides?: CallOverrides): Promise<BigNumber>;
 
+    getManagerFee(overrides?: CallOverrides): Promise<BigNumber>;
+
     getRealtimeContribution(
       _user: PromiseOrValue<string>,
       overrides?: CallOverrides
@@ -2021,8 +2201,9 @@ export interface UBIPool extends BaseContract {
     host(overrides?: CallOverrides): Promise<BigNumber>;
 
     initialize(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       _registry: PromiseOrValue<string>,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<BigNumber>;
@@ -2063,12 +2244,13 @@ export interface UBIPool extends BaseContract {
     ): Promise<BigNumber>;
 
     setPoolSettings(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<BigNumber>;
 
     setUBISettings(
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<BigNumber>;
 
@@ -2224,12 +2406,20 @@ export interface UBIPool extends BaseContract {
 
     currentDayInCycle(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
+    distributionFormula(
+      overrides?: Overrides & { from?: PromiseOrValue<string> }
+    ): Promise<PopulatedTransaction>;
+
     estimateNextDailyUBI(
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
+    extendedSettings(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+
     getCurrentDay(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
+    getManagerFee(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+
     getRealtimeContribution(
       _user: PromiseOrValue<string>,
       overrides?: CallOverrides
@@ -2271,8 +2461,9 @@ export interface UBIPool extends BaseContract {
     host(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
     initialize(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       _registry: PromiseOrValue<string>,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<PopulatedTransaction>;
@@ -2313,12 +2504,13 @@ export interface UBIPool extends BaseContract {
     ): Promise<PopulatedTransaction>;
 
     setPoolSettings(
-      _settings: UBIPool.PoolSettingsStruct,
+      _settings: PoolSettingsStruct,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<PopulatedTransaction>;
 
     setUBISettings(
       _ubiSettings: UBIPool.UBISettingsStruct,
+      _extendedSettings: UBIPool.ExtendedSettingsStruct,
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<PopulatedTransaction>;