@wireio/stake 0.2.5 → 0.3.0

package/src/networks/solana/solana.ts

@@ -27,8 +27,6 @@ import {
 import {
     IStakingClient,
     Portfolio,
-    PurchaseAsset,
-    PurchaseQuote,
     StakerConfig,
     TrancheSnapshot,
 } from '../../types';
@@ -62,7 +60,7 @@ const commitment: Commitment = 'confirmed';
  * This class composes lower-level clients; it does not know about UI.
  */
 export class SolanaStakingClient implements IStakingClient {
-    public pubKey: PublicKey;
+    public pubKey?: PublicKey;
     public connection: Connection;
     public anchor: AnchorProvider;
 
@@ -73,6 +71,7 @@ export class SolanaStakingClient implements IStakingClient {
     private tokenClient: TokenClient;
 
     get solPubKey(): SolPubKey {
+        if (!this.pubKey) throw new Error('pubKey is undefined');
         return new SolPubKey(this.pubKey.data.array);
     }
 
@@ -82,13 +81,17 @@ export class SolanaStakingClient implements IStakingClient {
 
     constructor(private config: StakerConfig) {
         const adapter = config.provider as BaseSignerWalletAdapter;
-        if (!adapter?.publicKey) throw new Error('Solana wallet adapter not connected');
+        // if (!adapter?.publicKey) throw new Error('Solana wallet adapter not connected');
         if (!config.network.rpcUrls.length) throw new Error('No RPC URLs provided');
-
-        const publicKey = adapter.publicKey;
-        const wirePub = new PublicKey(KeyType.ED, publicKey.toBytes());
-        if (!wirePub.equals(config.pubKey)) {
-            throw new Error("Passed-in pubKey doesn't match adapter.publicKey");
+        
+        const publicKey = adapter.publicKey || new SolPubKey(new Uint8Array(32))
+        if (config.pubKey){
+            // If pubKey provided, ensure it matches the adapter's pubkey
+            const wirePub = new PublicKey(KeyType.ED, publicKey.toBytes());
+            if (!wirePub.equals(config.pubKey)) 
+                throw new Error("Passed-in pubKey doesn't match adapter.publicKey");
+            // All good; assign it
+            this.pubKey = wirePub;
         }
 
         const opts: ConnectionConfig = { commitment };
@@ -111,7 +114,6 @@ export class SolanaStakingClient implements IStakingClient {
             },
         };
 
-        this.pubKey = wirePub;
         this.connection = new Connection(config.network.rpcUrls[0], opts);
         this.anchor = new AnchorProvider(this.connection, anchorWallet, { commitment });
 
@@ -120,7 +122,6 @@ export class SolanaStakingClient implements IStakingClient {
         this.leaderboardClient = new LeaderboardClient(this.anchor);
         this.outpostClient = new OutpostClient(this.anchor);
         this.tokenClient = new TokenClient(this.anchor);
-        this.tokenClient = new TokenClient(this.anchor);
     }
 
     // ---------------------------------------------------------------------
@@ -132,6 +133,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Handles tx build, sign, send, and confirmation.
      */
     async deposit(amountLamports: bigint): Promise<string> {
+        this.ensureWriteAccess();
         if (amountLamports <= BigInt(0)) {
             throw new Error('Deposit amount must be greater than zero.');
         }
@@ -152,6 +154,7 @@ export class SolanaStakingClient implements IStakingClient {
      * NOTE: placeholder until a withdraw flow is implemented in DepositClient.
      */
     async withdraw(_amountLamports: bigint): Promise<string> {
+        this.ensureWriteAccess();
         throw new Error('Withdraw method not yet implemented.');
     }
 
@@ -160,6 +163,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Ensures user ATA exists, then stakes via outpostClient.
      */
     async stake(amountLamports: bigint): Promise<string> {
+        this.ensureWriteAccess();
         if (amountLamports <= BigInt(0)) {
             throw new Error('Stake amount must be greater than zero.');
         }
@@ -180,6 +184,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Mirrors stake() but calls withdrawStake.
      */
     async unstake(amountLamports: bigint): Promise<string> {
+        this.ensureWriteAccess();
         if (amountLamports <= BigInt(0)) {
             throw new Error('Unstake amount must be greater than zero.');
         }
@@ -204,56 +209,17 @@ export class SolanaStakingClient implements IStakingClient {
      *
      * ETH / LIQETH are not valid on Solana.
      */
-    async buy(amountLamports: bigint, purchaseAsset: PurchaseAsset): Promise<string> {
+    async buy(amountLamports: bigint): Promise<string> {
+        this.ensureWriteAccess();
+        if (!amountLamports || amountLamports <= BigInt(0)) 
+            throw new Error('liqSOL pretoken purchase requires a positive amount.');
+        
         const user = this.solPubKey;
-        let ix: TransactionInstruction;
-        let preIxs: TransactionInstruction[] = [];
-
-        switch (purchaseAsset) {
-            case PurchaseAsset.SOL: {
-                if (!amountLamports || amountLamports <= BigInt(0)) {
-                    throw new Error('SOL pretoken purchase requires a positive amount.');
-                }
-                ix = await this.tokenClient.buildPurchaseWithSolIx(
-                    amountLamports,
-                    user,
-                );
-                break;
-            }
-
-            case PurchaseAsset.LIQSOL: {
-                if (!amountLamports || amountLamports <= BigInt(0)) {
-                    throw new Error(
-                        'liqSOL pretoken purchase requires a positive amount.',
-                    );
-                }
-                preIxs = await this.outpostClient.maybeBuildCreateUserAtaIx(user);
-                ix = await this.tokenClient.buildPurchaseWithLiqsolIx(
-                    amountLamports,
-                    user,
-                );
-                break;
-            }
-
-            case PurchaseAsset.YIELD: {
-                // Amount is ignored by the on-chain program; it consumes tracked yield.
-                ix = await this.tokenClient.buildPurchaseFromYieldIx(user);
-                break;
-            }
-
-            case PurchaseAsset.ETH:
-            case PurchaseAsset.LIQETH: {
-                throw new Error(
-                    'ETH / LIQETH pretoken purchases are not supported on Solana.',
-                );
-            }
-
-            default:
-                throw new Error(`Unsupported pretoken purchase asset: ${String(
-                    purchaseAsset,
-                )}`);
-        }
-
+        const preIxs = await this.outpostClient.maybeBuildCreateUserAtaIx(user);
+        const ix = await this.tokenClient.buildPurchaseWithLiqsolIx(
+            amountLamports,
+            user,
+        );
         const tx = new Transaction().add(...preIxs, ix);
         const prepared = await this.prepareTx(tx);
         const signed = await this.signTransaction(prepared.tx);
@@ -270,6 +236,8 @@ export class SolanaStakingClient implements IStakingClient {
      *  - extras: useful internal addresses and raw state for debugging/UX
      */
     async getPortfolio(): Promise<Portfolio> {
+        if (!this.pubKey) throw new Error('User pubKey is undefined');
+
         const user = this.solPubKey;
 
         const reservePoolPDA = deriveReservePoolPda();
@@ -313,7 +281,7 @@ export class SolanaStakingClient implements IStakingClient {
             wireReceipt?.stakedLiqsol?.toString() ?? '0';
 
         const wireSharesStr =
-            userWarrantRecord?.totalWarrantsPurchased?.toString() ?? '0';
+            userWarrantRecord?.totalPretokensPurchased?.toString() ?? '0';
 
         return {
             native: {
@@ -369,6 +337,8 @@ export class SolanaStakingClient implements IStakingClient {
      * windowBefore/windowAfter control how many ladder rows we precompute
      * around the current tranche for UI, but you can pass nothing if you
      * only need current tranche info.
+     * 
+     * READ-ONLY allowed
      */
     async getTrancheSnapshot(options?: {
         chainID?: ChainID;
@@ -402,95 +372,12 @@ export class SolanaStakingClient implements IStakingClient {
         });
     }
 
-    /**
-     * Approximate prelaunch WIRE quote for a given amount & asset.
-     *
-     * Uses TrancheSnapshot + SOL/USD price for:
-     *  - SOL: amount is lamports
-     *  - LIQSOL: amount is liqSOL base units (decimals = 9)
-     *  - YIELD: amount is treated as SOL lamports-equivalent of yield
-     *
-     * NOTE: On-chain rounding may differ slightly (this is UI-only).
-     */
-    async getBuyQuote(
-        amount: bigint,
-        asset: PurchaseAsset,
-        opts?: { chainID?: ChainID },
-    ): Promise<PurchaseQuote> {
-        // For non-YIELD purchases we require a positive amount.
-        if (asset !== PurchaseAsset.YIELD && amount <= BigInt(0)) {
-            throw new Error('amount must be > 0 for non-YIELD purchases');
-        }
-
-        const snapshot = await this.getTrancheSnapshot({
-            chainID: opts?.chainID,
-        });
-
-        const wirePriceUsd = snapshot.currentPriceUsd; // 1e8
-        const solPriceUsd = snapshot.nativePriceUsd;   // 1e8
-
-        if (!wirePriceUsd || wirePriceUsd <= BigInt(0)) {
-            throw new Error('Invalid WIRE price in tranche snapshot');
-        }
-        if (!solPriceUsd || solPriceUsd <= BigInt(0)) {
-            throw new Error('No SOL/USD price available');
-        }
-
-        const ONE_E9 = BigInt(LAMPORTS_PER_SOL);    // 1e9
-        const ONE_E8 = BigInt(100_000_000);         // 1e8
-
-        let notionalUsd: bigint;
-
-        switch (asset) {
-            case PurchaseAsset.SOL: {
-                // lamports * solPriceUsd / 1e9  → 1e8 USD
-                notionalUsd = (amount * solPriceUsd) / ONE_E9;
-                break;
-            }
-
-            case PurchaseAsset.LIQSOL: {
-                // liqSOL also uses 9 decimals; use same conversion.
-                notionalUsd = (amount * solPriceUsd) / ONE_E9;
-                break;
-            }
-
-            case PurchaseAsset.YIELD: {
-                // Treat amount as lamports-equivalent of SOL yield (UI convention).
-                notionalUsd = (amount * solPriceUsd) / ONE_E9;
-                break;
-            }
-
-            case PurchaseAsset.ETH:
-            case PurchaseAsset.LIQETH:
-                throw new Error('getBuyQuote for ETH/LIQETH is not supported on Solana');
-
-            default:
-                throw new Error(`Unsupported purchase asset: ${String(asset)}`);
-        }
-
-        // WIRE shares (1e8) = (notionalUsd * 1e8) / wirePriceUsd
-        // Add a small bias to avoid truncating to 0 on tiny buys.
-        const numerator = notionalUsd * ONE_E8;
-        const wireShares =
-            numerator === BigInt(0)
-                ? BigInt(0)
-                : (numerator + wirePriceUsd - BigInt(1)) / wirePriceUsd;
-
-        return {
-            purchaseAsset: asset,
-            amountIn: amount,
-            wireShares,
-            wireDecimals: 8,
-            wirePriceUsd,
-            notionalUsd,
-        };
-    }
-
     /**
      * Convenience helper to fetch the distribution userRecord for the current user.
      * Used by balance-correction flows and debugging.
      */
     async getUserRecord() {
+        if (!this.pubKey) throw new Error('User pubKey is undefined');
         return this.distributionClient.getUserRecord(this.solPubKey);
     }
 
@@ -500,6 +387,7 @@ export class SolanaStakingClient implements IStakingClient {
      *  - signs and sends the transaction if it can succeed
      */
     async correctBalance(amount?: bigint): Promise<string> {
+        this.ensureWriteAccess();
         const build = await this.distributionClient.buildCorrectRegisterTx({ amount });
         if (!build.canSucceed || !build.transaction) {
             throw new Error(build.reason ?? 'Unable to build Correct&Register transaction');
@@ -528,7 +416,8 @@ export class SolanaStakingClient implements IStakingClient {
         signed: SolanaTransaction,
         ctx: { blockhash: string; lastValidBlockHeight: number },
     ): Promise<string> {
-        const signature = await this.connection.sendRawTransaction(
+        this.ensureWriteAccess();
+            const signature = await this.connection.sendRawTransaction(
             signed.serialize(),
             {
                 skipPreflight: false,
@@ -557,6 +446,7 @@ export class SolanaStakingClient implements IStakingClient {
      * Sign a single Solana transaction using the connected wallet adapter.
      */
     async signTransaction(tx: SolanaTransaction): Promise<SolanaTransaction> {
+        this.ensureWriteAccess();
         return this.anchor.wallet.signTransaction(tx);
     }
 
@@ -565,6 +455,7 @@ export class SolanaStakingClient implements IStakingClient {
      * prepared and signed the transaction.
      */
     async sendTransaction(signed: SolanaTransaction): Promise<TransactionSignature> {
+        this.ensureWriteAccess();
         return this.anchor.sendAndConfirm(signed);
     }
 
@@ -581,4 +472,11 @@ export class SolanaStakingClient implements IStakingClient {
         tx.feePayer = this.solPubKey;
         return { tx, blockhash, lastValidBlockHeight };
     }
+
+    ensureWriteAccess() {
+        if (!this.pubKey || !this.anchor.wallet.publicKey)
+            throw new Error('User Authorization required: pubKey is undefined');
+        if (this.solPubKey.toBase58() !== this.anchor.wallet.publicKey.toBase58())
+            throw new Error('Write access requires connected wallet to match pubKey');
+    }
 }

package/src/networks/solana/types.ts

@@ -99,7 +99,7 @@ export type GlobalState = {
 export type UserWarrantRecord = {
     user: PublicKey;
     totalSolDeposited: BN;
-    totalWarrantsPurchased: BN;
+    totalPretokensPurchased: BN;
     lastTrancheNumber: BN;
     lastTranchePriceUsd: BN;
     bump: number;
@@ -110,7 +110,11 @@ export type TrancheState = {
     currentTrancheNumber: BN;
     currentTrancheSupply: BN;
     currentTranchePriceUsd: BN;
-    totalWarrantsSold: BN;
+    //Currently working on renaming Warrants to Pretokens, 
+    // current version of sol contracts appears to still 
+    // be using warrants phrasing for this variable
+    totalPretokensSold?: BN;
+    totalWarrantsSold?: BN;
     initialTrancheSupply: BN;
     supplyGrowthBps: number;
     priceGrowthBps: number;

package/src/networks/solana/utils.ts

@@ -116,7 +116,7 @@ export function buildSolanaTrancheLadder(options: {
     currentTranche: number;
     initialTrancheSupply: bigint;
     currentTrancheSupply: bigint;
-    totalWarrantsSold: bigint; // informational only
+    totalPretokensSold: bigint; // informational only
     currentPriceUsd: bigint;
     supplyGrowthBps: number;
     priceGrowthBps: number;
@@ -213,7 +213,7 @@ export function buildSolanaTrancheSnapshot(options: {
     const currentTranche = trancheState.currentTrancheNumber.toNumber();
     const currentTrancheSupply = toBigint(trancheState.currentTrancheSupply);
     const initialTrancheSupply = toBigint(trancheState.initialTrancheSupply);
-    const totalWarrantsSold = toBigint(trancheState.totalWarrantsSold);
+    const totalPretokensSold = toBigint(trancheState.totalPretokensSold);
     const currentPriceUsd = toBigint(trancheState.currentTranchePriceUsd);
 
     const supplyGrowthBps = trancheState.supplyGrowthBps;
@@ -230,7 +230,7 @@ export function buildSolanaTrancheSnapshot(options: {
         currentTranche,
         initialTrancheSupply,
         currentTrancheSupply,
-        totalWarrantsSold,
+        totalPretokensSold,
         currentPriceUsd,
         supplyGrowthBps,
         priceGrowthBps,
@@ -244,13 +244,11 @@ export function buildSolanaTrancheSnapshot(options: {
         totalShares,
         currentTranche,
         currentPriceUsd,
-        minPriceUsd,
-        maxPriceUsd,
         supplyGrowthBps,
         priceGrowthBps,
         currentTrancheSupply,
         initialTrancheSupply,
-        totalWarrantsSold,
+        totalPretokensSold,
         nativePriceUsd: solPriceUsd,
         nativePriceTimestamp,
         ladder,

package/src/types.ts

@@ -6,11 +6,11 @@ import { ethers } from 'ethers';
 export type StakerConfig = {
     network: ExternalNetwork;
     provider: BaseSignerWalletAdapter | ethers.providers.Web3Provider;
-    pubKey: PublicKey;
+    pubKey?: PublicKey;
 }
 
 export interface IStakingClient {
-    pubKey: PublicKey;
+    pubKey?: PublicKey;
     network: ExternalNetwork;
 
     /** Amount is in the chain's smallest unit (lamports/wei, etc.) */
@@ -18,7 +18,7 @@ export interface IStakingClient {
     withdraw(amount: bigint): Promise<string>;
     stake(amount: bigint): Promise<string>;
     unstake(amount: bigint): Promise<string>;
-    buy(amount: bigint, asset: PurchaseAsset): Promise<string>;
+    buy(amount: bigint): Promise<string>;
 
     /** Fetch the complete user portfolio */
     getPortfolio(): Promise<Portfolio>;
@@ -35,9 +35,6 @@ export interface IStakingClient {
         windowBefore?: number;
         windowAfter?: number;
     }): Promise<TrancheSnapshot | null>;
-
-    /**  */
-    getBuyQuote(amount: bigint, asset: PurchaseAsset): Promise<PurchaseQuote>;
 }
 
 export interface Portfolio {
@@ -47,7 +44,7 @@ export interface Portfolio {
     liq: BalanceView;
     /** Outpost Staked balance */
     staked: BalanceView
-    /** Prelaunch WIRE “shares” (warrants/pretokens) */
+    /** Prelaunch WIRE “shares” (pretokens) */
     wire: BalanceView;
     /** SOL ONLY!
      * Tracked liqSOL balance from distribution program */
@@ -107,18 +104,16 @@ export interface TrancheSnapshot {
 
     /** Current tranche price in USD (1e8 scale) */
     currentPriceUsd: bigint;
-    /** Optional min/max bounds for price validation (1e8 scale) */
-    minPriceUsd?: bigint;
-    maxPriceUsd?: bigint;
 
     /** Tranche curve config (per-chain) */
+    // TODO make a constant?
     supplyGrowthBps: number; // e.g. 100 = +1% per tranche
     priceGrowthBps: number;  // e.g. 200 = +2% per tranche
 
     /** Current tranche supply state (1e8 scale) */
     currentTrancheSupply: bigint;   // remaining in current tranche
     initialTrancheSupply: bigint;   // capacity for current tranche
-    totalWarrantsSold: bigint;      // global cumulative sold (all tranches), 1e8
+    totalPretokensSold: bigint;      // global cumulative sold (all tranches), 1e8
 
     /** Native token → USD price if available (SOL/USD, ETH/USD, etc, 1e8 scale) */
     nativePriceUsd?: bigint;
@@ -130,27 +125,4 @@ export interface TrancheSnapshot {
      * Used directly by the frontend for ladder graphs.
      */
     ladder: TrancheLadderItem[];
-}
-
-
-// Enum describing which asset is being used to buy pretoken
-export enum PurchaseAsset {
-    SOL = 'SOL',
-    LIQSOL = 'LIQSOL',
-    ETH = 'ETH',
-    LIQETH = 'LIQETH',
-    YIELD = 'YIELD',
-}
-
-export interface PurchaseQuote {
-    purchaseAsset: PurchaseAsset;
-    amountIn: bigint;       // lamports / wei / token units
-
-    /** Expected pretoken “shares” (pretokens) and decimals */
-    wireShares: bigint;     // 1e8 scale
-    wireDecimals: number;   // always 8 for now
-
-    /** Current price + notional in USD (1e8 scale) */
-    wirePriceUsd: bigint;
-    notionalUsd: bigint;
 }

package/src/assets/ethereum/ABI/liqEth/RewardsERC20.sol/RewardsERC20.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/f26a3bdbd4033af8421132fc6adca199.json"
-}

package/src/assets/ethereum/ABI/liqEth/RewardsERC20Pausable.sol/RewardsERC20Pausable.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/f26a3bdbd4033af8421132fc6adca199.json"
-}

package/src/assets/ethereum/ABI/liqEth/Yield.sol/BeaconRoots.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/f26a3bdbd4033af8421132fc6adca199.json"
-}

package/src/assets/ethereum/ABI/liqEth/Yield.sol/BeaconRoots.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "BeaconRoots",
-  "sourceName": "contracts/liqEth/Yield.sol",
-  "abi": [],
-  "bytecode": "0x60808060405234601757603a9081601d823930815050f35b600080fdfe600080fdfea264697066735822122031a0f5398756e42b92bee3bd69db499a6ba974a3821f736e80fb78b4b59bd4ad64736f6c63430008190033",
-  "deployedBytecode": "0x600080fdfea264697066735822122031a0f5398756e42b92bee3bd69db499a6ba974a3821f736e80fb78b4b59bd4ad64736f6c63430008190033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/liqEth/Yield.sol/SSZ.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/f26a3bdbd4033af8421132fc6adca199.json"
-}

package/src/assets/ethereum/ABI/liqEth/Yield.sol/SSZ.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "SSZ",
-  "sourceName": "contracts/liqEth/Yield.sol",
-  "abi": [],
-  "bytecode": "0x60808060405234601757603a9081601d823930815050f35b600080fdfe600080fdfea2646970667358221220cb02051f443c7190a2fcd835a3bfa144af2732be9952e46973e867f22c854c8664736f6c63430008190033",
-  "deployedBytecode": "0x600080fdfea2646970667358221220cb02051f443c7190a2fcd835a3bfa144af2732be9952e46973e867f22c854c8664736f6c63430008190033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/src/assets/ethereum/ABI/outpost/Warrant.sol/Warrant.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/ed9aaec874c02fdb46b7a115ba311ca3.json"
-}