@glowlabs-org/utils 0.2.95 → 0.2.97

package/dist/cjs/lib/abis/offchainFractions.d.ts

@@ -0,0 +1,473 @@
+export declare const OFFCHAIN_FRACTIONS_ABI: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "contract CounterfactualHolderFactory";
+        readonly name: "_counterfactualHolderFactory";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "target";
+        readonly type: "address";
+    }];
+    readonly name: "AddressEmptyCode";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly name: "AddressInsufficientBalance";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "AlreadyClaimed";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "AlreadyClosed";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "AlreadyExists";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "AlreadySent";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "CannotClaimPayoutWhenRoundNotFullyFilled";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "CannotClaimRefundWhenNotExpired";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "CannotClaimRefundWhenRoundFullyFilled";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "CannotCloseAFullRound";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "CannotHaveZeroTotalSteps";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "Expired";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "FailedInnerCall";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "InsufficientSharesAvailable";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "InvalidToAddress";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "InvalidToken";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MinSharesCannotBeGreaterThanTotalSteps";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "NoStepsPurchased";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "NotAllOrNothing";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "NotFractionsOwner";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "RecipientCannotBeSelf";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "ReentrancyGuardReentrantCall";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }];
+    readonly name: "SafeERC20FailedOperation";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "StepMustBeGreaterThanZero";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "TaxTokenNotSupported";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "TotalRaisedOverflow";
+    readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "ZeroSteps";
+    readonly type: "error";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "owner";
+        readonly type: "address";
+    }];
+    readonly name: "FractionClosed";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "step";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "totalSteps";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint48";
+        readonly name: "expiration";
+        readonly type: "uint48";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "address";
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "bool";
+        readonly name: "useCounterfactualAddress";
+        readonly type: "bool";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "minSharesToRaise";
+        readonly type: "uint256";
+    }];
+    readonly name: "FractionCreated";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "user";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "FractionRefunded";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "buyer";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "step";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "FractionSold";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "minShares";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "newTotalSharesSold";
+        readonly type: "uint256";
+    }];
+    readonly name: "MinSharesReached";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }];
+    readonly name: "RoundFilled";
+    readonly type: "event";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "stepsToBuy";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "minStepsToBuy";
+        readonly type: "uint256";
+    }];
+    readonly name: "buyFractions";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }];
+    readonly name: "claimRefund";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }];
+    readonly name: "closeFraction";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "step";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "totalSteps";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint48";
+        readonly name: "expiration";
+        readonly type: "uint48";
+    }, {
+        readonly internalType: "address";
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bool";
+        readonly name: "useCounterfactualAddress";
+        readonly type: "bool";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "minSharesToRaise";
+        readonly type: "uint256";
+    }];
+    readonly name: "createFraction";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }];
+    readonly name: "getFraction";
+    readonly outputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint48";
+            readonly name: "expiration";
+            readonly type: "uint48";
+        }, {
+            readonly internalType: "bool";
+            readonly name: "manuallyClosed";
+            readonly type: "bool";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "minSharesToRaise";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "bool";
+            readonly name: "useCounterfactualAddress";
+            readonly type: "bool";
+        }, {
+            readonly internalType: "bool";
+            readonly name: "claimedFromMinSharesToRaise";
+            readonly type: "bool";
+        }, {
+            readonly internalType: "address";
+            readonly name: "owner";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "step";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "address";
+            readonly name: "to";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "soldSteps";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "totalSteps";
+            readonly type: "uint256";
+        }];
+        readonly internalType: "struct OffchainFractions.FractionData";
+        readonly name: "";
+        readonly type: "tuple";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "i_CFHFactory";
+    readonly outputs: readonly [{
+        readonly internalType: "contract CounterfactualHolderFactory";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "user";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "id";
+        readonly type: "bytes32";
+    }];
+    readonly name: "stepsPurchased";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "stepsPurchased";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];

package/dist/cjs/lib/control-api/farms-router.d.ts

@@ -1,4 +1,5 @@
-import type { SponsoredFarm } from "../types";
+import type { SponsoredFarm, EstimateRewardScoreParams, RewardScoreResponse } from "../types";
 export declare function FarmsRouter(baseUrl: string): {
     readonly fetchSponsoredFarms: (sponsorWallet?: string) => Promise<SponsoredFarm[]>;
+    readonly estimateRewardScore: (params: EstimateRewardScoreParams) => Promise<RewardScoreResponse>;
 };

package/dist/cjs/lib/hooks/use-offchain-fractions.d.ts

