@zemyth/raise-sdk 0.1.2 → 0.1.3

package/dist/accounts/index.d.ts

@@ -1,6 +1,6 @@
 import { Program, BN } from '@coral-xyz/anchor';
 import { PublicKey } from '@solana/web3.js';
-import { MilestoneWithKey, InvestmentWithKey, VoteWithKey } from '../types/index.js';
+import { MilestoneWithKey, InvestmentWithKey, VoteWithKey, FundingRoundWithKey, AllocationProposalWithKey } from '../types/index.js';
 
 /**
  * Raise Account Fetchers
@@ -102,6 +102,14 @@ declare function fetchTgeEscrow(program: AnyProgram, projectId: BN): Promise<any
  * @returns AdminConfig account data
  */
 declare function fetchAdminConfig(program: AnyProgram): Promise<any>;
+/**
+ * Fetch token vault account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @returns TokenVault account data or null if not found
+ */
+declare function fetchTokenVault(program: AnyProgram, projectId: BN): Promise<any>;
 /**
  * Check if an account exists
  *
@@ -111,5 +119,302 @@ declare function fetchAdminConfig(program: AnyProgram): Promise<any>;
  * @returns True if account exists
  */
 declare function accountExists(program: AnyProgram, accountType: string, pda: PublicKey): Promise<boolean>;
