@sage-protocol/sdk 0.1.18 → 0.1.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sage-protocol/sdk",
-  "version": "0.1.18",
+  "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;
 }
 
@@ -762,7 +930,7 @@ 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>;