@sage-protocol/sdk 0.1.17 → 0.1.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sage-protocol/sdk",
-  "version": "0.1.17",
+  "version": "0.1.21",
   "description": "Backend-agnostic SDK for interacting with the Sage Protocol (governance, SubDAOs, tokens).",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",

package/types/index.d.ts

@@ -131,8 +131,176 @@ export interface GovernanceOperationsModule {
   }): Promise<TimelockRoleCheck[]>;
 }
 
+export interface VotesTokenDescription {
+  votingToken: AddressLike;
+  baseToken: AddressLike;
+  isWrapper: boolean;
+  multiplierNFT: AddressLike | null;
+  basis: bigint | null;
+  description: string;
+}
+
+export interface VotingStatus {
+  subdao: AddressLike | null;
+  governor: AddressLike;
+  stakeToken: AddressLike | null;
+  votingToken: AddressLike;
+  baseToken: AddressLike;
+  isWrapper: boolean;
+  multiplierNFT: AddressLike | null;
+  basis: bigint | null;
+  threshold: bigint | null;
+  votingPower: bigint | null;
+  tokenBalance: bigint | null;
+  delegate: AddressLike | null;
+  canPropose: boolean | null;
+  tokenMismatch: boolean;
+  stakeTokenVotes: bigint | null;
+  stakeTokenDelegate: AddressLike | null;
+  stakeTokenBalance: bigint | null;
+  description: string;
+}
+
+export interface ProposeGatesSummary {
+  threshold: bigint | null;
+  cooldown: bigint | null;
+  stake: bigint | null;
+  allowanceOk: boolean | null;
+  votesOk: boolean | null;
+  details: {
+    sxxxToken: AddressLike | null;
+    proposer: AddressLike;
+    governor: AddressLike;
+  };
+}
+
+export interface ProposeReadiness extends ProposeGatesSummary {
+  executionReady: boolean | null;
+  executionError: string | null;
+}
+
 export interface GovernanceModule {
   operations: GovernanceOperationsModule;
+  getGovernorInfo(args: { provider: ProviderLike; governor: AddressLike }): Promise<{
+    address: AddressLike;
+    name: string | null;
+    votingDelay: bigint | null;
+    votingPeriod: bigint | null;
+    proposalThreshold: bigint | null;
+    timelock: AddressLike | null;
+    sxxxToken: AddressLike | null;
+    quorumNumerator: bigint | null;
+    stakeAmount: bigint | null;
+  }>;
+  getProposal(args: { provider: ProviderLike; governor: AddressLike; id: bigint | number | string }): Promise<{
+    governor: AddressLike;
+    id: bigint;
+    state: any;
+    snapshot: bigint;
+    deadline: bigint;
+    votes: { against: bigint; for: bigint; abstain: bigint };
+  }>;
+  listProposals(args: { provider: ProviderLike; governor: AddressLike; fromBlock?: number | bigint | string; toBlock?: number | bigint | string }): Promise<ProposalTuple[]>;
+  getProposalMetadata(args: { provider: ProviderLike; governor: AddressLike; id: bigint | number | string; fromBlock?: number | bigint | string; toBlock?: number | bigint | string }): Promise<ProposalTuple & {
+    proposer: AddressLike;
+    blockNumber: number | bigint | null;
+    transactionHash: HashLike | null;
+  }>;
+  hashDescription(description: string): HashLike;
+  buildProposeTx(args: {
+    governor: AddressLike;
+    targets?: AddressLike[];
+    values?: bigint[] | BigNumberish[];
+    calldatas?: string[];
+    descriptionOrHash?: string;
+  }): TransactionPayload;
+  buildCastVoteTx(args: { governor: AddressLike; proposalId: bigint | number | string; support: number | string; reason?: string }): TransactionPayload;
+  buildQueueTx(args: {
+    governor: AddressLike;
+    targets?: AddressLike[];
+    values?: bigint[] | BigNumberish[];
+    calldatas?: string[];
+    descriptionOrHash?: string;
+  }): TransactionPayload;
+  buildExecuteTx(args: {
+    governor: AddressLike;
+    targets?: AddressLike[];
+    values?: bigint[] | BigNumberish[];
+    calldatas?: string[];
+    descriptionOrHash?: string;
+  }): TransactionPayload;
+  buildQueueByIdTx(args: { governor: AddressLike; proposalId: bigint | number | string }): TransactionPayload;
+  buildExecuteByIdTx(args: { governor: AddressLike; proposalId: bigint | number | string }): TransactionPayload;
+  decodeProposalEffects(args: {
+    provider: ProviderLike;
+    governor: AddressLike;
+    proposalId: bigint | number | string;
+    fromBlock?: number | bigint | string;
+    toBlock?: number | bigint | string;
+  }): Promise<any>;
+  getQuorumAt(args: { provider: ProviderLike; governor: AddressLike; blockTag?: bigint | number | string }): Promise<bigint | null>;
+  getQuorumLatestMinusOne(args: { provider: ProviderLike; governor: AddressLike }): Promise<bigint | null>;
+  getVotesLatestMinusOne(args: { provider: ProviderLike; token?: AddressLike; governor?: AddressLike; account: AddressLike }): Promise<bigint>;
+  simulatePropose(args: {
+    provider: ProviderLike;
+    governor: AddressLike;
+    targets?: AddressLike[];
+    values?: bigint[] | BigNumberish[];
+    calldatas?: string[];
+    description?: string;
+    sender?: AddressLike;
+  }): Promise<{ ok: boolean; error?: { type: string; message: string } }>;
+  resolveVotesToken(args: { provider: ProviderLike; subdao?: AddressLike; governor?: AddressLike }): Promise<AddressLike>;
+  resolveVotesTokenChain(args: { provider: ProviderLike; subdao?: AddressLike; governor?: AddressLike }): Promise<{
+    votingToken: AddressLike;
+    baseToken: AddressLike;
+    isWrapper: boolean;
+  }>;
+  describeVotesToken(args: { provider: ProviderLike; subdao?: AddressLike; governor?: AddressLike }): Promise<VotesTokenDescription>;
+  getVotingStatus(args: { provider: ProviderLike; subdao?: AddressLike; governor?: AddressLike; account: AddressLike }): Promise<VotingStatus>;
+  buildDelegateTx(args: { token: AddressLike; delegatee: AddressLike }): TransactionPayload;
+  buildDelegateSelfTx(args: { provider: ProviderLike; governor: AddressLike; account: AddressLike }): Promise<TransactionPayload>;
+  buildDelegateSelfPreferred(args: { provider: ProviderLike; subdao?: AddressLike; governor?: AddressLike; account: AddressLike }): Promise<TransactionPayload>;
+  delegateSelfAndVerify(args: {
+    provider: ProviderLike;
+    subdao?: AddressLike;
+    governor?: AddressLike;
+    account: AddressLike;
+    signer?: any;
+    minVotes?: bigint | number | string | null;
+  }): Promise<{ txHash: string | null; ok: boolean; votes: bigint; payload: TransactionPayload }>;
+  ensureProposeGates(args: { provider: ProviderLike; governor: AddressLike; proposer: AddressLike }): Promise<ProposeGatesSummary>;
+  readinessToPropose(args: {
+    provider: ProviderLike;
+    governor: AddressLike;
+    proposer: AddressLike;
+    execution?: {
+      provider: ProviderLike;
+      registry: AddressLike;
+      timelock: AddressLike;
+      subdao: AddressLike;
+      libraryId?: string;
+      manifestCID?: string;
+      promptCount?: bigint | number | string;
+    } | null;
+  }): Promise<ProposeReadiness>;
+  listActiveProposals(args: { url: string; governor: AddressLike; first?: number; skip?: number }): Promise<any>;
+  buildProposeTxByHash(args: {
+    governor: AddressLike;
+    targets?: AddressLike[];
+    values?: bigint[] | BigNumberish[];
+    calldatas?: string[];
+    descriptionHash: string;
+  }): TransactionPayload;
+  detectMode(args: { provider: ProviderLike; governor?: AddressLike; timelock?: AddressLike | null; subdao?: AddressLike | null }): Promise<{
+    operator: boolean;
+    governance: string;
+    governor: AddressLike | null;
+    timelock: AddressLike | null;
+    subdao: AddressLike | null;
+    stakeRequired: bigint | null;
+    depositWei: bigint | null;
+  }>;
   [key: string]: any;
 }
 
