@metadaoproject/futarchy 0.4.0-alpha.36 → 0.4.0-alpha.38

package/dist/v0.4/types/launchpad.d.ts

@@ -1,6 +1,10 @@
 export type Launchpad = {
     version: "0.4.0";
     name: "launchpad";
+    docs: [
+        "TODO:",
+        "- Add a `start_launch` instruction that allows the creator to start the launch"
+    ];
     instructions: [
         {
             name: "initializeLaunch";
@@ -10,9 +14,19 @@ export type Launchpad = {
                     isMut: true;
                     isSigner: false;
                 },
+                {
+                    name: "launchTreasury";
+                    isMut: false;
+                    isSigner: false;
+                },
                 {
                     name: "usdcVault";
-                    isMut: true;
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "tokenVault";
+                    isMut: false;
                     isSigner: false;
                 },
                 {
@@ -25,11 +39,26 @@ export type Launchpad = {
                     isMut: false;
                     isSigner: false;
                 },
+                {
+                    name: "daoTreasury";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "treasuryUsdcAccount";
+                    isMut: false;
+                    isSigner: false;
+                },
                 {
                     name: "usdcMint";
                     isMut: false;
                     isSigner: false;
                 },
+                {
+                    name: "tokenMint";
+                    isMut: false;
+                    isSigner: false;
+                },
                 {
                     name: "tokenProgram";
                     isMut: false;
@@ -44,6 +73,16 @@ export type Launchpad = {
                     name: "systemProgram";
                     isMut: false;
                     isSigner: false;
+                },
+                {
+                    name: "eventAuthority";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "program";
+                    isMut: false;
+                    isSigner: false;
                 }
             ];
             args: [
@@ -54,6 +93,274 @@ export type Launchpad = {
                     };
                 }
             ];
+        },
+        {
+            name: "startLaunch";
+            accounts: [
+                {
+                    name: "launch";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "creator";
+                    isMut: false;
+                    isSigner: true;
+                },
+                {
+                    name: "eventAuthority";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "program";
+                    isMut: false;
+                    isSigner: false;
+                }
+            ];
+            args: [];
+        },
+        {
+            name: "fund";
+            accounts: [
+                {
+                    name: "launch";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "usdcVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "tokenMint";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "funder";
+                    isMut: true;
+                    isSigner: true;
+                },
+                {
+                    name: "funderUsdcAccount";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "funderTokenAccount";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "tokenProgram";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "eventAuthority";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "program";
+                    isMut: false;
+                    isSigner: false;
+                }
+            ];
+            args: [
+                {
+                    name: "amount";
+                    type: "u64";
+                }
+            ];
+        },
+        {
+            name: "completeLaunch";
+            accounts: [
+                {
+                    name: "launch";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "payer";
+                    isMut: true;
+                    isSigner: true;
+                },
+                {
+                    name: "launchTreasury";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "authority";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "launchUsdcVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "launchTokenVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "treasuryUsdcAccount";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "ammConfig";
+                    isMut: false;
+                    isSigner: false;
+                    docs: ["Which config the pool belongs to."];
+                },
+                {
+                    name: "poolState";
+                    isMut: true;
+                    isSigner: true;
+                },
+                {
+                    name: "tokenMint";
+                    isMut: true;
+                    isSigner: false;
+                    docs: ["Token_0 mint, the key must smaller then token_1 mint."];
+                },
+                {
+                    name: "usdcMint";
+                    isMut: false;
+                    isSigner: false;
+                    docs: ["Token_1 mint, the key must grater then token_0 mint."];
+                },
+                {
+                    name: "lpMint";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "lpVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "poolTokenVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "poolUsdcVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "createPoolFee";
+                    isMut: true;
+                    isSigner: false;
+                    docs: ["create pool fee account"];
+                },
+                {
+                    name: "observationState";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "cpSwapProgram";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "associatedTokenProgram";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "tokenProgram";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "systemProgram";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "rent";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "eventAuthority";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "program";
+                    isMut: false;
+                    isSigner: false;
+                }
+            ];
+            args: [];
+        },
+        {
+            name: "refund";
+            accounts: [
+                {
+                    name: "launch";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "launchUsdcVault";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "launchTreasury";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "funder";
+                    isMut: true;
+                    isSigner: true;
+                },
+                {
+                    name: "funderUsdcAccount";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "funderTokenAccount";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "tokenMint";
+                    isMut: true;
+                    isSigner: false;
+                },
+                {
+                    name: "tokenProgram";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "eventAuthority";
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: "program";
+                    isMut: false;
+                    isSigner: false;
+                }
+            ];
+            args: [];
         }
     ];
     accounts: [
@@ -64,45 +371,115 @@ export type Launchpad = {
                 fields: [
                     {
                         name: "minimumRaiseAmount";
+                        docs: [
+                            "The minimum amount of USDC that must be raised, otherwise",
+                            "everyone can get their USDC back."
+                        ];
                         type: "u64";
                     },
                     {
-                        name: "maximumRaiseAmount";
-                        type: "u64";
+                        name: "creator";
+                        docs: ["The creator of the launch."];
+                        type: "publicKey";
                     },
                     {
-                        name: "isApproved";
-                        type: "bool";
+                        name: "launchTreasury";
+                        docs: [
+                            "The launch treasury address. Needed because Raydium pools need a SOL payer."
+                        ];
+                        type: "publicKey";
                     },
                     {
-                        name: "creator";
+                        name: "launchTreasuryPdaBump";
+                        docs: ["The PDA bump for the launch treasury."];
+                        type: "u8";
+                    },
+                    {
+                        name: "launchUsdcVault";
+                        docs: [
+                            "The USDC vault that will hold the USDC raised until the launch is over."
+                        ];
                         type: "publicKey";
                     },
                     {
-                        name: "usdcVault";
+                        name: "launchTokenVault";
+                        docs: ["The token vault, used to send tokens to Raydium."];
                         type: "publicKey";
                     },
                     {
-                        name: "committedAmount";
-                        type: "u64";
+                        name: "tokenMint";
+                        docs: [
+                            "The token that will be minted to funders and that will control the DAO."
+                        ];
+                        type: "publicKey";
                     },
                     {
                         name: "pdaBump";
+                        docs: ["The PDA bump."];
                         type: "u8";
                     },
                     {
                         name: "dao";
+                        docs: [
+                            "The DAO that will receive the USDC raised once the launch is over."
+                        ];
                         type: "publicKey";
                     },
                     {
                         name: "daoTreasury";
+                        docs: ["The DAO's treasury address."];
+                        type: "publicKey";
+                    },
+                    {
+                        name: "treasuryUsdcAccount";
+                        docs: ["The DAO treasury's USDC account."];
                         type: "publicKey";
+                    },
+                    {
+                        name: "committedAmount";
+                        docs: ["The amount of USDC that has been committed by the users."];
+                        type: "u64";
+                    },
+                    {
+                        name: "seqNum";
+                        docs: [
+                            "The sequence number of this launch. Useful for sorting events."
+                        ];
+                        type: "u64";
+                    },
+                    {
+                        name: "state";
+                        docs: ["The state of the launch."];
+                        type: {
+                            defined: "LaunchState";
+                        };
+                    },
+                    {
+                        name: "slotStarted";
+                        docs: ["The slot when the launch was started."];
+                        type: "u64";
                     }
                 ];
             };
         }
     ];
     types: [
+        {
+            name: "CommonFields";
+            type: {
+                kind: "struct";
+                fields: [
+                    {
+                        name: "slot";
+                        type: "u64";
+                    },
+                    {
+                        name: "unixTimestamp";
+                        type: "i64";
+                    }
+                ];
+            };
+        },
         {
             name: "InitializeLaunchArgs";
             type: {
@@ -111,30 +488,230 @@ export type Launchpad = {
                     {
                         name: "minimumRaiseAmount";
                         type: "u64";
+                    }
+                ];
+            };
+        },
+        {
+            name: "LaunchState";
+            type: {
+                kind: "enum";
+                variants: [
+                    {
+                        name: "Initialized";
                     },
                     {
-                        name: "maximumRaiseAmount";
-                        type: "u64";
+                        name: "Live";
+                    },
+                    {
+                        name: "Complete";
+                    },
+                    {
+                        name: "Refunding";
                     }
                 ];
             };
         }
     ];
