@gzeoneth/gov-tracker 0.2.1-beta.c266765 → 0.2.1-beta.d575294

package/dist/election.d.ts

@@ -1,312 +0,0 @@
-/**
- * Security Council Election Tracking
- *
- * Provides functions to check election status and prepare election creation transactions.
- * Based on SecurityCouncilElectionTracker from governance repo.
- *
- * @module election
- */
-import { ethers, BigNumber } from "ethers";
-import { PreparedTransaction, ElectionProposalStatus, ElectionStatus, ElectionContender, ElectionNominee, NomineeElectionDetails, MemberElectionDetails } from "./types";
-/**
- * Prepared election creation transaction
- */
-export interface PreparedElectionCreation {
-    /** Transaction to send */
-    transaction: PreparedTransaction;
-    /** Election index being created */
-    electionIndex: number;
-}
-/**
- * Election proposal parameters needed for execute() call
- */
-export interface ElectionProposalParams {
-    /** Target addresses */
-    targets: string[];
-    /** ETH values */
-    values: BigNumber[];
-    /** Call data for each target */
-    calldatas: string[];
-    /** Proposal description */
-    description: string;
-    /** Keccak256 hash of description */
-    descriptionHash: string;
-}
-/**
- * Check the status of the Security Council election
- *
- * Determines if a new election can be created and when the next one is scheduled.
- *
- * @param l2Provider - Arbitrum One provider
- * @param l1Provider - Ethereum mainnet provider (for L1 timestamp)
- * @param nomineeGovernorAddress - Optional override for nominee election governor address
- * @returns Election status information
- *
- * @example
- * ```typescript
- * const status = await checkElectionStatus(l2Provider, l1Provider);
- *
- * if (status.canCreateElection) {
- *   console.log("Election ready to create!");
- * } else {
- *   console.log(`Next election in ${status.timeUntilElection}`);
- * }
- * ```
- */
-export declare function checkElectionStatus(l2Provider: ethers.providers.Provider, l1Provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<ElectionStatus>;
-/**
- * Prepare a transaction to create a new Security Council election
- *
- * Only call this if checkElectionStatus indicates canCreateElection is true.
- *
- * @param electionStatus - Status from checkElectionStatus (provides current election count)
- * @param nomineeGovernorAddress - Optional override for nominee election governor address
- * @returns Prepared transaction for creating the election
- *
- * @example
- * ```typescript
- * const status = await checkElectionStatus(l2Provider, l1Provider);
- *
- * if (status.canCreateElection) {
- *   const { transaction, electionIndex } = prepareElectionCreation(status);
- *   console.log(`Creating election #${electionIndex}`);
- *   // Execute with your signer
- *   const tx = await signer.sendTransaction({
- *     to: transaction.to,
- *     data: transaction.data,
- *   });
- *   await tx.wait();
- * }
- * ```
- */
-export declare function prepareElectionCreation(electionStatus: Pick<ElectionStatus, "electionCount">, nomineeGovernorAddress?: string): PreparedElectionCreation;
-/**
- * Check if a governor has a vetting period (is a nominee election governor)
- *
- * @param governorAddress - Address of the governor to check
- * @param provider - Provider for the chain the governor is on
- * @returns True if the governor has a vetting period
- */
-export declare function hasVettingPeriod(governorAddress: string, provider: ethers.providers.Provider): Promise<boolean>;
-/**
- * Track the status of a Security Council election by its index
- *
- * This function provides detailed tracking of an election's progress through
- * the nominee selection, vetting, and member election phases.
- *
- * @param electionIndex - The election index to track
- * @param l2Provider - Arbitrum One provider
- * @param l1Provider - Ethereum mainnet provider (for L1 block number)
- * @param options - Optional address overrides
- * @returns Detailed election proposal status
- *
- * @example
- * ```typescript
- * const status = await trackElectionProposal(
- *   5, // election index
- *   l2Provider,
- *   l1Provider
- * );
- *
- * if (status.phase === "VETTING_PERIOD") {
- *   console.log(`${status.compliantNomineeCount}/6 nominees compliant`);
- * }
- * ```
- */
-export declare function trackElectionProposal(electionIndex: number, l2Provider: ethers.providers.Provider, _l1Provider: ethers.providers.Provider, options?: {
-    nomineeGovernorAddress?: string;
-    memberGovernorAddress?: string;
-}): Promise<ElectionProposalStatus>;
-/**
- * Get the proposal ID for a given election index
- *
- * Uses getProposeArgs to get proposal parameters and hashProposal to calculate the proposal ID.
- * Verifies the proposal exists by checking state() - returns null if proposal doesn't exist.
- *
- * @param electionIndex - Election index
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Proposal ID or null if election not yet created
- */
-export declare function getElectionProposalId(electionIndex: number, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<string | null>;
-/**
- * Get the member election proposal ID for a given election index
- *
- * @param electionIndex - Election index
- * @param provider - L2 provider
- * @param memberGovernorAddress - Optional governor address override
- * @returns Member proposal ID as string
- */
-export declare function getMemberElectionProposalId(electionIndex: number, provider: ethers.providers.Provider, memberGovernorAddress?: string): Promise<string>;
-/**
- * Get the proposal parameters for an election proposal
- *
- * Searches for the ProposalCreated event to extract targets, values, calldatas,
- * and description needed for execute() call.
- *
- * @param electionIndex - Election index
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Election proposal params or null if not found
- */
-export declare function getElectionProposalParams(electionIndex: number, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<ElectionProposalParams | null>;
-/**
- * Prepare a transaction to trigger member election creation
- *
- * After the vetting period ends with 6+ compliant nominees, calling execute()
- * on the NomineeElectionGovernor creates the member election proposal.
- *
- * @param electionStatus - Status from trackElectionProposal (must have canProceedToMemberPhase=true)
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Prepared transaction or null if not ready
- *
- * @example
- * ```typescript
- * const status = await trackElectionProposal(5, l2Provider, l1Provider);
- *
- * if (status.canProceedToMemberPhase) {
- *   const prepared = await prepareMemberElectionTrigger(status, l2Provider);
- *   if (prepared) {
- *     const tx = await signer.sendTransaction({
- *       to: prepared.to,
- *       data: prepared.data,
- *     });
- *     await tx.wait();
- *     console.log("Member election created!");
- *   }
- * }
- * ```
- */
-export declare function prepareMemberElectionTrigger(electionStatus: Pick<ElectionProposalStatus, "electionIndex" | "canProceedToMemberPhase">, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<PreparedTransaction | null>;
-/**
- * Get proposal parameters for a member election
- *
- * Retrieves the targets, values, calldatas, and description hash needed to
- * execute a member election proposal.
- *
- * @param electionIndex - Election index
- * @param provider - L2 provider
- * @param memberGovernorAddress - Optional governor address override
- * @returns Proposal parameters or null if not found
- */
-export declare function getMemberElectionProposalParams(electionIndex: number, provider: ethers.providers.Provider, memberGovernorAddress?: string): Promise<ElectionProposalParams | null>;
-/**
- * Prepare a transaction to execute member election result
- *
- * After member voting succeeds, calling execute() on the MemberElectionGovernor
- * installs the new Security Council members.
- *
- * @param electionStatus - Status from trackElectionProposal (must have canExecuteMember=true)
- * @param provider - L2 provider
- * @param memberGovernorAddress - Optional governor address override
- * @returns Prepared transaction or null if not ready
- *
- * @example
- * ```typescript
- * const status = await trackElectionProposal(5, l2Provider, l1Provider);
- *
- * if (status.canExecuteMember) {
- *   const prepared = await prepareMemberElectionExecution(status, l2Provider);
- *   if (prepared) {
- *     const tx = await signer.sendTransaction({
- *       to: prepared.to,
- *       data: prepared.data,
- *     });
- *     await tx.wait();
- *     console.log("New Security Council members installed!");
- *   }
- * }
- * ```
- */
-export declare function prepareMemberElectionExecution(electionStatus: Pick<ElectionProposalStatus, "electionIndex" | "canExecuteMember">, provider: ethers.providers.Provider, memberGovernorAddress?: string): Promise<PreparedTransaction | null>;
-/**
- * Find the election index for a given proposal ID
- *
- * Searches through elections to find which one contains the given proposal ID
- * (either as nominee or member proposal).
- *
- * @param proposalId - The proposal ID to find
- * @param l2Provider - L2 provider
- * @param l1Provider - L1 provider (needed for trackElectionProposal)
- * @returns Election index or null if not found
- */
-export declare function getElectionIndexForProposalId(proposalId: string, l2Provider: ethers.providers.Provider, l1Provider: ethers.providers.Provider): Promise<number | null>;
-/**
- * Track all active elections (not yet completed)
- *
- * Returns election statuses for all elections that are still in progress.
- *
- * @param l2Provider - L2 provider
- * @param l1Provider - L1 provider
- * @returns Array of election statuses for active elections
- */
-export declare function trackAllElections(l2Provider: ethers.providers.Provider, l1Provider: ethers.providers.Provider): Promise<ElectionProposalStatus[]>;
-/**
- * Track only incomplete elections (not yet completed)
- *
- * Returns election statuses for elections that are still in progress.
- * Completed elections are excluded.
- *
- * @param l2Provider - L2 provider
- * @param l1Provider - L1 provider
- * @returns Array of election statuses for incomplete elections
- */
-export declare function trackIncompleteElections(l2Provider: ethers.providers.Provider, l1Provider: ethers.providers.Provider): Promise<ElectionProposalStatus[]>;
-/**
- * Get all contenders who registered for a nominee election
- *
- * Fetches ContenderAdded events to build the list of registered contenders.
- *
- * @param proposalId - Nominee election proposal ID
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Array of contenders with registration info
- */
-export declare function getContenders(proposalId: string, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<ElectionContender[]>;
-/**
- * Get all nominees for a nominee election with their vote counts
- *
- * Fetches nominee list from contract and enriches with vote data.
- *
- * @param proposalId - Nominee election proposal ID
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Array of nominees with vote and exclusion data
- */
-export declare function getNomineesWithVotes(proposalId: string, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<ElectionNominee[]>;
-/**
- * Get excluded nominees with exclusion details
- *
- * Fetches NomineeExcluded events to get exclusion information.
- *
- * @param proposalId - Nominee election proposal ID
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Array of excluded nominees with exclusion tx info
- */
-export declare function getExcludedNominees(proposalId: string, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<ElectionNominee[]>;
-/**
- * Get detailed nominee election information
- *
- * Aggregates contenders, nominees, excluded nominees, and voting data.
- *
- * @param electionIndex - Election index
- * @param provider - L2 provider
- * @param nomineeGovernorAddress - Optional governor address override
- * @returns Detailed nominee election data or null if not found
- */
-export declare function getNomineeElectionDetails(electionIndex: number, provider: ethers.providers.Provider, nomineeGovernorAddress?: string): Promise<NomineeElectionDetails | null>;
-/**
- * Get member election results with weighted votes
- *
- * Fetches top nominees (winners) and their weighted vote totals.
- *
- * @param electionIndex - Election index
- * @param provider - L2 provider
- * @param memberGovernorAddress - Optional governor address override
- * @param nomineeGovernorAddress - Optional nominee governor address override
- * @returns Detailed member election data or null if not found
- */
-export declare function getMemberElectionDetails(electionIndex: number, provider: ethers.providers.Provider, memberGovernorAddress?: string, nomineeGovernorAddress?: string): Promise<MemberElectionDetails | null>;
-//# sourceMappingURL=election.d.ts.map

package/dist/election.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"election.d.ts","sourceRoot":"","sources":["../src/election.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAG3C,OAAO,EACL,mBAAmB,EAKnB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,eAAe,EAEf,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAajB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,0BAA0B;IAC1B,WAAW,EAAE,mBAAmB,CAAC;IACjC,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,uBAAuB;IACvB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,iBAAiB;IACjB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,gCAAgC;IAChC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,eAAe,EAAE,MAAM,CAAC;CACzB;AAyCD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,mBAAmB,CACvC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACrC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACrC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,cAAc,CAAC,CA6CzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,EACrD,sBAAsB,GAAE,MAA4C,GACnE,wBAAwB,CAgB1B;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,GAClC,OAAO,CAAC,OAAO,CAAC,CASlB;AA6ED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,qBAAqB,CACzC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACrC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACtC,OAAO,GAAE;IACP,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAC3B,GACL,OAAO,CAAC,sBAAsB,CAAC,CAoHjC;AAqCD;;;;;;;;;;GAUG;AACH,wBAAsB,qBAAqB,CACzC,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAYxB;AAED;;;;;;;GAOG;AACH,wBAAsB,2BAA2B,CAC/C,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,qBAAqB,GAAE,MAA2C,GACjE,OAAO,CAAC,MAAM,CAAC,CAGjB;AAqFD;;;;;;;;;;GAUG;AACH,wBAAsB,yBAAyB,CAC7C,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAWxC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,4BAA4B,CAChD,cAAc,EAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,GAAG,yBAAyB,CAAC,EACzF,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAwBrC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,+BAA+B,CACnD,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,qBAAqB,GAAE,MAA2C,GACjE,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAsBxC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,8BAA8B,CAClD,cAAc,EAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,GAAG,kBAAkB,CAAC,EAClF,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,qBAAqB,GAAE,MAA2C,GACjE,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAwBrC;AAID;;;;;;;;;;GAUG;AACH,wBAAsB,6BAA6B,CACjD,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACrC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,GACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA4BxB;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACrC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,GACpC,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAoBnC;AAED;;;;;;;;;GASG;AACH,wBAAsB,wBAAwB,CAC5C,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACrC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,GACpC,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAGnC;AAMD;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CACjC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAoC9B;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CACxC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,eAAe,EAAE,CAAC,CAkB5B;AAED;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CACvC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,eAAe,EAAE,CAAC,CA6C5B;AAED;;;;;;;;;GASG;AACH,wBAAsB,yBAAyB,CAC7C,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAkCxC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,wBAAwB,CAC5C,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,qBAAqB,GAAE,MAA2C,EAClE,sBAAsB,GAAE,MAA4C,GACnE,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAwDvC"}