@@ -540,11 +708,229 @@ export interface PersonalModule {
   }): Promise<bigint>;
 }
 
+// ============ Voting Multiplier System Types ============
+
+export interface MultiplierTier {
+  name: string;
+  multiplier: bigint;
+  maxSupply: bigint;
+  minted: bigint;
+  price: bigint;
+  dao: AddressLike;
+}
+
+export interface MultiplierTokenInfo {
+  owner: AddressLike;
+  tierId: bigint;
+  multiplier: bigint;
+  uri: string;
+}
+
+export interface VotingBreakdown {
+  baseVotes: bigint;
+  multiplier: bigint;
+  effectiveVotes: bigint;
+}
+
+export interface VotingMultiplierModule {
+  // Tier Management
+  getTier(args: { provider: ProviderLike; nft: AddressLike; tierId: bigint | number }): Promise<MultiplierTier>;
+  getTierCount(args: { provider: ProviderLike; nft: AddressLike }): Promise<bigint>;
+  buildCreateTierTx(args: {
+    nft: AddressLike;
+    dao: AddressLike;
+    name: string;
+    multiplier: BigNumberish;
+    maxSupply: BigNumberish;
+    price: BigNumberish;
+  }): TransactionPayload;
+  // Minting
+  buildMintTx(args: {
+    nft: AddressLike;
+    to: AddressLike;
+    tierId: BigNumberish;
+    uri: string;
+  }): TransactionPayload;
+  buildPublicMintTx(args: {
+    nft: AddressLike;
+    tierId: BigNumberish;
+    uri: string;
+    value: BigNumberish;
+  }): TransactionPayload;
+  // Multiplier Queries
+  getMultiplier(args: { provider: ProviderLike; nft: AddressLike; account: AddressLike; dao: AddressLike }): Promise<bigint>;
+  getPastMultiplier(args: { provider: ProviderLike; nft: AddressLike; account: AddressLike; dao: AddressLike; timepoint: BigNumberish }): Promise<bigint>;
+  getTokenMultiplier(args: { provider: ProviderLike; nft: AddressLike; tokenId: BigNumberish }): Promise<bigint>;
+  getTokenDAO(args: { provider: ProviderLike; nft: AddressLike; tokenId: BigNumberish }): Promise<AddressLike>;
+  getTokenInfo(args: { provider: ProviderLike; nft: AddressLike; tokenId: BigNumberish }): Promise<MultiplierTokenInfo>;
+  // MultipliedVotes Wrapper
+  getVotes(args: { provider: ProviderLike; wrapper: AddressLike; account: AddressLike }): Promise<bigint>;
+  getPastVotes(args: { provider: ProviderLike; wrapper: AddressLike; account: AddressLike; timepoint: BigNumberish }): Promise<bigint>;
+  getVotingBreakdown(args: { provider: ProviderLike; wrapper: AddressLike; account: AddressLike }): Promise<VotingBreakdown>;
+  getPastVotingBreakdown(args: { provider: ProviderLike; wrapper: AddressLike; account: AddressLike; timepoint: BigNumberish }): Promise<VotingBreakdown>;
+  hasMultiplierBonus(args: { provider: ProviderLike; wrapper: AddressLike; account: AddressLike }): Promise<boolean>;
+}
+
+// ============ Auction House Types ============
+
+export interface AuctionState {
+  nftId: bigint;
+  amount: bigint;
+  startTime: bigint;
+  endTime: bigint;
+  bidder: AddressLike;
+  settled: boolean;
+}
+
+export interface AuctionConfig {
+  nft: AddressLike;
+  treasury: AddressLike;
+  weth: AddressLike;
+  timeBuffer: bigint;
+  reservePrice: bigint;
+  minBidIncrementPercentage: bigint;
+  duration: bigint;
+  mintTierId: bigint;
+  defaultTokenURI: string;
+  paused: boolean;
+  owner: AddressLike;
+}
+
+export interface AuctionModule {
+  // Auction State
+  getAuction(args: { provider: ProviderLike; auctionHouse: AddressLike }): Promise<AuctionState>;
+  getConfig(args: { provider: ProviderLike; auctionHouse: AddressLike }): Promise<AuctionConfig>;
+  // Bidding
+  buildCreateBidTx(args: { auctionHouse: AddressLike; nftId: BigNumberish; value: BigNumberish }): TransactionPayload;
+  // Settlement
+  buildSettleAndCreateTx(args: { auctionHouse: AddressLike }): TransactionPayload;
+  buildSettleTx(args: { auctionHouse: AddressLike }): TransactionPayload;
+  buildCreateAuctionTx(args: { auctionHouse: AddressLike }): TransactionPayload;
+  // Admin
+  buildPauseTx(args: { auctionHouse: AddressLike }): TransactionPayload;
+  buildUnpauseTx(args: { auctionHouse: AddressLike }): TransactionPayload;
+  buildSetTimeBufferTx(args: { auctionHouse: AddressLike; timeBuffer: BigNumberish }): TransactionPayload;
+  buildSetReservePriceTx(args: { auctionHouse: AddressLike; reservePrice: BigNumberish }): TransactionPayload;
+  buildSetMinBidIncrementTx(args: { auctionHouse: AddressLike; percentage: BigNumberish }): TransactionPayload;
+  buildSetDurationTx(args: { auctionHouse: AddressLike; duration: BigNumberish }): TransactionPayload;
+  buildSetMintTierIdTx(args: { auctionHouse: AddressLike; tierId: BigNumberish }): TransactionPayload;
+  buildSetDefaultTokenURITx(args: { auctionHouse: AddressLike; uri: string }): TransactionPayload;
+}
+
+// ============ Bounty System Types ============
+
+export type BountyMode = 'OPEN' | 'DIRECT' | 'COMPETITIVE';
+export type BountyStatus = 'ACTIVE' | 'CLAIMED' | 'UNDER_REVIEW' | 'VOTING' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED';
+export type LibraryAction = 'PAYMENT_ONLY' | 'ADD_TO_LIBRARY' | 'PAYMENT_AND_ADD';
+
+export interface Bounty {
+  creator: AddressLike;
+  id: bigint;
+  title: string;
+  description: string;
+  ipfsCID: string;
+  reward: bigint;
+  creatorDeposit: bigint;
+  minContributorLevel: bigint;
+  minTokenBalance: bigint;
+  requiredBadgeId: bigint;
+  deadline: bigint;
+  votingEndTime: bigint;
+  snapshotBlock: bigint;
+  mode: number;
+  status: number;
+  libraryAction: number;
+  assignee: AddressLike;
+  winner: AddressLike;
+  winningSubmissionId: bigint;
+  libraryKey: string;
+  governanceProposalId: bigint;
+}
+
+export interface BountySubmission {
+  id: bigint;
+  bountyId: bigint;
+  submitter: AddressLike;
+  promptIPFS: string;
+  deliverableIPFS: string;
+  timestamp: bigint;
+  voteCount: bigint;
+  exists: boolean;
+}
+
+export interface BountyModule {
+  // Constants
+  getMaxSubmissionsPerBounty(args: { provider: ProviderLike; bountySystem: AddressLike }): Promise<bigint>;
+  // Bounty Queries
+  getBounty(args: { provider: ProviderLike; bountySystem: AddressLike; bountyId: BigNumberish }): Promise<Bounty>;
+  getSubmission(args: { provider: ProviderLike; bountySystem: AddressLike; bountyId: BigNumberish; submissionId: BigNumberish }): Promise<BountySubmission>;
+  getSubmissionCount(args: { provider: ProviderLike; bountySystem: AddressLike; bountyId: BigNumberish }): Promise<bigint>;
+  getLeadingSubmission(args: { provider: ProviderLike; bountySystem: AddressLike; bountyId: BigNumberish }): Promise<{ submissionId: bigint; votes: bigint }>;
+  calculateStake(args: { provider: ProviderLike; bountySystem: AddressLike; reward: BigNumberish }): Promise<bigint>;
+  canSubmit(args: { provider: ProviderLike; bountySystem: AddressLike; bountyId: BigNumberish; submitter: AddressLike }): Promise<boolean>;
+  hasVotedInBounty(args: { provider: ProviderLike; bountySystem: AddressLike; bountyId: BigNumberish; voter: AddressLike }): Promise<boolean>;
+  // Bounty Creation
+  buildCreateBountyTx(args: {
+    bountySystem: AddressLike;
+    title: string;
+    description: string;
+    ipfsCID: string;
+    reward: BigNumberish;
+    deadline: BigNumberish;
+  }): TransactionPayload;
+  buildCreateBountyAdvancedTx(args: {
+    bountySystem: AddressLike;
+    title: string;
+    description: string;
+    ipfsCID: string;
+    reward: BigNumberish;
+    deadline: BigNumberish;
+    votingDuration: BigNumberish;
+    mode: number;
+    libraryAction: number;
+    assignee: AddressLike;
+    libraryKey: string;
+  }): TransactionPayload;
+  // Claiming & Submission
+  buildClaimBountyTx(args: { bountySystem: AddressLike; bountyId: BigNumberish }): TransactionPayload;
+  buildSubmitEntryTx(args: {
+    bountySystem: AddressLike;
+    bountyId: BigNumberish;
+    promptIPFS: string;
+    deliverableIPFS: string;
+  }): TransactionPayload;
+  buildCompleteBountyTx(args: {
+    bountySystem: AddressLike;
+    bountyId: BigNumberish;
+    deliverableIPFS: string;
+  }): TransactionPayload;
+  // Voting (COMPETITIVE mode)
+  buildStartVotingTx(args: { bountySystem: AddressLike; bountyId: BigNumberish }): TransactionPayload;
+  buildVoteTx(args: { bountySystem: AddressLike; bountyId: BigNumberish; submissionId: BigNumberish }): TransactionPayload;
+  buildFinalizeCompetitiveTx(args: { bountySystem: AddressLike; bountyId: BigNumberish }): TransactionPayload;
+  // Approval
+  buildApproveSubmissionTx(args: { bountySystem: AddressLike; bountyId: BigNumberish; submissionId: BigNumberish }): TransactionPayload;
+  // Cancellation & Expiry
+  buildCancelBountyTx(args: { bountySystem: AddressLike; bountyId: BigNumberish }): TransactionPayload;
+  buildExpireBountyTx(args: { bountySystem: AddressLike; bountyId: BigNumberish }): TransactionPayload;
+  // Reward Management
+  buildIncreaseRewardTx(args: { bountySystem: AddressLike; bountyId: BigNumberish; additionalReward: BigNumberish }): TransactionPayload;
+  // Gate Management
+  buildSetGatesTx(args: {
+    bountySystem: AddressLike;
+    bountyId: BigNumberish;
+    minTokenBalance: BigNumberish;
+    requiredBadgeId: BigNumberish;
+  }): TransactionPayload;
+  buildAddToWhitelistTx(args: { bountySystem: AddressLike; bountyId: BigNumberish; addresses: AddressLike[] }): TransactionPayload;
+  buildRemoveFromWhitelistTx(args: { bountySystem: AddressLike; bountyId: BigNumberish; addresses: AddressLike[] }): TransactionPayload;
+}
+
 export interface SageSDK {
   version: string;
   getProvider: (rpcUrl: string) => any;
   abi: Record<string, any>;
-  governance: Record<string, any>;
+  governance: GovernanceModule;
   subdao: Record<string, any>;
   timelock: Record<string, any>;
   factory: Record<string, any>;
@@ -569,6 +955,10 @@ export interface SageSDK {
   treasury: TreasuryModule;
   boost: BoostModule;
   personal: PersonalModule;
+  // New modules for voting multiplier, auction, and bounty systems
+  votingMultiplier: VotingMultiplierModule;
+  auction: AuctionModule;
+  bounty: BountyModule;
   subgraph: Record<string, any>;
   errors: Record<string, any>;
   resolveGovernanceContext: (args: any) => Promise<any>;