+    events: [
+        {
+            name: "LaunchInitializedEvent";
+            fields: [
+                {
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "launch";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "dao";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "daoTreasury";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "tokenMint";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "creator";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "usdcMint";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "pdaBump";
+                    type: "u8";
+                    index: false;
+                }
+            ];
+        },
+        {
+            name: "LaunchStartedEvent";
+            fields: [
+                {
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "launch";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "creator";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "slotStarted";
+                    type: "u64";
+                    index: false;
+                }
+            ];
+        },
+        {
+            name: "LaunchFundedEvent";
+            fields: [
+                {
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "launch";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "funder";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "amount";
+                    type: "u64";
+                    index: false;
+                },
+                {
+                    name: "totalCommitted";
+                    type: "u64";
+                    index: false;
+                }
+            ];
+        },
+        {
+            name: "LaunchCompletedEvent";
+            fields: [
+                {
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "launch";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "finalState";
+                    type: {
+                        defined: "LaunchState";
+                    };
+                    index: false;
+                },
+                {
+                    name: "totalCommitted";
+                    type: "u64";
+                    index: false;
+                }
+            ];
+        },
+        {
+            name: "LaunchRefundedEvent";
+            fields: [
+                {
+                    name: "common";
+                    type: {
+                        defined: "CommonFields";
+                    };
+                    index: false;
+                },
+                {
+                    name: "launch";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "funder";
+                    type: "publicKey";
+                    index: false;
+                },
+                {
+                    name: "usdcRefunded";
+                    type: "u64";
+                    index: false;
+                },
+                {
+                    name: "tokensBurned";
+                    type: "u64";
+                    index: false;
+                }
+            ];
+        }
+    ];
     errors: [
         {
             code: 6000;
-            name: "InvalidRaiseAmount";
-            msg: "Maximum raise amount must be greater than minimum";
+            name: "InvalidAmount";
+            msg: "Invalid amount";
         },
         {
             code: 6001;
-            name: "LaunchNotApproved";
-            msg: "Launch has not been approved";
+            name: "SupplyNonZero";
+            msg: "Supply must be zero";
         },
         {
             code: 6002;
-            name: "ExceedsMaximumRaise";
-            msg: "Amount would exceed maximum raise amount";
+            name: "InvalidLaunchState";
+            msg: "Invalid launch state";
+        },
+        {
+            code: 6003;
+            name: "LaunchPeriodNotOver";
+            msg: "Launch period not over";
+        },
+        {
+            code: 6004;
+            name: "LaunchNotRefunding";
+            msg: "Launch needs to be in refunding state to get a refund";
+        },
+        {
+            code: 6005;
+            name: "LaunchNotInitialized";
+            msg: "Launch must be initialized to be started";
         }
     ];
 };