@metadaoproject/futarchy 0.6.0-aplha.8 → 0.7.0-alpha.1

package/dist/v0.6/types/{price_based_unlock.d.ts → price_based_performance_package.d.ts}

@@ -1,19 +1,21 @@
-export type PriceBasedUnlock = {
-    version: "0.1.0";
-    name: "price_based_unlock";
+export type PriceBasedPerformancePackage = {
+    version: "0.6.0";
+    name: "price_based_performance_package";
     constants: [
         {
-            name: "SEED";
-            type: "string";
-            value: '"anchor"';
+            name: "MAX_TRANCHES";
+            type: {
+                defined: "usize";
+            };
+            value: "10";
         }
     ];
     instructions: [
         {
-            name: "initializeLocker";
+            name: "initializePerformancePackage";
             accounts: [
                 {
-                    name: "locker";
+                    name: "performancePackage";
                     isMut: true;
                     isSigner: false;
                 },
@@ -30,19 +32,19 @@ export type PriceBasedUnlock = {
                     docs: ["The mint of the tokens to be locked"];
                 },
                 {
-                    name: "fromTokenAccount";
+                    name: "grantorTokenAccount";
                     isMut: true;
                     isSigner: false;
                     docs: ["The token account containing the tokens to be locked"];
                 },
                 {
-                    name: "tokenAuthority";
+                    name: "grantor";
                     isMut: false;
                     isSigner: true;
                     docs: ["The authority of the token account"];
                 },
                 {
-                    name: "lockerTokenAccount";
+                    name: "performancePackageTokenVault";
                     isMut: true;
                     isSigner: false;
                     docs: ["The locker's token account where tokens will be stored"];
@@ -82,7 +84,7 @@ export type PriceBasedUnlock = {
                 {
                     name: "params";
                     type: {
-                        defined: "InitializeLockerParams";
+                        defined: "InitializePerformancePackageParams";
                     };
                 }
             ];
@@ -91,7 +93,7 @@ export type PriceBasedUnlock = {
             name: "startUnlock";
             accounts: [
                 {
-                    name: "locker";
+                    name: "performancePackage";
                     isMut: true;
                     isSigner: false;
                 },
@@ -123,7 +125,7 @@ export type PriceBasedUnlock = {
             name: "completeUnlock";
             accounts: [
                 {
-                    name: "locker";
+                    name: "performancePackage";
                     isMut: true;
                     isSigner: false;
                 },
@@ -133,7 +135,7 @@ export type PriceBasedUnlock = {
                     isSigner: false;
                 },
                 {
-                    name: "lockerTokenAccount";
+                    name: "performancePackageTokenVault";
                     isMut: true;
                     isSigner: false;
                     docs: ["The token account where locked tokens are stored"];
@@ -200,12 +202,17 @@ export type PriceBasedUnlock = {
                     isSigner: false;
                 },
                 {
-                    name: "locker";
+                    name: "performancePackage";
                     isMut: true;
                     isSigner: false;
                 },
                 {
                     name: "proposer";
+                    isMut: false;
+                    isSigner: true;
+                },
+                {
+                    name: "payer";
                     isMut: true;
                     isSigner: true;
                 },
@@ -243,7 +250,7 @@ export type PriceBasedUnlock = {
                     isSigner: false;
                 },
                 {
-                    name: "locker";
+                    name: "performancePackage";
                     isMut: true;
                     isSigner: false;
                 },
@@ -259,10 +266,10 @@ export type PriceBasedUnlock = {
             args: [];
         },
         {
-            name: "changeLockerAuthority";
+            name: "changePerformancePackageAuthority";
             accounts: [
                 {
-                    name: "locker";
+                    name: "performancePackage";
                     isMut: true;
                     isSigner: false;
                 },
@@ -270,16 +277,13 @@ export type PriceBasedUnlock = {
                     name: "currentAuthority";
                     isMut: false;
                     isSigner: true;
-                    docs: [
-                        "Only the current locker authority can change the locker authority"
-                    ];
                 }
             ];
             args: [
                 {
                     name: "params";
                     type: {
-                        defined: "ChangeLockerAuthorityParams";
+                        defined: "ChangePerformancePackageAuthorityParams";
                     };
                 }
             ];
@@ -287,27 +291,31 @@ export type PriceBasedUnlock = {
     ];
     accounts: [
         {
-            name: "locker";
+            name: "performancePackage";
             type: {
                 kind: "struct";
                 fields: [
                     {
-                        name: "priceThreshold";
-                        docs: ["The price threshold for 100% unlocking (max price target)"];
-                        type: "u128";
+                        name: "tranches";
+                        docs: ["The tranches that make up the performance package"];
+                        type: {
+                            vec: {
+                                defined: "StoredTranche";
+                            };
+                        };
                     },
                     {
-                        name: "tokenAmount";
-                        docs: ["The amount of tokens locked"];
+                        name: "totalTokenAmount";
+                        docs: ["Total amount of tokens in the performance package"];
                         type: "u64";
                     },
                     {
-                        name: "tokensAlreadyUnlocked";
-                        docs: ["The amount of tokens already unlocked"];
+                        name: "alreadyUnlockedAmount";
+                        docs: ["Amount of tokens already unlocked"];
                         type: "u64";
                     },
                     {
-                        name: "unlockTimestamp";
+                        name: "minUnlockTimestamp";
                         docs: ["The timestamp when unlocking can begin"];
                         type: "i64";
                     },
@@ -320,11 +328,13 @@ export type PriceBasedUnlock = {
                     },
                     {
                         name: "twapLengthSeconds";
-                        docs: ["Length of time in seconds for TWAP calculation"];
-                        type: "u64";
+                        docs: [
+                            "Length of time in seconds for TWAP calculation, between 1 day and 1 year"
+                        ];
+                        type: "u32";
                     },
                     {
-                        name: "tokenRecipient";
+                        name: "recipient";
                         docs: ["The recipient of the tokens when unlocked"];
                         type: "publicKey";
                     },
@@ -332,7 +342,7 @@ export type PriceBasedUnlock = {
                         name: "state";
                         docs: ["The current state of the locker"];
                         type: {
-                            defined: "LockerState";
+                            defined: "PerformancePackageState";
                         };
                     },
                     {
@@ -346,14 +356,28 @@ export type PriceBasedUnlock = {
                         type: "u8";
                     },
                     {
-                        name: "lockerAuthority";
-                        docs: ["The authorized locker authority that can execute changes"];
+                        name: "performancePackageAuthority";
+                        docs: [
+                            "The authorized locker authority that can execute changes, usually the organization"
+                        ];
                         type: "publicKey";
                     },
                     {
                         name: "tokenMint";
                         docs: ["The mint of the locked tokens"];
                         type: "publicKey";
+                    },
+                    {
+                        name: "seqNum";
+                        docs: [
+                            "The sequence number of the performance package, used for indexing events"
+                        ];
+                        type: "u64";
+                    },
+                    {
+                        name: "performancePackageTokenVault";
+                        docs: ["The vault that stores the tokens"];
+                        type: "publicKey";
                     }
                 ];
             };
@@ -364,8 +388,8 @@ export type PriceBasedUnlock = {
                 kind: "struct";
                 fields: [
                     {
-                        name: "locker";
-                        docs: ["The locker this change applies to"];
+                        name: "performancePackage";
+                        docs: ["The performance package this change applies to"];
                         type: "publicKey";
                     },
                     {
@@ -381,18 +405,13 @@ export type PriceBasedUnlock = {
                         type: "i64";
                     },
                     {
-                        name: "previousState";
-                        docs: ["The locker state before the change was proposed"];
-                        type: {
-                            defined: "LockerState";
-                        };
-                    },
-                    {
-                        name: "proposer";
+                        name: "proposerType";
                         docs: [
                             "Who proposed this change (either token_recipient or locker_authority)"
                         ];
-                        type: "publicKey";
+                        type: {
+                            defined: "ProposerType";
+                        };
                     },
                     {
                         name: "pdaNonce";
@@ -410,32 +429,52 @@ export type PriceBasedUnlock = {
     ];
     types: [
         {
-            name: "ChangeLockerAuthorityParams";
+            name: "CommonFields";
             type: {
                 kind: "struct";
                 fields: [
                     {
-                        name: "newLockerAuthority";
-                        type: "publicKey";
+                        name: "slot";
+                        type: "u64";
+                    },
+                    {
+                        name: "unixTimestamp";
+                        type: "i64";
+                    },
+                    {
+                        name: "performancePackageSeqNum";
+                        type: "u64";
                     }
                 ];
             };
         },
         {
-            name: "InitializeLockerParams";
+            name: "ChangePerformancePackageAuthorityParams";
             type: {
                 kind: "struct";
                 fields: [
                     {
-                        name: "priceThreshold";
-                        type: "u128";
-                    },
+                        name: "newPerformancePackageAuthority";
+                        type: "publicKey";
+                    }
+                ];
+            };
+        },
+        {
+            name: "InitializePerformancePackageParams";
+            type: {
+                kind: "struct";
+                fields: [
                     {
-                        name: "tokenAmount";
-                        type: "u64";
+                        name: "tranches";
+                        type: {
+                            vec: {
+                                defined: "Tranche";
+                            };
+                        };
                     },
                     {
-                        name: "unlockTimestamp";
+                        name: "minUnlockTimestamp";
                         type: "i64";
                     },
                     {
@@ -446,14 +485,14 @@ export type PriceBasedUnlock = {
                     },
                     {
                         name: "twapLengthSeconds";
-                        type: "u64";
+                        type: "u32";
                     },
                     {
-                        name: "beneficiary";
+                        name: "grantee";
                         type: "publicKey";
                     },
                     {
-                        name: "lockerAuthority";
+                        name: "performancePackageAuthority";
                         type: "publicKey";
                     }
                 ];
@@ -511,7 +550,45 @@ export type PriceBasedUnlock = {
             };
         },
         {
-            name: "LockerState";
+            name: "Tranche";
+            type: {
+                kind: "struct";
+                fields: [
+                    {
+                        name: "priceThreshold";
+                        docs: ["The price at which this tranch unlocks"];
+                        type: "u128";
+                    },
+                    {
+                        name: "tokenAmount";
+                        docs: ["The amount of tokens in this tranch"];
+                        type: "u64";
+                    }
+                ];
+            };
+        },
+        {
+            name: "StoredTranche";
+            type: {
+                kind: "struct";
+                fields: [
+                    {
+                        name: "priceThreshold";
+                        type: "u128";
+                    },
+                    {
+                        name: "tokenAmount";
+                        type: "u64";
+                    },
+                    {
+                        name: "isUnlocked";
+                        type: "bool";
+                    }
+                ];
+            };
+        },
+        {
+            name: "PerformancePackageState";
             type: {
                 kind: "enum";
                 variants: [
@@ -566,41 +643,35 @@ export type PriceBasedUnlock = {
                     }
                 ];
             };
+        },
+        {
+            name: "ProposerType";
+            type: {
+                kind: "enum";
+                variants: [
+                    {
+                        name: "Recipient";
+                    },
+                    {
+                        name: "Authority";
+                    }
+                ];
+            };
         }
     ];
     events: [
         {
-            name: "LockerInitialized";
+            name: "PerformancePackageInitialized";
             fields: [
                 {
-                    name: "locker";
-                    type: "publicKey";
-                    index: false;
-                },
-                {
-                    name: "priceThreshold";
-                    type: "u128";
-                    index: false;
-                },
-                {
-                    name: "tokenAmount";
-                    type: "u64";
-                    index: false;
-                },
-                {
-                    name: "unlockTimestamp";
-                    type: "i64";
-                    index: false;
-                },
-                {
-                    name: "oracleConfig";
+                    name: "common";
                     type: {
-                        defined: "OracleConfig";
+                        defined: "CommonFields";
                     };
                     index: false;
                 },
                 {
-                    name: "tokenRecipient";
+                    name: "performancePackage";
                     type: "publicKey";
                     index: false;
                 }
@@ -610,7 +681,14 @@ export type PriceBasedUnlock = {
             name: "UnlockStarted";
             fields: [
                 {
-                    name: "locker";
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "performancePackage";
                     type: "publicKey";
                     index: false;
                 },
@@ -630,38 +708,20 @@ export type PriceBasedUnlock = {
             name: "UnlockCompleted";
             fields: [
                 {
-                    name: "locker";
-                    type: "publicKey";
-                    index: false;
-                },
-                {
-                    name: "tokenAmount";
-                    type: "u64";
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
                     index: false;
                 },
                 {
-                    name: "recipient";
+                    name: "performancePackage";
                     type: "publicKey";
                     index: false;
                 },
                 {
-                    name: "twapPrice";
-                    type: "u128";
-                    index: false;
-                },
-                {
-                    name: "priceThreshold";
-                    type: "u128";
-                    index: false;
-                }
-            ];
-        },
-        {
-            name: "TokensClaimed";
-            fields: [
-                {
-                    name: "locker";
-                    type: "publicKey";
+                    name: "tokenAmount";
+                    type: "u64";
                     index: false;
                 },
                 {
@@ -670,27 +730,7 @@ export type PriceBasedUnlock = {
                     index: false;
                 },
                 {
-                    name: "tokensClaimed";
-                    type: "u64";
-                    index: false;
-                },
-                {
-                    name: "tokensAlreadyUnlocked";
-                    type: "u64";
-                    index: false;
-                },
-                {
-                    name: "totalTokenAmount";
-                    type: "u64";
-                    index: false;
-                },
-                {
-                    name: "currentPrice";
-                    type: "u128";
-                    index: false;
-                },
-                {
-                    name: "unlockPercentage";
+                    name: "twapPrice";
                     type: "u128";
                     index: false;
                 }
@@ -720,11 +760,6 @@ export type PriceBasedUnlock = {
                         defined: "ChangeType";
                     };
                     index: false;
-                },
-                {
-                    name: "proposedAt";
-                    type: "i64";
-                    index: false;
                 }
             ];
         },
@@ -732,7 +767,14 @@ export type PriceBasedUnlock = {
             name: "ChangeExecuted";
             fields: [
                 {
-                    name: "locker";
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "performancePackage";
                     type: "publicKey";
                     index: false;
                 },
@@ -752,17 +794,19 @@ export type PriceBasedUnlock = {
                         defined: "ChangeType";
                     };
                     index: false;
-                },
-                {
-                    name: "executedAt";
-                    type: "i64";
-                    index: false;
                 }
             ];
         },
         {
-            name: "LockerAuthorityChanged";
+            name: "PerformancePackageAuthorityChanged";
             fields: [
+                {
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
                 {
                     name: "locker";
                     type: "publicKey";
@@ -777,11 +821,6 @@ export type PriceBasedUnlock = {
                     name: "newAuthority";
                     type: "publicKey";
                     index: false;
-                },
-                {
-                    name: "changedAt";
-                    type: "i64";
-                    index: false;
                 }
             ];
         }
@@ -799,12 +838,12 @@ export type PriceBasedUnlock = {
         },
         {
             code: 6002;
-            name: "InvalidLockerState";
-            msg: "Locker is not in the expected state";
+            name: "InvalidPerformancePackageState";
+            msg: "Performance package is not in the expected state";
         },
         {
             code: 6003;
-            name: "TwapCalculationFailed";
+            name: "TwapPeriodNotElapsed";
             msg: "TWAP calculation failed";
         },
         {
@@ -836,7 +875,22 @@ export type PriceBasedUnlock = {
             code: 6009;
             name: "InvariantViolated";
             msg: "An invariant was violated. You should get in contact with the MetaDAO team if you see this";
+        },
+        {
+            code: 6010;
+            name: "TranchePriceThresholdsNotMonotonic";
+            msg: "Tranche price thresholds must be monotonically increasing";
+        },
+        {
+            code: 6011;
+            name: "TrancheTokenAmountZero";
+            msg: "Tranche token amount must be greater than 0";
+        },
+        {
+            code: 6012;
+            name: "InvalidTwapLength";
+            msg: "TWAP length must be greater than or equal to 1 day and less than 1 year";
         }
     ];
 };
-export declare const IDL: PriceBasedUnlock;
+export declare const IDL: PriceBasedPerformancePackage;