+/**
+ * Fetch tokenomics account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @returns Tokenomics account data or null if not found
+ */
+declare function fetchTokenomics(program: AnyProgram, projectId: BN): Promise<any>;
+/**
+ * Fetch allocation proposal account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param proposalIndex - Proposal index
+ * @returns AllocationProposal account data or null if not found
+ */
+declare function fetchAllocationProposal(program: AnyProgram, projectId: BN, proposalIndex: number): Promise<any>;
+/**
+ * Fetch all allocation proposals for a project
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @returns Array of allocation proposal accounts with their public keys
+ */
+declare function fetchAllAllocationProposals(program: AnyProgram, projectId: BN): Promise<AllocationProposalWithKey[]>;
+/**
+ * Fetch allocation vote account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param proposalIndex - Proposal index
+ * @param nftMint - NFT mint used for voting
+ * @returns AllocationVote account data or null if not found
+ */
+declare function fetchAllocationVote(program: AnyProgram, projectId: BN, proposalIndex: number, nftMint: PublicKey): Promise<any>;
+/**
+ * Fetch sub-allocation vesting account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param subAllocationId - Sub-allocation ID (0-9)
+ * @returns SubAllocationVesting account data or null if not found
+ */
+declare function fetchSubAllocationVesting(program: AnyProgram, projectId: BN, subAllocationId: number): Promise<any>;
+/**
+ * Fetch investor milestone vesting account data
+ *
+ * Per-milestone vesting: Each investor has a separate vesting PDA for each
+ * milestone they claim tokens from.
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param milestoneIndex - Milestone index
+ * @param nftMint - NFT mint that proves investment ownership
+ * @returns InvestorMilestoneVesting account data or null if not found
+ */
+declare function fetchInvestorMilestoneVesting(program: AnyProgram, projectId: BN, milestoneIndex: number, nftMint: PublicKey): Promise<any>;
+/**
+ * Fetch founder milestone vesting account data
+ *
+ * Per-milestone vesting: Each milestone has a separate vesting PDA for the
+ * founder's milestone-based allocation.
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param milestoneIndex - Milestone index
+ * @returns FounderMilestoneVesting account data or null if not found
+ */
+declare function fetchFounderMilestoneVesting(program: AnyProgram, projectId: BN, milestoneIndex: number): Promise<any>;
+/** Early token cooling period in seconds (24 hours in production, 10s in dev) */
+declare const EARLY_TOKEN_COOLING_PERIOD_SECONDS = 86400;
+declare const EARLY_TOKEN_COOLING_PERIOD_SECONDS_DEV = 10;
+/** Early token release percentage in basis points (500 = 5%) */
+declare const EARLY_TOKEN_RELEASE_BPS = 500;
+/**
+ * Check if an investor can claim early tokens
+ *
+ * Early Token Release: Investors can claim 5% of their token allocation
+ * 24 hours after investing. This helper checks eligibility.
+ *
+ * @param investment - Investment account data
+ * @param currentTimestamp - Current Unix timestamp (optional, uses Date.now() if not provided)
+ * @param isDev - Use dev mode (10s) or production mode (24h) cooling period
+ * @returns Object with canClaim boolean, reason if ineligible, and time remaining if cooling period not expired
+ */
+declare function canClaimEarlyTokens(investment: {
+    earlyTokensClaimed: boolean;
+    investedAt: BN | number;
+    votingRightsActive?: boolean;
+    withdrawnFromPivot?: boolean;
+}, currentTimestamp?: number, isDev?: boolean): {
+    canClaim: boolean;
+    reason?: string;
+    timeRemainingSeconds?: number;
+};
+/**
+ * Check if a founder can claim early tokens
+ *
+ * Early Token Release: Founders can claim 5% of their token allocation
+ * when the project becomes Funded. This helper checks eligibility.
+ *
+ * @param project - Project account data
+ * @returns Object with canClaim boolean and reason if ineligible
+ */
+declare function canClaimFounderEarlyTokens(project: {
+    state: unknown;
+    founderEarlyTokensClaimed: boolean;
+}): {
+    canClaim: boolean;
+    reason?: string;
+};
+/**
+ * Check if a founder can claim milestone-based tokens
+ *
+ * Early Token Release: Founders can claim milestone-based tokens when
+ * milestones are unlocked. This helper checks eligibility.
+ *
+ * @param milestone - Milestone account data
+ * @returns Object with canClaim boolean and reason if ineligible
+ */
+declare function canClaimFounderMilestoneTokens(milestone: {
+    state: unknown;
+}): {
+    canClaim: boolean;
+    reason?: string;
+};
+/**
+ * Check if an investor needs to burn tokens for a refund
+ *
+ * Early Token Release: If the project has no milestones claimed (cumulative_percentage == 0)
+ * AND the investor has claimed early tokens, they must burn those tokens to get a full refund.
+ *
+ * @param project - Project account data
+ * @param investment - Investment account data
+ * @returns Object indicating whether burn is required
+ */
+declare function requiresBurnForRefund(project: {
+    cumulativePercentage: number;
+}, investment: {
+    earlyTokensClaimed: boolean;
+    earlyTokensAmount: BN | number;
+}): {
+    requiresBurn: boolean;
+    burnAmount: number;
+};
+/**
+ * Calculate early token amount for an investment
+ *
+ * @param tokensAllocated - Total tokens allocated to the investment
+ * @returns Early token amount (5% of allocation)
+ */
+declare function calculateEarlyTokenAmount(tokensAllocated: BN | number): BN;
+/**
+ * Calculate remaining token allocation after early tokens are claimed
+ *
+ * @param tokensAllocated - Total tokens allocated
+ * @returns Remaining allocation (95% of total)
+ */
+declare function calculateRemainingAllocation(tokensAllocated: BN | number): BN;
+/**
+ * Fetch FundingRound account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param roundNumber - Round number (2, 3, 4...)
+ * @returns FundingRound account data or null if not found
+ */
+declare function fetchFundingRound(program: AnyProgram, projectId: BN, roundNumber: number): Promise<any>;
+/**
+ * Fetch all FundingRounds for a project
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @returns Array of FundingRound accounts with their public keys
+ */
+declare function fetchAllFundingRounds(program: AnyProgram, projectId: BN): Promise<FundingRoundWithKey[]>;
+/**
+ * Fetch round milestone account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param roundNumber - Round number
+ * @param milestoneIndex - Milestone index
+ * @returns Milestone account data or null if not found
+ */
+declare function fetchRoundMilestone(program: AnyProgram, projectId: BN, roundNumber: number, milestoneIndex: number): Promise<any>;
+/**
+ * Fetch round investment account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param roundNumber - Round number
+ * @param nftMint - Investment NFT mint address
+ * @returns Investment account data or null if not found
+ */
+declare function fetchRoundInvestment(program: AnyProgram, projectId: BN, roundNumber: number, nftMint: PublicKey): Promise<any>;
+/**
+ * Fetch round investor milestone vesting account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param roundNumber - Round number
+ * @param milestoneIndex - Milestone index
+ * @param nftMint - NFT mint that proves investment ownership
+ * @returns InvestorMilestoneVesting account data or null if not found
+ */
+declare function fetchRoundInvestorMilestoneVesting(program: AnyProgram, projectId: BN, roundNumber: number, milestoneIndex: number, nftMint: PublicKey): Promise<any>;
+/**
+ * Fetch FutureRoundVault account data
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @returns FutureRoundVault account data or null if not found
+ */
+declare function fetchFutureRoundVault(program: AnyProgram, projectId: BN): Promise<any>;
+/**
+ * Check if an investor can claim R2+ early tokens
+ *
+ * @param investment - Investment account data (from R2+ round)
+ * @param currentTimestamp - Current Unix timestamp
+ * @param isDev - Use dev mode cooling period
+ * @returns Eligibility check result
+ */
+declare function canClaimRoundEarlyTokens(investment: {
+    earlyTokensClaimed: boolean;
+    investedAt: BN | number;
+    votingRightsActive?: boolean;
+    roundNumber: number;
+}, currentTimestamp?: number, isDev?: boolean): {
+    canClaim: boolean;
+    reason?: string;
+    timeRemainingSeconds?: number;
+};
+/**
+ * Check if R1 (Project-based round) is fully funded
+ *
+ * @param project - Project account data
+ * @returns True if total_raised >= funding_goal
+ */
+declare function isR1FullyFunded(project: {
+    totalRaised: BN | number;
+    fundingGoal: BN | number;
+}): boolean;
+/**
+ * Check if a FundingRound (R2+) is fully funded
+ *
+ * A round is considered "fully funded" when it reaches the Funded, InProgress, or Completed state.
+ *
+ * @param fundingRound - FundingRound account data
+ * @returns True if round state is Funded, InProgress, or Completed
+ */
+declare function isFundingRoundFullyFunded(fundingRound: {
+    state: unknown;
+    totalRaised?: BN | number;
+    fundingGoal?: BN | number;
+}): boolean;
+/**
+ * Check if a round (R1 or R2+) is fully funded
+ *
+ * For R1: Checks project.totalRaised >= project.fundingGoal
+ * For R2+: Checks fundingRound.state is Funded or beyond
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @param roundNumber - Round number (1 for R1, 2+ for subsequent rounds)
+ * @returns True if the round is fully funded
+ */
+declare function isRoundFullyFunded(program: AnyProgram, projectId: BN, roundNumber: number): Promise<boolean>;
+/**
+ * Check if a project can open the next funding round
+ *
+ * Requirements:
+ * 1. Project must be InProgress or Completed
+ * 2. At least 1 milestone must have passed (for InProgress projects)
+ * 3. Current round must be fully funded
+ * 4. No other round is currently in Open state
+ * 5. Future round allocation must be available
+ *
+ * @param program - Anchor program instance
+ * @param projectId - Project identifier
+ * @returns Eligibility check result with reason if ineligible
+ */
+declare function canOpenNextRound(program: AnyProgram, projectId: BN): Promise<{
+    canOpen: boolean;
+    reason?: string;
+    nextRoundNumber?: number;
+}>;
+/**
+ * Get remaining future round allocation in basis points
+ *
+ * @param tokenomics - Tokenomics account data
+ * @returns Remaining allocation in BPS
+ */
+declare function getRemainingFutureRoundAllocation(tokenomics: {
+    futureRoundAllocationBps: number;
+    usedFutureRoundBps?: number;
+}): number;
 
