@wireio/stake 0.2.2 → 0.2.3

package/lib/stake.d.ts

@@ -1,5 +1,5 @@
 import * as _wireio_core from '@wireio/core';
-import { PublicKey, ExternalNetwork, ChainID } from '@wireio/core';
+import { ExternalNetwork, PublicKey, ChainID } from '@wireio/core';
 import { BaseSignerWalletAdapter } from '@solana/wallet-adapter-base';
 import * as _solana_web3_js from '@solana/web3.js';
 import { PublicKey as PublicKey$1, Transaction, VersionedTransaction, TokenAmount, Connection, TransactionSignature, Keypair, TransactionInstruction } from '@solana/web3.js';
@@ -8,6 +8,11 @@ import { JsonFragment } from '@ethersproject/abi';
 import { ErrorDescription } from '@ethersproject/abi/lib/interface';
 import { BN, AnchorProvider, Program } from '@coral-xyz/anchor';
 
+type StakerConfig = {
+    network: ExternalNetwork;
+    provider: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
+    pubKey: PublicKey;
+};
 interface IStakingClient {
     pubKey: PublicKey;
     network: ExternalNetwork;
@@ -16,15 +21,20 @@ interface IStakingClient {
     withdraw(amount: bigint): Promise<string>;
     stake(amount: bigint): Promise<string>;
     unstake(amount: bigint): Promise<string>;
-    /** Register any untracked LIQ staked tokens */
-    /** Fetch the portfolio for the LIQ stake user */
+    buy(amount: bigint, asset: PurchaseAsset): Promise<string>;
+    /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio>;
+    /**
+     * Program-level prelaunch WIRE/tranche snapshot for this chain.
+     *
+     * Returns:
+     *  - `TrancheSnapshot` when the chain supports pretoken/tranches
+     *  - `null` if this chain has no WIRE/pretoken integration
+     */
+    getTrancheSnapshot(): Promise<TrancheSnapshot | null>;
+    /**  */
+    getBuyQuote(amount: bigint, asset: PurchaseAsset): Promise<PurchaseQuote>;
 }
-type StakerConfig = {
-    network: ExternalNetwork;
-    provider: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
-    pubKey: PublicKey;
-};
 interface Portfolio {
     /** Native balance on chain: ETH, SOL */
     native: BalanceView;
@@ -32,6 +42,8 @@ interface Portfolio {
     liq: BalanceView;
     /** Outpost Staked balance */
     staked: BalanceView;
+    /** Prelaunch WIRE “shares” (warrants/pretokens) */
+    wire: BalanceView;
     /** SOL ONLY!
      * Tracked liqSOL balance from distribution program */
     tracked?: BalanceView;
@@ -43,9 +55,41 @@ interface Portfolio {
 type BalanceView = {
     amount: bigint;
     decimals: number;
-    symbol?: string;
+    symbol: string;
     ata?: PublicKey$1;
 };
+/**
+ * Program-global prelaunch WIRE / tranche state for a single chain.
+ *
+ * All integer values are raw on-chain integers:
+ *  - `currentTranchePriceUsd`: 1e8 USD
+ *  - supplies / warrants / shares: 1e8 WIRE units (per liqsol_core/ETH analog)
+ *  - index: same scale the program uses (INDEX_SCALE = 1e12 on Solana today)
+ */
+interface TrancheSnapshot {
+    chainID: ChainID;
+    totalShares: bigint;
+    currentIndex: bigint;
+    currentTrancheNumber: bigint;
+    currentTrancheSupply: bigint;
+    totalWarrantsSold: bigint;
+    currentTranchePriceUsd: bigint;
+}
+declare enum PurchaseAsset {
+    SOL = "SOL",
+    LIQSOL = "LIQSOL",
+    ETH = "ETH",
+    LIQETH = "LIQETH",
+    YIELD = "YIELD"
+}
+interface PurchaseQuote {
+    purchaseAsset: PurchaseAsset;
+    amountIn: bigint;
+    wireShares: bigint;
+    wireDecimals: number;
+    wirePriceUsd: bigint;
+    notionalUsd: bigint;
+}
 
 declare class Staker {
     selectedChainID?: ChainID;
@@ -184,6 +228,8 @@ declare class EthereumStakingClient implements IStakingClient {
     unstakePrelaunch(tokenId: bigint, recipient: string): Promise<string>;
     fetchPrelaunchReceipts(address?: string): Promise<preLaunchReceipt[]>;
     getEthStats(): Promise<any>;
+    buy(amount: bigint, purchaseAsset: PurchaseAsset): Promise<string>;
+    getBuyQuote(amount: bigint, purchaseAsset: PurchaseAsset): Promise<PurchaseQuote>;
     /**
      * Resolve the user's ETH + liqETH balances.
      *
@@ -192,6 +238,12 @@ declare class EthereumStakingClient implements IStakingClient {
      * tracked = liqETH tracked balance (protocol/accounting view)
      */
     getPortfolio(): Promise<Portfolio>;
+    /**
+     * Program-level prelaunch WIRE / tranche snapshot for Solana.
+     * Uses the same OutpostWireStateSnapshot primitive as getPortfolio().
+     * TODO! for eth
+     */
+    getTrancheSnapshot(): Promise<TrancheSnapshot | null>;
     private requestWithdraw;
 }
 
@@ -502,6 +554,13 @@ type WireReceipt = {
     purchasedSolShares: BN;
     bump: number;
 };
+type PriceHistory = {
+    windowSize: number;
+    prices: BN[];
+    count: number;
+    nextIndex: number;
+    bump: number;
+};
 
 type types_CorrectRegisterBuildResult = CorrectRegisterBuildResult;
 type types_CorrectRegisterPlan = CorrectRegisterPlan;
@@ -510,6 +569,7 @@ type types_GlobalState = GlobalState;
 type types_MismatchCandidate = MismatchCandidate;
 type types_OutpostWireStateSnapshot = OutpostWireStateSnapshot;
 type types_ParsedAccountInfo = ParsedAccountInfo;
+type types_PriceHistory = PriceHistory;
 type types_SharesPreview = SharesPreview;
 type types_SolanaTransaction = SolanaTransaction;
 type types_TrancheState = TrancheState;
@@ -518,7 +578,7 @@ type types_UserWarrantRecord = UserWarrantRecord;
 type types_WalletLike = WalletLike;
 type types_WireReceipt = WireReceipt;
 declare namespace types {
-  export type { types_CorrectRegisterBuildResult as CorrectRegisterBuildResult, types_CorrectRegisterPlan as CorrectRegisterPlan, types_DistributionState as DistributionState, types_GlobalState as GlobalState, types_MismatchCandidate as MismatchCandidate, types_OutpostWireStateSnapshot as OutpostWireStateSnapshot, types_ParsedAccountInfo as ParsedAccountInfo, types_SharesPreview as SharesPreview, types_SolanaTransaction as SolanaTransaction, types_TrancheState as TrancheState, types_UserRecord as UserRecord, types_UserWarrantRecord as UserWarrantRecord, types_WalletLike as WalletLike, types_WireReceipt as WireReceipt };
+  export type { types_CorrectRegisterBuildResult as CorrectRegisterBuildResult, types_CorrectRegisterPlan as CorrectRegisterPlan, types_DistributionState as DistributionState, types_GlobalState as GlobalState, types_MismatchCandidate as MismatchCandidate, types_OutpostWireStateSnapshot as OutpostWireStateSnapshot, types_ParsedAccountInfo as ParsedAccountInfo, types_PriceHistory as PriceHistory, types_SharesPreview as SharesPreview, types_SolanaTransaction as SolanaTransaction, types_TrancheState as TrancheState, types_UserRecord as UserRecord, types_UserWarrantRecord as UserWarrantRecord, types_WalletLike as WalletLike, types_WireReceipt as WireReceipt };
 }
 
 declare class SolanaStakingClient implements IStakingClient {
@@ -530,6 +590,7 @@ declare class SolanaStakingClient implements IStakingClient {
     private distributionClient;
     private leaderboardClient;
     private outpostClient;
+    private tokenClient;
     get solPubKey(): PublicKey$1;
     get network(): ExternalNetwork;
     constructor(config: StakerConfig);
@@ -556,15 +617,40 @@ declare class SolanaStakingClient implements IStakingClient {
      * @param amountLamports Amount of liqSOL principal to unstake (smallest unit)
      */
     unstake(amountLamports: bigint): Promise<string>;
+    /** Buy pretoken (warrants) using specified asset.
+     * @param amount Amount in smallest units (lamports / wei / token units).
+     *               Required for SOL / LIQSOL / ETH / LIQETH.
+     *               Ignored for YIELD (the program uses tracked yield).
+     * @param purchaseAsset Asset used to buy pretoken.
+     * @returns Transaction signature
+     */
+    buy(amountLamports: bigint, purchaseAsset: PurchaseAsset): Promise<string>;
     /**
      * native = SOL in wallet
      * liq    = liqSOL token balance (from Token-2022 ATA)
      * staked = Outpost staked liqSOL principal (from wireReceipt.stakedLiqsol)
      * tracked = liqSOL tracked balance (from Distribution.userRecord)
+     * wire   = prelaunch WIRE “shares” (UserWarrantRecord.totalWarrantsPurchased, 1e8)
      */
     getPortfolio(): Promise<Portfolio>;
+    /**
+     * Program-level prelaunch WIRE / tranche snapshot for Solana.
+     * Uses the same OutpostWireStateSnapshot primitive as getPortfolio().
+     */
+    getTrancheSnapshot(): Promise<TrancheSnapshot | null>;
+    getBuyQuote(amount: bigint, purchaseAsset: PurchaseAsset): Promise<PurchaseQuote>;
+    /**
+     * Exact warrant math reused from your old utils, just phrased in terms
+     * of already-computed USD notional:
+     *
+     *   expectedWarrants = (notionalUsd * 1e8) / wirePriceUsd
+     *
+     * where:
+     *   - notionalUsd, wirePriceUsd are 1e8-scaled USD
+     *   - result is 1e8-scaled WIRE "shares"
+     */
+    private calculateExpectedWarrants;
     getUserRecord(): Promise<UserRecord | null>;
-    getProtocolFee(): void;
     correctBalance(amount?: bigint): Promise<string>;
     private sendAndConfirmHttp;
     signTransaction(tx: SolanaTransaction): Promise<SolanaTransaction>;
@@ -630,6 +716,7 @@ declare const PDA_SEEDS: {
     readonly BAR_STATE_SEED: "bar_state";
     readonly BONDED_ACTOR_SEED: "bonded_actor";
     readonly BOND_LEVEL_SEED: "bond_level";
+    readonly PRICE_HISTORY: "price_history";
 };
 /**
  * Helpers for PDA derivation so clients don’t duplicate logic.
@@ -662,6 +749,7 @@ declare const deriveUserWarrantRecordPda: (user: PublicKey$1) => PublicKey$1;
 declare const deriveBarConfigPda: () => PublicKey$1;
 declare const deriveBondLevelPda: (bondLevelId: number[]) => PublicKey$1;
 declare const deriveBondedActorPda: (actor: PublicKey$1) => PublicKey$1;
+declare const derivePriceHistoryPda: () => PublicKey$1;
 /**
  * Ephemeral stake account address used per-deposit.
  * On-chain convention: seed = `ephemeral_<u32>` under StakeProgram.programId.
@@ -692,7 +780,7 @@ declare const solToLamports: (sol: number) => bigint;
  * IDL can be found at `target/idl/liqsol_core.json`.
  */
 type LiqsolCore = {
-    "address": "HR3t8mA25TdJpwLph2h2L7KhK7ynWoAByYYzgUAfd5rk";
+    "address": "BBkVcNWNQz1vZ6esv5US4QnNFWPRqxWbdpJHur9GVXSu";
     "metadata": {
         "name": "liqsolCore";
         "version": "0.1.0";
@@ -3844,58 +3932,8 @@ type LiqsolCore = {
     "errors": [
         {
             "code": 6000;
-            "name": "noRewardsToClaim";
-            "msg": "No rewards to claim";
-        },
-        {
-            "code": 6001;
-            "name": "insufficientBalance";
-            "msg": "Insufficient balance";
-        },
-        {
-            "code": 6002;
-            "name": "insufficientFunds";
-            "msg": "Insufficient funds";
-        },
-        {
-            "code": 6003;
-            "name": "unauthorized";
-            "msg": "Unauthorized - caller is not the distribution authority";
-        },
-        {
-            "code": 6004;
-            "name": "invalidMint";
-            "msg": "Invalid mint";
-        },
-        {
-            "code": 6005;
-            "name": "invalidOwner";
-            "msg": "Invalid owner";
-        },
-        {
-            "code": 6006;
-            "name": "invalidUserRecord";
-            "msg": "Invalid user record";
-        },
-        {
-            "code": 6007;
-            "name": "invalidWithdrawal";
-            "msg": "Invalid withdrawal - balance increased instead of decreased";
-        },
-        {
-            "code": 6008;
-            "name": "invalidProgramId";
-            "msg": "Invalid program ID";
-        },
-        {
-            "code": 6009;
-            "name": "instructionIntrospectionFailed";
-            "msg": "Instruction introspection failed";
-        },
-        {
-            "code": 6010;
-            "name": "receiptFulfilled";
-            "msg": "Receipt already fulfilled";
+            "name": "accountBorrowFailed";
+            "msg": "Util Acc borrow Failed";
         }
     ];
     "types": [
@@ -5494,5 +5532,58 @@ declare class OutpostClient {
     private getTokenBalanceSafe;
 }
 
-export { ADDRESSES, CHAINLINK_FEED, CHAINLINK_PROGRAM, CONTRACTS, DEFAULT_AVERAGE_PAY_RATE, DEFAULT_PAY_RATE_LOOKBACK, DepositClient, DistributionClient, EPHEMERAL_RENT_EXEMPTION, ERC1155Abi, ERC20Abi, ERC721Abi, types$1 as ETH, EthereumContractService, EthereumStakingClient, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, types as SOL, SolanaStakingClient, Staker, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, calculateExpectedFee, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveLeaderboardStatePda, deriveLiqsolMintAuthorityPda, deriveLiqsolMintPda, deriveOutpostGlobalStatePda, deriveOutpostPoolAuthorityPda, derivePayRateHistoryPda, derivePayoutStatePda, derivePoolUserRecordPda, deriveReservePoolPda, deriveSolBucketPda, deriveStakeControllerStatePda, deriveStakeControllerVaultPda, deriveTrancheStatePda, deriveUserRecordPda, deriveUserUserRecordPda, deriveUserWarrantRecordPda, deriveValidatorRecordPda, deriveVaultPda, deriveWireReceiptPda, generateRandomDepositAmount, generateTestKeypair, getAveragePayRate, getBucketLiqSolBalance, getEpochSnapshot, getErrorMessage, getLiqsolCoreProgram, getPayoutStateRaw, getReservePoolBalance, getStakeControllerStateRaw, getUserLiqSolBalance, getUserRecordRaw, lamportsToSol, msToEpochEnd, previewDepositEffects, scheduledInstruction, sleep, solToLamports, waitForConfirmation, waitUntilSafeToExecuteFunction };
-export type { BalanceView, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OutpostAccounts, Portfolio, ScheduleConfig, StakerConfig, TxResult };
+/**
+ * Client for interacting with the Pretoken (Outpost) program on Solana.
+ *
+ * Provides account fetching and instruction building for pretoken operations.
+ * Does NOT send or confirm transactions; keeps SDK composable.
+ *
+ * TODO: Update to $WIRE Token implementation Post-Launch
+ */
+declare class TokenClient {
+    private readonly provider;
+    private readonly program;
+    get wallet(): WalletLike;
+    constructor(provider: AnchorProvider);
+    /**
+     * Single source of truth for outpost/pretoken accounts.
+     * Uses your existing PDA + ATA derivations in buildOutpostAccounts().
+     */
+    getAccounts(user: PublicKey$1): Promise<OutpostAccounts>;
+    /**
+     * Lightweight, UI-friendly snapshot fetchers.
+     * (No decoding assumptions beyond what Anchor already provides.)
+     */
+    fetchGlobalState(): Promise<GlobalState>;
+    fetchTrancheState(): Promise<TrancheState>;
+    fetchWireReceipt(user: PublicKey$1): Promise<WireReceipt>;
+    fetchUserWarrantRecord(user: PublicKey$1): Promise<UserWarrantRecord>;
+    /**
+     * purchase_with_sol(amount u64)
+     *
+     * amountLamports is bigint to match your SDK convention.
+     */
+    buildPurchaseWithSolIx(amountLamports: bigint, user?: PublicKey$1): Promise<TransactionInstruction>;
+    /**
+     * purchase_with_liqsol(amount u64)
+     *
+     * amount is liqSOL *raw base units* (Token-2022 amount).
+     */
+    buildPurchaseWithLiqsolIx(amountLamports: bigint, user?: PublicKey$1): Promise<TransactionInstruction>;
+    /**
+     * purchase_warrants_from_yield()
+     *
+     * No amount arg; it consumes tracked yield according to on-chain rules.
+     */
+    buildPurchaseFromYieldIx(user?: PublicKey$1): Promise<TransactionInstruction>;
+    /**
+     * Fetch the SOL price in 1e8 USD units from liqsol_core.priceHistory.
+     *
+     * This uses the same ring-buffer semantics as the on-chain program:
+     * the latest price is the entry just before `nextIndex`.
+     */
+    getSolPriceUsd(): Promise<BN>;
+}
+
+export { ADDRESSES, CHAINLINK_FEED, CHAINLINK_PROGRAM, CONTRACTS, DEFAULT_AVERAGE_PAY_RATE, DEFAULT_PAY_RATE_LOOKBACK, DepositClient, DistributionClient, EPHEMERAL_RENT_EXEMPTION, ERC1155Abi, ERC20Abi, ERC721Abi, types$1 as ETH, EthereumContractService, EthereumStakingClient, LAMPORTS_PER_SOL, LIQSOL_CORE, LIQSOL_TOKEN, LeaderboardClient, OutpostClient, PAY_RATE_SCALE_FACTOR, PDA_SEEDS, PROGRAM_IDS, PurchaseAsset, types as SOL, SolanaStakingClient, Staker, TokenClient, VALIDATOR_LEADERBOARD, airdropSol, buildOutpostAccounts, calculateExpectedFee, deriveBarConfigPda, deriveBondLevelPda, deriveBondedActorPda, deriveBucketAuthorityPda, deriveDepositAuthorityPda, deriveDistributionStatePda, deriveEphemeralStakeAddress, deriveLeaderboardStatePda, deriveLiqsolMintAuthorityPda, deriveLiqsolMintPda, deriveOutpostGlobalStatePda, deriveOutpostPoolAuthorityPda, derivePayRateHistoryPda, derivePayoutStatePda, derivePoolUserRecordPda, derivePriceHistoryPda, deriveReservePoolPda, deriveSolBucketPda, deriveStakeControllerStatePda, deriveStakeControllerVaultPda, deriveTrancheStatePda, deriveUserRecordPda, deriveUserUserRecordPda, deriveUserWarrantRecordPda, deriveValidatorRecordPda, deriveVaultPda, deriveWireReceiptPda, generateRandomDepositAmount, generateTestKeypair, getAveragePayRate, getBucketLiqSolBalance, getEpochSnapshot, getErrorMessage, getLiqsolCoreProgram, getPayoutStateRaw, getReservePoolBalance, getStakeControllerStateRaw, getUserLiqSolBalance, getUserRecordRaw, lamportsToSol, msToEpochEnd, previewDepositEffects, scheduledInstruction, sleep, solToLamports, waitForConfirmation, waitUntilSafeToExecuteFunction };
+export type { BalanceView, ContractConfig, ContractOptions, Contracts, EpochSnapshot, IStakingClient, OutpostAccounts, Portfolio, PurchaseQuote, ScheduleConfig, StakerConfig, TrancheSnapshot, TxResult };