@@ -0,0 +1,60 @@
+import { type Signer } from "ethers";
+export declare enum OffchainFractionsError {
+    CONTRACT_NOT_AVAILABLE = "Contract not available",
+    SIGNER_NOT_AVAILABLE = "Signer not available",
+    UNKNOWN_ERROR = "Unknown error",
+    INVALID_PARAMETERS = "Invalid parameters",
+    FRACTION_NOT_FOUND = "Fraction not found",
+    INSUFFICIENT_BALANCE = "Insufficient balance",
+    INSUFFICIENT_ALLOWANCE = "Insufficient allowance"
+}
+export interface FractionData {
+    token: string;
+    expiration: number;
+    manuallyClosed: boolean;
+    minSharesToRaise: bigint;
+    useCounterfactualAddress: boolean;
+    claimedFromMinSharesToRaise: boolean;
+    owner: string;
+    step: bigint;
+    to: string;
+    soldSteps: bigint;
+    totalSteps: bigint;
+}
+export interface CreateFractionParams {
+    id: string;
+    token: string;
+    step: bigint;
+    totalSteps: bigint;
+    expiration: number;
+    to: string;
+    useCounterfactualAddress: boolean;
+    minSharesToRaise: bigint;
+}
+export interface BuyFractionsParams {
+    creator: string;
+    id: string;
+    stepsToBuy: bigint;
+    minStepsToBuy: bigint;
+}
+export declare function useOffchainFractions(signer: Signer | undefined, CHAIN_ID: number): {
+    createFraction: (params: CreateFractionParams) => Promise<string>;
+    buyFractions: (params: BuyFractionsParams) => Promise<string>;
+    claimRefund: (creator: string, id: string) => Promise<string>;
+    closeFraction: (id: string) => Promise<string>;
+    getFraction: (creator: string, id: string) => Promise<FractionData>;
+    getStepsPurchased: (user: string, creator: string, id: string) => Promise<bigint>;
+    approveToken: (tokenAddress: string, amount: bigint) => Promise<boolean>;
+    checkTokenAllowance: (owner: string, tokenAddress: string) => Promise<bigint>;
+    checkTokenBalance: (owner: string, tokenAddress: string) => Promise<bigint>;
+    isFractionExpired: (creator: string, id: string) => Promise<boolean>;
+    hasReachedMinimumShares: (creator: string, id: string) => Promise<boolean>;
+    isFractionCompletelyFilled: (creator: string, id: string) => Promise<boolean>;
+    getTotalAmountRaised: (creator: string, id: string) => Promise<bigint>;
+    getRemainingSteps: (creator: string, id: string) => Promise<bigint>;
+    estimateGasForCreateFraction: (params: CreateFractionParams, ethPriceInUSD: number | null) => Promise<string>;
+    estimateGasForBuyFractions: (params: BuyFractionsParams, ethPriceInUSD: number | null) => Promise<string>;
+    readonly isProcessing: boolean;
+    addresses: Record<import("../../constants/addresses").ContractKeys, `0x${string}`>;
+    isSignerAvailable: boolean;
+};

package/dist/cjs/lib/types/index.d.ts

@@ -383,4 +383,68 @@ export interface WalletDetails {
     ownedFarms: WalletFarmInfo[];
     purchasedFarms: WalletFarmInfo[];
 }
+export interface EstimateRewardScoreParams {
+    userId: string;
+    sponsorSplitPercent: number;
+    protocolDepositAmount: string;
+    paymentCurrency: PaymentCurrency;
+    adjustedWeeklyCarbonCredits: number;
+    zone: {
+        id: number;
+        name?: string;
+    };
+}
+export interface RewardScoreResponse {
+    rewardScore: number;
+    userWeeklyPdRewards: string;
+    userWeeklyPdRewardsUsd: string;
+    userWeeklyGlwRewards: string;
+    userWeeklyGlwValueUsd: string;
+    userEstimatedWeeklyCash: string;
+    userProtocolDeposit: string;
+    userGlowSplitPercent: string;
+    userDepositSplitPercent: string;
+    glwPriceUsd6: string;
+    regionInfo: {
+        regionId: number;
+        regionName: string;
+        existingFarmCount: number;
+        existingTotalDepositsUsd: string;
+        currencyBreakdown: {
+            currency: string;
+            protocolDepositSum: string;
+            carbonCreditProductionSum: string;
+        }[];
+        regionGctlStaked: string;
+        totalGctlStakedAllRegions: string;
+    };
+}
+export interface EstimateRewardScoreApiResponse {
+    rewardScore: number;
+    userWeeklyPdRewards: string;
+    userWeeklyPdRewardsUsd: string;
+    userWeeklyGlwRewards: string;
+    userWeeklyGlwValueUsd: string;
+    userEstimatedWeeklyCash: string;
+    userProtocolDeposit: string;
+    userGlowSplitPercent: string;
+    userDepositSplitPercent: string;
+    glwPriceUsd6: string;
+    regionInfo: {
+        regionId: number;
+        regionName: string;
+        existingFarmCount: number;
+        existingTotalDepositsUsd: string;
+        currencyBreakdown: {
+            currency: string;
+            protocolDepositSum: string;
+            carbonCreditProductionSum: string;
+        }[];
+        regionGctlStaked: string;
+        totalGctlStakedAllRegions: string;
+    };
+}
+export interface EstimateRewardScoreErrorResponse {
+    error: string;
+}
 export type { MintedEvent as ControlMintedEvent };

