@sage-protocol/sdk 0.1.16 → 0.1.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sage-protocol/sdk",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "Backend-agnostic SDK for interacting with the Sage Protocol (governance, SubDAOs, tokens).",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -56,11 +56,11 @@
     "release": "yarn build && npm publish --workspace @sage-protocol/sdk"
   },
   "dependencies": {
-    "content-hash": "^2.5.2",
     "@merit-systems/echo-typescript-sdk": "^1.0.17",
     "@whetstone-research/doppler-sdk": "^0.0.1-alpha.40",
     "ai": "^3.2.3",
     "axios": "^1.11.0",
+    "content-hash": "^2.5.2",
     "ethers": "^6.15.0",
     "viem": "^2.33.2"
   },

package/types/index.d.ts

@@ -540,6 +540,224 @@ 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;
@@ -569,6 +787,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>;