@peeramid-labs/sdk 3.15.0 → 3.16.0

package/lib.commonjs/ubi/InstanceUBI.js

@@ -0,0 +1,728 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../utils/index");
+const abis_1 = __importDefault(require("../abis"));
+const { UBIAbi } = abis_1.default;
+const InstanceBase_1 = __importDefault(require("../rankify/InstanceBase"));
+/**
+ * Class for interacting with UBI facet of a Rankify instance
+ * Extends InstanceBase and provides UBI-specific functionality
+ */
+class InstanceUBI extends InstanceBase_1.default {
+    /** Wallet client for write operations (optional) */
+    walletClient;
+    /** Account address for write operations */
+    account;
+    /**
+     * Creates a new InstanceUBI
+     * @param {Object} params - Constructor parameters
+     * @param {PublicClient} params.publicClient - Public client for blockchain interactions
+     * @param {WalletClient} params.walletClient - Optional wallet client for write operations
+     * @param {number} params.chainId - Chain ID of the network
+     * @param {Address} params.instanceAddress - Address of the Rankify instance with UBI facet
+     * @param {Address} params.account - Optional account address for write operations
+     * @param {EnvioGraphQLClient} params.envioClient - Envio GraphQL client for event queries
+     */
+    constructor({ publicClient, walletClient, chainId, instanceAddress, account, envioClient, }) {
+        super({
+            publicClient,
+            chainId,
+            instanceAddress,
+            envioClient,
+        });
+        this.walletClient = walletClient;
+        this.account = account || walletClient?.account?.address;
+    }
+    /**
+     * Gets the current day number based on block timestamp
+     * @returns The current day number (block.timestamp / 1 days)
+     */
+    getCurrentDay = async () => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "getCurrentDay",
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the current day number (alias for getCurrentDay)
+     * @returns The current day number
+     */
+    currentDay = async () => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "currentDay",
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the UBI system parameters
+     * @returns Object containing dailyClaimAmount, dailySupportAmount, and domainName
+     */
+    getUBIParams = async () => {
+        try {
+            const [dailyClaimAmount, dailySupportAmount, domainName] = await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "getUBIParams",
+            });
+            console.log("dailyClaimAmount", dailyClaimAmount);
+            console.log("dailySupportAmount", dailySupportAmount);
+            console.log("domainName", domainName);
+            return {
+                dailyClaimAmount,
+                dailySupportAmount,
+                domainName,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the lifetime statistics for a proposal
+     * @param proposalHash - The hash of the proposal
+     * @returns Object containing aggregateScore, proposedTimes, and repostedTimes
+     */
+    getProposalLifetimeStats = async (proposalHash) => {
+        try {
+            const result = await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "proposalLifetimeStats",
+                args: [proposalHash],
+            });
+            return {
+                aggregateScore: result.aggregateScore,
+                proposedTimes: result.proposedTimes,
+                repostedTimes: result.repostedTimes,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the daily score for a proposal on a specific day
+     * @param proposalHash - The hash of the proposal
+     * @param day - The day number to query
+     * @returns DailyProposal object with proposal details for that day
+     */
+    getProposalDailyScore = async (proposalHash, day) => {
+        try {
+            const result = await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "getProposalDailyScore",
+                args: [proposalHash, day],
+            });
+            return {
+                proposal: result.proposal,
+                score: result.score,
+                proposer: result.proposer,
+                exists: result.exists,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the total number of proposals for a specific day
+     * @param day - The day number to query
+     * @returns The count of proposals for that day
+     */
+    getProposalsCnt = async (day) => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "getProposalsCnt",
+                args: [day],
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the day a user last claimed their tokens
+     * @param user - The address of the user
+     * @returns The day number of the last claim (0 if never claimed)
+     */
+    getLastClaimedAt = async (user) => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "lastClaimedAt",
+                args: [user],
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the current state for a user
+     * @param user - The address of the user
+     * @returns Object containing claimedToday and supportSpent
+     */
+    getUserState = async (user) => {
+        try {
+            const [claimedToday, supportSpent] = await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "getUserState",
+                args: [user],
+            });
+            return {
+                claimedToday,
+                supportSpent,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the address of the pauser
+     * @returns The address with pausing/unpausing permissions
+     */
+    getPauser = async () => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "pauser",
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the Multipass contract address
+     * @returns The address of the Multipass contract
+     */
+    getMultipass = async () => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "multipass",
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the governance token contract address
+     * @returns The address of the DistributableGovernanceERC20 token
+     */
+    getToken = async () => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "token",
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Checks if the contract is currently paused
+     * @returns True if paused, false otherwise
+     */
+    isPaused = async () => {
+        try {
+            return await this.publicClient.readContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "paused",
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets comprehensive information about a user's current status
+     * @param user - The address of the user
+     * @returns Object containing user state, last claimed day, and current day
+     */
+    getUserInfo = async (user) => {
+        try {
+            const [userState, lastClaimedAt, currentDay] = await Promise.all([
+                this.getUserState(user),
+                this.getLastClaimedAt(user),
+                this.getCurrentDay(),
+            ]);
+            return {
+                userState,
+                lastClaimedAt,
+                currentDay,
+                canClaim: lastClaimedAt < currentDay,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets comprehensive information about a proposal
+     * @param proposalHash - The hash of the proposal
+     * @param day - Optional day to get daily score (defaults to current day - 1)
+     * @returns Object containing lifetime stats and daily score
+     */
+    getProposalInfo = async (proposalHash, day) => {
+        try {
+            const queryDay = day ?? (await this.getCurrentDay()) - 1n;
+            const [lifetimeStats, dailyScore] = await Promise.all([
+                this.getProposalLifetimeStats(proposalHash),
+                this.getProposalDailyScore(proposalHash, queryDay),
+            ]);
+            return {
+                lifetimeStats,
+                dailyScore,
+                day: queryDay,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets all proposals for a specific day (requires querying events or off-chain indexer)
+     * This is a helper method that would typically use an indexer/subgraph
+     * @param day - The day to query
+     * @returns The count of proposals for that day
+     */
+    getDayProposals = async (day) => {
+        try {
+            const count = await this.getProposalsCnt(day);
+            return {
+                count,
+                day,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    // ==================== WRITE OPERATIONS ====================
+    /**
+     * Claims daily UBI tokens and optionally submits a proposal
+     * @param proposalText - The proposal text (empty string for no proposal)
+     * @returns Transaction hash
+     * @throws Error if wallet client is not configured
+     */
+    claim = async (proposalText = "") => {
+        if (!this.walletClient) {
+            throw new Error("Wallet client required for write operations");
+        }
+        if (!this.account) {
+            throw new Error("Account required for write operations");
+        }
+        try {
+            const { request } = await this.publicClient.simulateContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "claim",
+                args: [proposalText],
+                account: this.account,
+            });
+            const hash = await this.walletClient.writeContract(request);
+            return hash;
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Supports one or more proposals from the previous day using quadratic voting
+     * @param votes - Array of vote elements (proposal hash and amount)
+     * @returns Transaction hash
+     * @throws Error if wallet client is not configured
+     */
+    support = async (votes) => {
+        if (!this.walletClient) {
+            throw new Error("Wallet client required for write operations");
+        }
+        if (!this.account) {
+            throw new Error("Account required for write operations");
+        }
+        try {
+            const formattedVotes = votes.map((v) => ({
+                proposal: v.proposal,
+                amount: v.amount,
+            }));
+            const { request } = await this.publicClient.simulateContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "support",
+                args: [formattedVotes],
+                account: this.account,
+            });
+            const hash = await this.walletClient.writeContract(request);
+            return hash;
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Pauses the UBI contract (only callable by pauser)
+     * @returns Transaction hash
+     * @throws Error if wallet client is not configured or caller is not pauser
+     */
+    pause = async () => {
+        if (!this.walletClient) {
+            throw new Error("Wallet client required for write operations");
+        }
+        if (!this.account) {
+            throw new Error("Account required for write operations");
+        }
+        try {
+            const { request } = await this.publicClient.simulateContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "pause",
+                account: this.account,
+            });
+            const hash = await this.walletClient.writeContract(request);
+            return hash;
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Unpauses the UBI contract (only callable by pauser)
+     * @returns Transaction hash
+     * @throws Error if wallet client is not configured or caller is not pauser
+     */
+    unpause = async () => {
+        if (!this.walletClient) {
+            throw new Error("Wallet client required for write operations");
+        }
+        if (!this.account) {
+            throw new Error("Account required for write operations");
+        }
+        try {
+            const { request } = await this.publicClient.simulateContract({
+                address: this.instanceAddress,
+                abi: UBIAbi,
+                functionName: "unpause",
+                account: this.account,
+            });
+            const hash = await this.walletClient.writeContract(request);
+            return hash;
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    // ==================== INDEXER QUERY METHODS ====================
+    /**
+     * Gets proposals submitted by a specific address
+     * @param proposer - Optional address to filter by proposer
+     * @param day - Optional day to filter proposals
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of proposal events
+     */
+    getProposalsByAddress = async ({ proposer, day, limit = 100, offset = 0, } = {}) => {
+        try {
+            return await this.envioClient.getUBIProposingByAddressEvents({
+                instanceAddress: this.instanceAddress,
+                proposer,
+                day,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets all proposals for a specific day
+     * @param day - Optional day to filter proposals (defaults to current day - 1)
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of proposal events for the day
+     */
+    getDailyProposals = async ({ day, limit = 100, offset = 0, } = {}) => {
+        try {
+            const queryDay = day ?? (await this.getCurrentDay()) - 1n;
+            return await this.envioClient.getUBIProposingByAddressEvents({
+                instanceAddress: this.instanceAddress,
+                day: queryDay,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets proposal score updates for a specific proposal
+     * @param proposal - Proposal hash to query
+     * @param day - Optional day to filter results
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of proposal score update events
+     */
+    getProposalScoreHistory = async ({ proposal, day, limit = 100, offset = 0, } = {}) => {
+        try {
+            return await this.envioClient.getUBIProposalScoreUpdatedByProposalEvents({
+                instanceAddress: this.instanceAddress,
+                proposal,
+                day,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets voting events for a specific participant
+     * @param participant - Address to filter by participant
+     * @param day - Optional day to filter votes
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of voting events
+     */
+    getVotesByAddress = async ({ participant, day, limit = 100, offset = 0, } = {}) => {
+        try {
+            return await this.envioClient.getUBIVotingByAddressEvents({
+                instanceAddress: this.instanceAddress,
+                participant,
+                day,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets all votes for a specific day
+     * @param day - Optional day to filter votes (defaults to current day - 1)
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of voting events for the day
+     */
+    getDailyVotes = async ({ day, limit = 100, offset = 0, } = {}) => {
+        try {
+            const queryDay = day ?? (await this.getCurrentDay()) - 1n;
+            return await this.envioClient.getUBIVotingByAddressEvents({
+                instanceAddress: this.instanceAddress,
+                day: queryDay,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets claim history
+     * @param user - Optional user address to filter claims
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of claim events
+     */
+    getClaimHistory = async ({ user, limit = 100, offset = 0, } = {}) => {
+        try {
+            return await this.envioClient.getUBIClaimedEvents({
+                instanceAddress: this.instanceAddress,
+                user,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets repost events by reposter
+     * @param reposter - Optional address to filter by reposter
+     * @param day - Optional day to filter reposts
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of repost events
+     */
+    getRepostsByAddress = async ({ reposter, day, limit = 100, offset = 0, } = {}) => {
+        try {
+            return await this.envioClient.getUBIRepostByReposterEvents({
+                instanceAddress: this.instanceAddress,
+                reposter,
+                day,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets lifetime scores for all proposals
+     * @param limit - Maximum number of results to return
+     * @param offset - Number of results to skip
+     * @returns Array of proposal lifetime score events
+     */
+    getProposalLifetimeScores = async ({ limit = 100, offset = 0, } = {}) => {
+        try {
+            return await this.envioClient.getUBIProposalLifetimeScoreEvents({
+                instanceAddress: this.instanceAddress,
+                limit,
+                offset,
+            });
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets comprehensive proposal data including proposals, scores, and votes for a specific day
+     * @param day - Optional day to query (defaults to current day - 1)
+     * @param limit - Maximum number of results per query
+     * @returns Object containing proposals, scores, and votes for the day
+     */
+    getDayActivity = async ({ day, limit = 100, } = {}) => {
+        try {
+            const queryDay = day ?? (await this.getCurrentDay()) - 1n;
+            const [proposals, votes, reposts] = await Promise.all([
+                this.getDailyProposals({ day: queryDay, limit }),
+                this.getDailyVotes({ day: queryDay, limit }),
+                this.getRepostsByAddress({ day: queryDay, limit }),
+            ]);
+            return {
+                day: queryDay,
+                proposals,
+                votes,
+                reposts,
+                proposalCount: proposals.length,
+                voteCount: votes.length,
+                repostCount: reposts.length,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets comprehensive user activity data
+     * @param user - User address to query
+     * @param limit - Maximum number of results per query
+     * @returns Object containing user's proposals, votes, reposts, and claims
+     */
+    getUserActivity = async ({ user, limit = 100 }) => {
+        try {
+            const [proposals, votes, reposts, claims, userInfo] = await Promise.all([
+                this.getProposalsByAddress({ proposer: user, limit }),
+                this.getVotesByAddress({ participant: user, limit }),
+                this.getRepostsByAddress({ reposter: user, limit }),
+                this.getClaimHistory({ user, limit }),
+                this.getUserInfo(user),
+            ]);
+            return {
+                user,
+                userInfo,
+                proposals,
+                votes,
+                reposts,
+                claims,
+                proposalCount: proposals.length,
+                voteCount: votes.length,
+                repostCount: reposts.length,
+                claimCount: claims.length,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets aggregated proposal scores from voting events
+     * @param day - Optional day to filter votes
+     * @param limit - Maximum number of voting events to fetch
+     * @returns Map of proposal hashes to their total support scores
+     */
+    getProposalScores = async ({ day, limit = 1000, } = {}) => {
+        try {
+            const votes = await this.getVotesByAddress({
+                day,
+                limit,
+            });
+            // Aggregate votes by proposal
+            const proposalScores = new Map();
+            votes.forEach((vote) => {
+                // Each vote event has proposal and amount directly
+                const proposalHash = vote.proposal;
+                const amount = vote.amount || BigInt(0);
+                const currentScore = proposalScores.get(proposalHash) || BigInt(0);
+                proposalScores.set(proposalHash, currentScore + amount);
+            });
+            // Convert to array and sort by score
+            const sortedScores = Array.from(proposalScores.entries())
+                .map(([proposal, score]) => ({
+                proposal,
+                score,
+                stars: Math.floor(Number(score)), // Direct token count as stars
+            }))
+                .sort((a, b) => Number(b.score - a.score));
+            return sortedScores;
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+    /**
+     * Gets the score for a specific proposal
+     * @param proposalHash - The hash of the proposal
+     * @param day - Optional day to filter votes
+     * @returns Total support score for the proposal
+     */
+    getProposalScore = async (proposalHash, day) => {
+        try {
+            const scores = await this.getProposalScores({ day });
+            const proposalScore = scores.find((s) => s.proposal === proposalHash);
+            return {
+                proposal: proposalHash,
+                score: proposalScore?.score || BigInt(0),
+                stars: proposalScore?.stars || 0,
+            };
+        }
+        catch (e) {
+            throw await (0, index_1.handleRPCError)(e);
+        }
+    };
+}
+exports.default = InstanceUBI;
+//# sourceMappingURL=InstanceUBI.js.map