@zemyth/raise-sdk 0.1.1 → 0.1.3

package/src/types/index.ts

@@ -68,6 +68,7 @@ export interface Tier {
 /**
  * Tier configuration input for project initialization
  * Founders pass these when creating a project
+ * Note: voteMultiplier is auto-calculated on-chain using logarithmic formula
  */
 export interface TierConfig {
   /** USDC amount per lot (must be >= 10 USDC = 10_000_000 lamports) */
@@ -76,8 +77,6 @@ export interface TierConfig {
   maxLots: number;
   /** Token allocation per $1 invested (must be >= 1) */
   tokenRatio: BN;
-  /** Vote weight multiplier (basis points, must be >= 100 = 1.0x) */
-  voteMultiplier: number;
 }
 
 export interface ProjectAccount {
@@ -101,6 +100,26 @@ export interface ProjectAccount {
   totalTokenAllocation: BN;
   consecutiveFailures: number;
   investorCount: number;
+  /** Milestone Price Increases: BPS multipliers per milestone (10000 = 1.0x)
+   * NOTE: If priceMultipliers[0] === 0, project uses dynamic mode (ZEMYTH formula)
+   * Otherwise uses static mode (legacy pre-configured multipliers) */
+  priceMultipliers: number[];
+  /** Milestone Price Increases: Number of milestones that have passed */
+  milestonesPassed: number;
+  /** Dynamic Price Multiplier: Current calculated multiplier in BPS (10000 = 1.0x)
+   * Used when priceMultipliers[0] === 0 (dynamic mode) */
+  currentPriceMultiplierBps: number;
+  // === Linear Progressive Pricing Fields (add-linear-progressive-pricing) ===
+  /** Base multiplier at start of current milestone period (BPS) */
+  milestoneBaseMultiplierBps: number;
+  /** Timestamp when current milestone period started (0 = legacy mode) */
+  milestonePeriodStartedAt: BN;
+  /** Expected deadline for current milestone period */
+  expectedMilestoneDeadlineTs: BN;
+  /** Time-based allocation for current period (50% of ZEMYTH increment) */
+  timeAllocationBps: number;
+  /** Milestone-based allocation (50% of ZEMYTH increment) */
+  milestoneAllocationBps: number;
   bump: number;
 }
 
@@ -130,6 +149,12 @@ export interface InvestmentAccount {
   tokensClaimed: boolean;
   withdrawnFromPivot: boolean;
   refundClaimed: boolean;
+  /** Early Token Release: Whether 5% early tokens have been claimed */
+  earlyTokensClaimed: boolean;
+  /** Early Token Release: Amount of early tokens claimed (for burn-for-refund tracking) */
+  earlyTokensAmount: BN;
+  /** Preserve Pivot Vesting Rights: Milestone index at which vesting was frozen (on refund) */
+  vestingFrozenAtMilestone: number | null;
   bump: number;
 }
 
@@ -145,6 +170,8 @@ export interface VoteAccount {
 export interface AdminConfigAccount {
   admin: PublicKey;
   pendingAdmin: PublicKey | null;
+  /** Zemyth treasury wallet for platform token allocations */
+  zemythTreasury: PublicKey | null;
   bump: number;
 }
 
@@ -229,6 +256,10 @@ export interface InvestmentMadeEvent {
   nftMint: PublicKey;
   tier: number;
   voteWeight: BN;
+  /** Milestone Price Increases: Effective tier price with multiplier applied */
+  effectivePrice: BN;
+  /** Milestone Price Increases: Current price multiplier in BPS (10000 = 1.0x) */
+  multiplierBps: number;
 }
 
 export interface MilestoneVoteCastEvent {
@@ -265,3 +296,668 @@ export interface VoteWithKey {
   publicKey: PublicKey;
   account: VoteAccount;
 }
+
+// =============================================================================
+// Dynamic Tokenomics Types
+// =============================================================================
+
+/**
+ * Sub-allocation within a project's founder allocation pool
+ * Sub-allocations are founder team tokens (advisors, marketing, etc.)
+ */
+export interface SubAllocation {
+  /** Unique ID within project (0-9, max 10 sub-allocations) */
+  id: number;
+  /** Name of the allocation (UTF-8, e.g., "advisors", "marketing") */
+  name: string;
+  /** Basis points from founder allocation pool (e.g., 500 = 5% of total supply) */
+  bps: number;
+  /** Token destination wallet */
+  recipient: PublicKey;
+  /** Vesting duration in months (0 = immediate, >0 = linear vesting) */
+  vestingMonths: number;
+  /** Cliff period in months before vesting starts */
+  cliffMonths: number;
+  /** Timestamp when sub-allocation was created */
+  createdAt: BN;
+  /** True if this was added via governance vote (post-Open state) */
+  approvedViaGovernance: boolean;
+}
+
+/**
+ * Allocation proposal for governance voting
+ */
+export interface AllocationProposalAccount {
+  /** Parent project */
+  project: PublicKey;
+  /** Proposer (must be founder) */
+  proposer: PublicKey;
+  /** The proposed sub-allocation */
+  subAllocation: SubAllocation;
+  /** Total vote weight in favor */
+  votesFor: BN;
+  /** Total vote weight against */
+  votesAgainst: BN;
+  /** Timestamp when voting ends (7 days from creation) */
+  votingEndsAt: BN;
+  /** Whether the proposal has been executed */
+  executed: boolean;
+  /** Proposal index (for unique PDA derivation) */
+  proposalIndex: number;
+  /** PDA bump seed */
+  bump: number;
+}
+
+/**
+ * Vote record for an allocation proposal
+ */
+export interface AllocationVoteAccount {
+  /** The proposal being voted on */
+  proposal: PublicKey;
+  /** The investment NFT used to vote */
+  nftMint: PublicKey;
+  /** Voter's wallet */
+  voter: PublicKey;
+  /** Vote weight */
+  voteWeight: BN;
+  /** True = for, False = against */
+  voteFor: boolean;
+  /** Timestamp of vote */
+  votedAt: BN;
+  /** PDA bump seed */
+  bump: number;
+}
+
+/**
+ * Extended Tokenomics account with dynamic allocation fields
+ */
+export interface TokenomicsAccount {
+  /** Parent project */
+  project: PublicKey;
+  /** Token symbol (2-8 chars uppercase) */
+  tokenSymbol: string;
+  /** Token decimals (default: 9) */
+  tokenDecimals: number;
+  /** Total token supply */
+  totalSupply: BN;
+  /** Investor allocation in basis points */
+  investorAllocationBps: number;
+  /** LP token allocation in basis points */
+  lpTokenAllocationBps: number;
+  /** LP USDC allocation in basis points */
+  lpUsdcAllocationBps: number;
+  /** Founder allocation in basis points (includes sub-allocations for team) */
+  founderAllocationBps: number;
+  /** Zemyth platform allocation in basis points (minimum 1%, vests per milestone) */
+  zemythAllocationBps: number;
+  /** Number of active sub-allocations (draw from founder allocation) */
+  subAllocationCount: number;
+  /** Sub-allocations from founder pool (advisors, marketing, etc.) */
+  subAllocations: SubAllocation[];
+  /** Number of allocation proposals created */
+  proposalCount: number;
+  /** Founder wallet for vesting */
+  founderWallet: PublicKey | null;
+  /** Vesting duration in months */
+  vestingDurationMonths: number;
+  /** Cliff period in months */
+  cliffMonths: number;
+  /** Early Token Release: Founder milestone-based vesting BPS (e.g., 4750 = 47.5% of founder allocation) */
+  founderMilestoneVestingBps: number;
+  /** Early Token Release: Founder time-based vesting BPS (e.g., 4750 = 47.5% of founder allocation) */
+  founderTimeVestingBps: number;
+  /** Future round allocation in basis points (0 or >= 1000, reserved for second-round fundraising) */
+  futureRoundAllocationBps: number;
+  /** PDA bump seed */
+  bump: number;
+}
+
+// =============================================================================
+// Dynamic Tokenomics Instruction Arguments
+// =============================================================================
+
+export interface AddSubAllocationArgs {
+  /** Name of the sub-allocation (e.g., "advisors", "marketing") */
+  name: string;
+  /** Basis points from founder allocation pool */
+  bps: number;
+  /** Token destination wallet */
+  recipient: PublicKey;
+  /** Vesting duration in months (0 = immediate) */
+  vestingMonths: number;
+  /** Cliff period in months */
+  cliffMonths: number;
+}
+
+export interface ProposeAllocationChangeArgs {
+  /** Name of the sub-allocation */
+  name: string;
+  /** Basis points from founder allocation pool */
+  bps: number;
+  /** Token destination wallet */
+  recipient: PublicKey;
+  /** Vesting duration in months */
+  vestingMonths: number;
+  /** Cliff period in months */
+  cliffMonths: number;
+}
+
+export interface VoteAllocationChangeArgs {
+  /** True = vote for, False = vote against */
+  voteFor: boolean;
+}
+
+// =============================================================================
+// Dynamic Tokenomics Events
+// =============================================================================
+
+export interface SubAllocationAddedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  subAllocationId: number;
+  name: string;
+  bps: number;
+  recipient: PublicKey;
+  vestingMonths: number;
+  cliffMonths: number;
+  timestamp: BN;
+}
+
+export interface AllocationProposalCreatedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  proposalKey: PublicKey;
+  name: string;
+  bps: number;
+  recipient: PublicKey;
+  votingEndsAt: BN;
+  timestamp: BN;
+}
+
+export interface AllocationVoteCastEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  proposalKey: PublicKey;
+  voter: PublicKey;
+  nftMint: PublicKey;
+  voteWeight: BN;
+  voteFor: boolean;
+  timestamp: BN;
+}
+
+export interface AllocationChangeExecutedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  proposalKey: PublicKey;
+  subAllocationId: number;
+  votesFor: BN;
+  votesAgainst: BN;
+  timestamp: BN;
+}
+
+// =============================================================================
+// Dynamic Tokenomics Utility Types
+// =============================================================================
+
+export interface AllocationProposalWithKey {
+  publicKey: PublicKey;
+  account: AllocationProposalAccount;
+}
+
+export interface AllocationVoteWithKey {
+  publicKey: PublicKey;
+  account: AllocationVoteAccount;
+}
+
+// =============================================================================
+// Sub-Allocation Vesting Types
+// =============================================================================
+
+/**
+ * Sub-allocation vesting account for tracking vesting schedules
+ * Similar to FounderVesting but for sub-allocations (treasury, advisors, etc.)
+ */
+export interface SubAllocationVestingAccount {
+  /** Parent project */
+  project: PublicKey;
+  /** Sub-allocation ID (0-9) */
+  subAllocationId: number;
+  /** Recipient wallet (only this wallet can claim) */
+  recipientWallet: PublicKey;
+  /** Total token amount for this sub-allocation */
+  totalAmount: BN;
+  /** Timestamp when vesting starts (MAE completion) */
+  startTimestamp: BN;
+  /** Timestamp when cliff ends */
+  cliffEnd: BN;
+  /** Timestamp when vesting fully ends */
+  vestingEnd: BN;
+  /** Amount already claimed */
+  claimedAmount: BN;
+  /** Pending wallet update (for wallet migration) */
+  pendingWallet: PublicKey | null;
+  /** Timestamp when wallet update was initiated */
+  walletUpdateTimestamp: BN | null;
+  /** PDA bump seed */
+  bump: number;
+}
+
+export interface SubAllocationVestingWithKey {
+  publicKey: PublicKey;
+  account: SubAllocationVestingAccount;
+}
+
+/**
+ * Arguments for claiming sub-allocation tokens
+ */
+export interface ClaimSubAllocationTokensArgs {
+  /** Sub-allocation ID to claim from (0-9) */
+  subAllocationId: number;
+}
+
+// =============================================================================
+// Sub-Allocation Vesting Events
+// =============================================================================
+
+export interface SubAllocationVestingInitializedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  subAllocationId: number;
+  recipientWallet: PublicKey;
+  totalAmount: BN;
+  cliffMonths: number;
+  vestingMonths: number;
+  startTimestamp: BN;
+  timestamp: BN;
+}
+
+export interface SubAllocationTokensClaimedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  subAllocationId: number;
+  recipient: PublicKey;
+  amountClaimed: BN;
+  totalClaimed: BN;
+  remaining: BN;
+  vestingProgressPercent: number;
+  timestamp: BN;
+}
+
+// =============================================================================
+// Early Token Release Types
+// =============================================================================
+
+/**
+ * Arguments for claim_investor_tokens instruction
+ */
+export interface ClaimInvestorTokensArgs {
+  /** Milestone index to claim tokens from */
+  milestoneIndex: number;
+}
+
+/**
+ * Arguments for claim_founder_milestone_tokens instruction
+ */
+export interface ClaimFounderMilestoneTokensArgs {
+  /** Milestone index to claim tokens from */
+  milestoneIndex: number;
+}
+
+// =============================================================================
+// Early Token Release Events
+// =============================================================================
+
+export interface EarlyTokensClaimedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  investor: PublicKey;
+  nftMint: PublicKey;
+  amount: BN;
+  timestamp: BN;
+}
+
+export interface FounderEarlyTokensClaimedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  founder: PublicKey;
+  amount: BN;
+  timestamp: BN;
+}
+
+export interface FounderMilestoneTokensClaimedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  founder: PublicKey;
+  milestoneIndex: number;
+  amount: BN;
+  cumulativeClaimed: BN;
+  timestamp: BN;
+}
+
+export interface TokensBurnedForRefundEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  investor: PublicKey;
+  nftMint: PublicKey;
+  amountBurned: BN;
+  timestamp: BN;
+}
+
+// =============================================================================
+// Milestone Price Increase Events
+// =============================================================================
+
+export interface PriceMultiplierActivatedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  milestoneIndex: number;
+  newMultiplierBps: number;
+  timestamp: BN;
+}
+
+// =============================================================================
+// Dynamic Price Multiplier Events (refactor-dynamic-price-multiplier)
+// =============================================================================
+
+/** Emitted when claim_milestone_funds dynamically calculates and updates the price multiplier */
+export interface PriceMultiplierUpdatedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  /** Index of the milestone just claimed */
+  milestoneIndex: number;
+  /** Number of milestones remaining after this claim */
+  remainingMilestones: number;
+  /** Days until the next milestone deadline */
+  daysToDeadline: BN;
+  /** New price multiplier in BPS (10000 = 1.0x) */
+  newMultiplierBps: number;
+  /** Previous price multiplier in BPS */
+  previousMultiplierBps: number;
+  timestamp: BN;
+}
+
+// =============================================================================
+// Zemyth Platform Allocation Types (refactor-sub-allocation-to-founder)
+// =============================================================================
+
+/**
+ * Zemyth vesting account for platform token allocation
+ * Created at project approval, tokens vest proportionally per milestone
+ */
+export interface ZemythVestingAccount {
+  /** Parent project */
+  project: PublicKey;
+  /** Total Zemyth token allocation */
+  totalTokens: BN;
+  /** Tokens already claimed by Zemyth treasury */
+  claimedTokens: BN;
+  /** Number of milestones claimed for (0 to milestone_count) */
+  milestonesClaimed: number;
+  /** Destination treasury wallet for claims */
+  treasuryWallet: PublicKey;
+  /** Account creation timestamp */
+  createdAt: BN;
+  /** PDA bump seed */
+  bump: number;
+}
+
+export interface ZemythVestingWithKey {
+  publicKey: PublicKey;
+  account: ZemythVestingAccount;
+}
+
+// =============================================================================
+// Zemyth Platform Allocation Events (refactor-sub-allocation-to-founder)
+// =============================================================================
+
+/** Emitted when ZemythVesting account is created at project approval */
+export interface ZemythVestingCreatedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  totalTokens: BN;
+  treasuryWallet: PublicKey;
+  timestamp: BN;
+}
+
+/** Emitted when Zemyth claims tokens for passed milestones */
+export interface ZemythTokensClaimedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  amountClaimed: BN;
+  totalClaimed: BN;
+  milestonesClaimed: number;
+  treasuryWallet: PublicKey;
+  timestamp: BN;
+}
+
+// =============================================================================
+// Future Round Allocation Types (add-future-round-allocation)
+// =============================================================================
+
+/**
+ * FutureRoundVault account for tracking reserved tokens for future fundraising
+ * Created at project approval if future_round_allocation_bps > 0
+ */
+export interface FutureRoundVaultAccount {
+  /** Parent project */
+  project: PublicKey;
+  /** Token mint for the project */
+  tokenMint: PublicKey;
+  /** Total tokens reserved for future rounds */
+  totalAmount: BN;
+  /** Tokens already used in subsequent rounds */
+  usedAmount: BN;
+  /** PDA bump seed */
+  bump: number;
+}
+
+export interface FutureRoundVaultWithKey {
+  publicKey: PublicKey;
+  account: FutureRoundVaultAccount;
+}
+
+// =============================================================================
+// Multi-Round Fundraising Types (add-second-round-fundraising)
+// =============================================================================
+
+/**
+ * FundingRound state enum
+ */
+export enum FundingRoundState {
+  Open = 'open',
+  Funded = 'funded',
+  InProgress = 'inProgress',
+  Completed = 'completed',
+  Failed = 'failed',
+}
+
+/**
+ * Milestone configuration input for funding rounds
+ */
+export interface RoundMilestoneConfig {
+  /** Percentage of round funds for this milestone */
+  percentage: number;
+  /** Milestone description */
+  description: string;
+  /** Instant release percentage in basis points (e.g., 1000 = 10%) */
+  instantReleaseBps: number;
+  /** Cliff period in months */
+  cliffMonths: number;
+  /** Vesting duration in months */
+  vestingDurationMonths: number;
+}
+
+/**
+ * FundingRound account for R2, R3, R4... rounds
+ */
+export interface FundingRoundAccount {
+  /** Parent project */
+  project: PublicKey;
+  /** Round number (2, 3, 4...) */
+  roundNumber: number;
+  /** Funding goal for this round */
+  fundingGoal: BN;
+  /** Amount raised in this round */
+  amountRaised: BN;
+  /** Round state */
+  state: FundingRoundState;
+  /** Number of investors in this round */
+  investorCount: number;
+  /** Allocation from future round pool (basis points) */
+  roundAllocationBps: number;
+  /** Number of tiers */
+  tierCount: number;
+  /** Tier configurations */
+  tiers: Tier[];
+  /** Number of milestones */
+  milestoneCount: number;
+  /** Current milestone index */
+  currentMilestone: number;
+  /** Consecutive milestone failures */
+  consecutiveFailures: number;
+  /** Round creation timestamp */
+  createdAt: BN;
+  /** PDA bump seed */
+  bump: number;
+}
+
+export interface FundingRoundWithKey {
+  publicKey: PublicKey;
+  account: FundingRoundAccount;
+}
+
+// =============================================================================
+// Multi-Round Fundraising Instruction Arguments
+// =============================================================================
+
+/**
+ * Arguments for open_funding_round instruction
+ */
+export interface OpenFundingRoundArgs {
+  /** Allocation from future round pool in basis points */
+  roundAllocationBps: number;
+  /** Funding goal for this round */
+  fundingGoal: BN;
+  /** Tier configurations (token_ratio must be <= R1's best tier) */
+  tiers: TierConfig[];
+  /** Milestone configurations for this round */
+  milestones: RoundMilestoneConfig[];
+}
+
+/**
+ * Arguments for invest_in_round instruction
+ */
+export interface InvestInRoundArgs {
+  /** Round number to invest in */
+  roundNumber: number;
+  /** Investment amount in USDC lamports */
+  amount: BN;
+}
+
+/**
+ * Arguments for vote_on_round_milestone instruction
+ */
+export interface VoteOnRoundMilestoneArgs {
+  /** Round number */
+  roundNumber: number;
+  /** Milestone index */
+  milestoneIndex: number;
+  /** Vote choice */
+  choice: VoteChoice;
+}
+
+/**
+ * Arguments for claim_round_instant_tokens instruction
+ */
+export interface ClaimRoundInstantTokensArgs {
+  /** Milestone index */
+  milestoneIndex: number;
+}
+
+/**
+ * Arguments for claim_round_vested_tokens instruction
+ */
+export interface ClaimRoundVestedTokensArgs {
+  /** Milestone index */
+  milestoneIndex: number;
+}
+
+// =============================================================================
+// Multi-Round Fundraising Events
+// =============================================================================
+
+export interface FundingRoundOpenedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  roundNumber: number;
+  fundingGoal: BN;
+  roundAllocationBps: number;
+  tierCount: number;
+  milestoneCount: number;
+  timestamp: BN;
+}
+
+export interface RoundInvestmentMadeEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  roundNumber: number;
+  investor: PublicKey;
+  amount: BN;
+  nftMint: PublicKey;
+  tier: number;
+  tokensAllocated: BN;
+  timestamp: BN;
+}
+
+export interface RoundMilestoneVoteEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  roundNumber: number;
+  milestoneIndex: number;
+  voter: PublicKey;
+  choice: VoteChoice;
+  weight: BN;
+  timestamp: BN;
+}
+
+export interface RoundMilestoneFinalizedEvent {
+  projectId: BN;
+  projectKey: PublicKey;
+  roundNumber: number;
+  milestoneIndex: number;
+  passed: boolean;
+  yesVotes: BN;
+  noVotes: BN;
+  timestamp: BN;
+}
+
+export interface RoundEarlyTokensClaimedEvent {
+  projectId: BN;
+  roundNumber: number;
+  investmentKey: PublicKey;
+  nftHolder: PublicKey;
+  amount: BN;
+  timestamp: BN;
+}
+
+export interface RoundInstantTokensClaimedEvent {
+  projectId: BN;
+  roundNumber: number;
+  milestoneIndex: number;
+  investmentKey: PublicKey;
+  nftHolder: PublicKey;
+  tokensClaimed: BN;
+  timestamp: BN;
+}
+
+export interface RoundVestedTokensClaimedEvent {
+  projectId: BN;
+  roundNumber: number;
+  milestoneIndex: number;
+  investmentKey: PublicKey;
+  nftHolder: PublicKey;
+  tokensClaimed: BN;
+  cumulativeClaimed: BN;
+  vestingProgressPercent: number;
+  timestamp: BN;
+}