package/dist/esm/browser.d.ts

@@ -1,4 +1,5 @@
 export * from "./lib/hooks/use-forwarder";
+export * from "./lib/hooks/use-offchain-fractions";
 export * from "./lib/control-api/control-router";
 export * from "./lib/control-api/region-router";
 export * from "./lib/control-api/kickstarter-router";

package/dist/esm/browser.js

@@ -1,5 +1,5 @@
-import { T as TRANSFER_TYPES } from './farms-router-XDjQOQ-c.js';
-export { C as ControlRouter, D as DECIMALS_BY_TOKEN, e as FORWARDER_ABI, F as FarmsRouter, a as ForwarderError, f as GCA_URLS, G as GLOW_WEIGHT_DECIMAL_PRECISION, H as HUB_URL, K as KickstarterRouter, M as MAX_WEIGHT, O as OFF_CHAIN_PAYMENT_CURRENCIES, P as PAYMENT_CURRENCIES, R as RegionRouter, U as USDG_WEIGHT_DECIMAL_PRECISION, W as WalletsRouter, b as allRegions, d as countries, g as getAddresses, r as regionMetadata, c as usStates, u as useForwarder } from './farms-router-XDjQOQ-c.js';
+import { T as TRANSFER_TYPES } from './farms-router-Da1P3B8g.js';
+export { C as ControlRouter, D as DECIMALS_BY_TOKEN, g as FORWARDER_ABI, F as FarmsRouter, b as ForwarderError, i as GCA_URLS, G as GLOW_WEIGHT_DECIMAL_PRECISION, H as HUB_URL, K as KickstarterRouter, M as MAX_WEIGHT, c as OFF_CHAIN_PAYMENT_CURRENCIES, O as OffchainFractionsError, P as PAYMENT_CURRENCIES, R as RegionRouter, U as USDG_WEIGHT_DECIMAL_PRECISION, W as WalletsRouter, d as allRegions, f as countries, h as getAddresses, r as regionMetadata, e as usStates, u as useForwarder, a as useOffchainFractions } from './farms-router-Da1P3B8g.js';
 import { verifyTypedData, getAddress } from 'viem';
 import 'ethers';
 

package/dist/esm/constants/addresses.d.ts

@@ -1,3 +1,3 @@
-export type ContractKeys = "USDC" | "FORWARDER" | "FOUNDATION_WALLET" | "GLW" | "USDG" | "USDG_REDEMPTION" | "IMPACT_CATALYST" | "AUDIT_FEE_WALLET" | "UNISWAP_V2_ROUTER" | "UNISWAP_V2_FACTORY" | "USDG_UNISWAP" | "GLW_UNISWAP";
+export type ContractKeys = "USDC" | "FORWARDER" | "FOUNDATION_WALLET" | "GLW" | "USDG" | "USDG_REDEMPTION" | "IMPACT_CATALYST" | "AUDIT_FEE_WALLET" | "UNISWAP_V2_ROUTER" | "UNISWAP_V2_FACTORY" | "USDG_UNISWAP" | "GLW_UNISWAP" | "OFFCHAIN_FRACTIONS" | "COUNTERFACTUAL_HOLDER_FACTORY";
 export declare const getAddresses: (CHAIN_ID: number) => Record<ContractKeys, `0x${string}`>;
 export declare const DECIMALS_BY_TOKEN: Record<"USDC" | "USDG" | "GCTL" | "SGCTL" | "GLW", number>;