@metadaoproject/futarchy 0.5.0-alpha.6 → 0.6.0-alpha.0

package/dist/v0.6/FutarchyClient.d.ts

@@ -0,0 +1,749 @@
+import { AnchorProvider, Program } from "@coral-xyz/anchor";
+import { AccountInfo, AddressLookupTableAccount, PublicKey } from "@solana/web3.js";
+import { InitializeDaoParams, UpdateDaoParams } from "./types/index.js";
+import { Futarchy } from "./types/futarchy.js";
+import BN from "bn.js";
+import { ConditionalVaultClient } from "./ConditionalVaultClient.js";
+import { Dao, Proposal } from "./types/index.js";
+export type CreateClientParams = {
+    provider: AnchorProvider;
+    autocratProgramId?: PublicKey;
+    conditionalVaultProgramId?: PublicKey;
+};
+export type ProposalVaults = {
+    baseVault: PublicKey;
+    quoteVault: PublicKey;
+};
+export declare class FutarchyClient {
+    readonly provider: AnchorProvider;
+    readonly autocrat: Program<Futarchy>;
+    readonly vaultClient: ConditionalVaultClient;
+    readonly luts: AddressLookupTableAccount[];
+    constructor(provider: AnchorProvider, autocratProgramId: PublicKey, conditionalVaultProgramId: PublicKey, luts: AddressLookupTableAccount[]);
+    static createClient(createAutocratClientParams: CreateClientParams): FutarchyClient;
+    getProgramId(): PublicKey;
+    getProposal(proposal: PublicKey): Promise<Proposal>;
+    getDao(dao: PublicKey): Promise<Dao>;
+    fetchProposal(proposal: PublicKey): Promise<Proposal | null>;
+    fetchDao(dao: PublicKey): Promise<Dao | null>;
+    deserializeProposal(accountInfo: AccountInfo<Buffer>): Promise<Proposal>;
+    deserializeDao(accountInfo: AccountInfo<Buffer>): Promise<Dao>;
+    getProposalPdas(proposal: PublicKey, baseMint: PublicKey, quoteMint: PublicKey, dao: PublicKey): {
+        question: PublicKey;
+        baseVault: PublicKey;
+        quoteVault: PublicKey;
+        passBaseMint: PublicKey;
+        passQuoteMint: PublicKey;
+        failBaseMint: PublicKey;
+        failQuoteMint: PublicKey;
+    };
+    initializeDaoIx({ baseMint, params, provideLiquidity, quoteMint, squadsProgramConfigTreasury, }: {
+        baseMint: PublicKey;
+        params: InitializeDaoParams;
+        provideLiquidity?: boolean;
+        quoteMint?: PublicKey;
+        squadsProgramConfigTreasury?: PublicKey;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "initializeDao";
+        accounts: [{
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "daoCreator";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "payer";
+            isMut: true;
+            isSigner: true;
+        }, {
+            name: "systemProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "baseMint";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "quoteMint";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "squadsMultisig";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "squadsMultisigVault";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "squadsProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "squadsProgramConfig";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "squadsProgramConfigTreasury";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "spendingLimit";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "futarchyAmmBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "futarchyAmmQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "associatedTokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "params";
+            type: {
+                defined: "InitializeDaoParams";
+            };
+        }];
+    } & {
+        name: "initializeDao";
+    }>;
+    launchProposalIx({ proposal, dao, baseMint, quoteMint, }: {
+        proposal: PublicKey;
+        dao: PublicKey;
+        baseMint: PublicKey;
+        quoteMint: PublicKey;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "launchProposal";
+        accounts: [{
+            name: "proposal";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "baseVault";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "quoteVault";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "passBaseMint";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "passQuoteMint";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "failBaseMint";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "failQuoteMint";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "payer";
+            isMut: true;
+            isSigner: true;
+        }, {
+            name: "ammPassBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammPassQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammFailBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammFailQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "systemProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "associatedTokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [];
+    } & {
+        name: "launchProposal";
+    }>;
+    spotSwapIx({ dao, baseMint, quoteMint, swapType, inputAmount, minOutputAmount, trader, }: {
+        dao: PublicKey;
+        baseMint: PublicKey;
+        quoteMint: PublicKey;
+        swapType: "buy" | "sell";
+        inputAmount: BN;
+        minOutputAmount?: BN;
+        trader?: PublicKey;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "spotSwap";
+        accounts: [{
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "userBaseAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "userQuoteAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "user";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "params";
+            type: {
+                defined: "SpotSwapParams";
+            };
+        }];
+    } & {
+        name: "spotSwap";
+    }>;
+    provideLiquidityIx({ dao, baseMint, quoteMint, quoteAmount, maxBaseAmount, minLiquidity, positionAuthority, liquidityProvider, }: {
+        dao: PublicKey;
+        baseMint: PublicKey;
+        quoteMint: PublicKey;
+        quoteAmount: BN;
+        maxBaseAmount: BN;
+        minLiquidity?: BN;
+        positionAuthority?: PublicKey;
+        liquidityProvider?: PublicKey;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "provideLiquidity";
+        accounts: [{
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "liquidityProvider";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "liquidityProviderBaseAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "liquidityProviderQuoteAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "payer";
+            isMut: true;
+            isSigner: true;
+        }, {
+            name: "systemProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "ammBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammPosition";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "params";
+            type: {
+                defined: "ProvideLiquidityParams";
+            };
+        }];
+    } & {
+        name: "provideLiquidity";
+    }>;
+    conditionalSwapIx({ dao, trader, payer, baseMint, quoteMint, proposal, market, swapType, inputAmount, }: {
+        dao: PublicKey;
+        trader?: PublicKey;
+        payer?: PublicKey;
+        baseMint: PublicKey;
+        quoteMint: PublicKey;
+        proposal: PublicKey;
+        market: "pass" | "fail";
+        swapType: "buy" | "sell";
+        inputAmount: BN;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "conditionalSwap";
+        accounts: [{
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "proposal";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "ammPassBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammPassQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammFailBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammFailQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "trader";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "userInputAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "userOutputAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "baseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "baseVaultUnderlyingTokenAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "quoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "quoteVaultUnderlyingTokenAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "passBaseMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "failBaseMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "passQuoteMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "failQuoteMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "conditionalVaultProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "vaultEventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "question";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "params";
+            type: {
+                defined: "ConditionalSwapParams";
+            };
+        }];
+    } & {
+        name: "conditionalSwap";
+    }>;
+    initializeProposal(dao: PublicKey, descriptionUrl: string, squadsProposal: PublicKey): Promise<PublicKey>;
+    initializeProposalIx(descriptionUrl: string, squadsProposal: PublicKey, dao: PublicKey, baseMint: PublicKey, quoteMint: PublicKey, question: PublicKey, proposer?: PublicKey): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "initializeProposal";
+        accounts: [{
+            name: "proposal";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "squadsProposal";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "question";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "quoteVault";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "baseVault";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "proposer";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "payer";
+            isMut: true;
+            isSigner: true;
+        }, {
+            name: "systemProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "params";
+            type: {
+                defined: "InitializeProposalParams";
+            };
+        }];
+    } & {
+        name: "initializeProposal";
+    }>;
+    finalizeProposal(proposal: PublicKey): Promise<string>;
+    finalizeProposalIx(proposal: PublicKey, squadsProposal: PublicKey, dao: PublicKey, daoToken: PublicKey, usdc: PublicKey, proposer: PublicKey): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "finalizeProposal";
+        accounts: [{
+            name: "proposal";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "question";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "squadsProposal";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "squadsMultisig";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "squadsMultisigProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "ammPassBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammPassQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammFailBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammFailQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "vaultProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "vaultEventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "quoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "quoteVaultUnderlyingTokenAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "passQuoteMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "failQuoteMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "passBaseMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "failBaseMint";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "baseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "baseVaultUnderlyingTokenAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [];
+    } & {
+        name: "finalizeProposal";
+    }>;
+    updateDaoIx({ dao, params }: {
+        dao: PublicKey;
+        params: UpdateDaoParams;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "updateDao";
+        accounts: [{
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "squadsMultisigVault";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "daoParams";
+            type: {
+                defined: "UpdateDaoParams";
+            };
+        }];
+    } & {
+        name: "updateDao";
+    }>;
+    stakeToProposalIx({ proposal, dao, baseMint, amount, staker, payer, }: {
+        proposal: PublicKey;
+        dao: PublicKey;
+        baseMint: PublicKey;
+        amount: BN;
+        staker?: PublicKey;
+        payer?: PublicKey;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "stakeToProposal";
+        accounts: [{
+            name: "proposal";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "stakerBaseAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "proposalBaseAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "stakeAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "staker";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "payer";
+            isMut: true;
+            isSigner: true;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "associatedTokenProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "systemProgram";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "eventAuthority";
+            isMut: false;
+            isSigner: false;
+        }, {
+            name: "program";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [{
+            name: "params";
+            type: {
+                defined: "StakeToProposalParams";
+            };
+        }];
+    } & {
+        name: "stakeToProposal";
+    }>;
+    collectFeesIx({ dao, baseMint, quoteMint, baseTokenAccount, quoteTokenAccount, }: {
+        dao: PublicKey;
+        baseMint: PublicKey;
+        quoteMint: PublicKey;
+        baseTokenAccount?: PublicKey;
+        quoteTokenAccount?: PublicKey;
+    }): import("@coral-xyz/anchor/dist/cjs/program/namespace/methods.js").MethodsBuilder<Futarchy, {
+        name: "collectFees";
+        accounts: [{
+            name: "dao";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "admin";
+            isMut: false;
+            isSigner: true;
+        }, {
+            name: "baseTokenAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "quoteTokenAccount";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammBaseVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "ammQuoteVault";
+            isMut: true;
+            isSigner: false;
+        }, {
+            name: "tokenProgram";
+            isMut: false;
+            isSigner: false;
+        }];
+        args: [];
+    } & {
+        name: "collectFees";
+    }>;
+}