-export { accountExists, fetchAdminConfig, fetchAllInvestments, fetchAllMilestones, fetchAllVotes, fetchInvestment, fetchMilestone, fetchPivotProposal, fetchProject, fetchProjectByPda, fetchTgeEscrow, fetchVote };
+export { EARLY_TOKEN_COOLING_PERIOD_SECONDS, EARLY_TOKEN_COOLING_PERIOD_SECONDS_DEV, EARLY_TOKEN_RELEASE_BPS, accountExists, calculateEarlyTokenAmount, calculateRemainingAllocation, canClaimEarlyTokens, canClaimFounderEarlyTokens, canClaimFounderMilestoneTokens, canClaimRoundEarlyTokens, canOpenNextRound, fetchAdminConfig, fetchAllAllocationProposals, fetchAllFundingRounds, fetchAllInvestments, fetchAllMilestones, fetchAllVotes, fetchAllocationProposal, fetchAllocationVote, fetchFounderMilestoneVesting, fetchFundingRound, fetchFutureRoundVault, fetchInvestment, fetchInvestorMilestoneVesting, fetchMilestone, fetchPivotProposal, fetchProject, fetchProjectByPda, fetchRoundInvestment, fetchRoundInvestorMilestoneVesting, fetchRoundMilestone, fetchSubAllocationVesting, fetchTgeEscrow, fetchTokenVault, fetchTokenomics, fetchVote, getRemainingFutureRoundAllocation, isFundingRoundFullyFunded, isR1FullyFunded, isRoundFullyFunded, requiresBurnForRefund };