@wireio/stake 0.3.0 → 0.4.0

package/src/assets/solana/types/liqsol_token.ts

@@ -5,7 +5,7 @@
  * IDL can be found at `target/idl/liqsol_token.json`.
  */
 export type LiqsolToken = {
-  "address": "6cDoerqdV6UQDsGvUEq5Qj5HRxxyDxSuUaB2J6iK8cio",
+  "address": "6hiJ8PrSyYLr7H9MA9VYh9fvGoHxZ2TXdDAMzjeUVSXZ",
   "metadata": {
     "name": "liqsolToken",
     "version": "0.1.0",

package/src/assets/solana/types/transfer_hook.ts

@@ -0,0 +1,198 @@
+/**
+ * Program IDL in camelCase format in order to be used in JS/TS.
+ *
+ * Note that this is only a type helper and is not the actual IDL. The original
+ * IDL can be found at `target/idl/transfer_hook.json`.
+ */
+export type TransferHook = {
+  "address": "EtqCLddkPNGjkgiH9rVUmK3M5X2FKFprQvgscBJ8g6hX",
+  "metadata": {
+    "name": "transferHook",
+    "version": "0.1.0",
+    "spec": "0.1.0",
+    "description": "Created with Anchor"
+  },
+  "instructions": [
+    {
+      "name": "initializeExtraAccountMetaList",
+      "discriminator": [
+        43,
+        34,
+        13,
+        49,
+        167,
+        88,
+        235,
+        235
+      ],
+      "accounts": [
+        {
+          "name": "payer",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "extraAccountMetaList",
+          "writable": true
+        },
+        {
+          "name": "mint"
+        },
+        {
+          "name": "systemProgram"
+        },
+        {
+          "name": "liqsolCore"
+        }
+      ],
+      "args": []
+    },
+    {
+      "name": "transferHook",
+      "discriminator": [
+        105,
+        37,
+        101,
+        197,
+        75,
+        251,
+        102,
+        26
+      ],
+      "accounts": [
+        {
+          "name": "sourceToken"
+        },
+        {
+          "name": "mint"
+        },
+        {
+          "name": "destinationToken"
+        },
+        {
+          "name": "authority"
+        },
+        {
+          "name": "extraAccountMetaList"
+        },
+        {
+          "name": "liqsolCore"
+        },
+        {
+          "name": "senderUserRecord",
+          "writable": true
+        },
+        {
+          "name": "receiverUserRecord",
+          "writable": true
+        },
+        {
+          "name": "distributionState",
+          "writable": true
+        },
+        {
+          "name": "bucketTokenAccount"
+        }
+      ],
+      "args": [
+        {
+          "name": "amount",
+          "type": "u64"
+        }
+      ]
+    }
+  ],
+  "accounts": [
+    {
+      "name": "distributionState",
+      "discriminator": [
+        7,
+        25,
+        94,
+        15,
+        208,
+        170,
+        4,
+        103
+      ]
+    }
+  ],
+  "errors": [
+    {
+      "code": 6000,
+      "name": "amountTooBig"
+    },
+    {
+      "code": 6001,
+      "name": "isNotCurrentlyTransferring"
+    },
+    {
+      "code": 6002,
+      "name": "tlvAccountResolutionError"
+    }
+  ],
+  "types": [
+    {
+      "name": "distributionState",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "liqsolMint",
+            "type": "pubkey"
+          },
+          {
+            "name": "currentIndex",
+            "type": "u64"
+          },
+          {
+            "name": "totalShares",
+            "docs": [
+              "Sum of all user shares across the system"
+            ],
+            "type": "u64"
+          },
+          {
+            "name": "lastBucketBalance",
+            "docs": [
+              "Last observed bucket balance used for incremental index updates"
+            ],
+            "type": "u64"
+          },
+          {
+            "name": "bump",
+            "type": "u8"
+          },
+          {
+            "name": "bucketBump",
+            "docs": [
+              "Cached bucket authority bump to avoid repeated find_program_address calls"
+            ],
+            "type": "u8"
+          },
+          {
+            "name": "poolBump",
+            "docs": [
+              "Cached pool authority bump to avoid repeated find_program_address calls"
+            ],
+            "type": "u8"
+          },
+          {
+            "name": "bucketAuthority",
+            "docs": [
+              "Cached bucket authority pubkey for transfer-hook optimization"
+            ],
+            "type": "pubkey"
+          },
+          {
+            "name": "poolAuthority",
+            "docs": [
+              "Cached pool authority pubkey for transfer-hook optimization"
+            ],
+            "type": "pubkey"
+          }
+        ]
+      }
+    }
+  ]
+};

package/src/assets/solana/types/validator_leaderboard.ts

@@ -5,7 +5,7 @@
  * IDL can be found at `target/idl/validator_leaderboard.json`.
  */
 export type ValidatorLeaderboard = {
-  "address": "C4ddPrB1ALYpW4G1Qz4ffvETBA8YGUL7TVZaLiE6bb1q",
+  "address": "H6CWj2PgxCE9Z5dPi9nMrR2VxT1C4DQcqR1QjmLeon47",
   "metadata": {
     "name": "validatorLeaderboard",
     "version": "0.1.0",
@@ -69,6 +69,149 @@ export type ValidatorLeaderboard = {
       ],
       "args": []
     },
+    {
+      "name": "testClearLeaderboard",
+      "discriminator": [
+        118,
+        207,
+        26,
+        205,
+        180,
+        7,
+        75,
+        244
+      ],
+      "accounts": [
+        {
+          "name": "leaderboardState",
+          "writable": true
+        },
+        {
+          "name": "authority",
+          "signer": true
+        }
+      ],
+      "args": []
+    },
+    {
+      "name": "testForceRegisterValidator",
+      "discriminator": [
+        136,
+        156,
+        132,
+        32,
+        96,
+        240,
+        7,
+        115
+      ],
+      "accounts": [
+        {
+          "name": "registrant",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "voteAccount"
+        },
+        {
+          "name": "validatorRecord",
+          "writable": true
+        },
+        {
+          "name": "leaderboardState",
+          "writable": true
+        },
+        {
+          "name": "systemProgram"
+        }
+      ],
+      "args": [
+        {
+          "name": "vpp",
+          "type": "u8"
+        }
+      ]
+    },
+    {
+      "name": "testForceUpdateVpp",
+      "discriminator": [
+        67,
+        51,
+        28,
+        174,
+        200,
+        214,
+        203,
+        162
+      ],
+      "accounts": [
+        {
+          "name": "registrant",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "voteAccount"
+        },
+        {
+          "name": "validatorRecord",
+          "writable": true
+        },
+        {
+          "name": "leaderboardState",
+          "writable": true
+        }
+      ],
+      "args": [
+        {
+          "name": "vpp",
+          "type": "u8"
+        }
+      ]
+    },
+    {
+      "name": "testSeedRandomValidators",
+      "discriminator": [
+        48,
+        155,
+        181,
+        112,
+        163,
+        242,
+        43,
+        146
+      ],
+      "accounts": [
+        {
+          "name": "registrant",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "leaderboardState",
+          "writable": true
+        }
+      ],
+      "args": [
+        {
+          "name": "count",
+          "type": "u16"
+        },
+        {
+          "name": "seed",
+          "type": "u64"
+        },
+        {
+          "name": "minVpp",
+          "type": "u8"
+        },
+        {
+          "name": "maxVpp",
+          "type": "u8"
+        }
+      ]
+    },
     {
       "name": "updateCommission",
       "discriminator": [
@@ -163,7 +306,7 @@ export type ValidatorLeaderboard = {
       "args": [
         {
           "name": "vpp",
-          "type": "u64"
+          "type": "u8"
         },
         {
           "name": "proposedRank",
@@ -360,12 +503,12 @@ export type ValidatorLeaderboard = {
           {
             "name": "scores",
             "docs": [
-              "VPP scores indexed by registry_index",
+              "VPP scores indexed by registry_index (0-100 range)",
               "registry_index is assigned on first validator registration and never changes"
             ],
             "type": {
               "array": [
-                "u64",
+                "u8",
                 1024
               ]
             }

package/src/networks/ethereum/ethereum.ts

@@ -242,11 +242,6 @@ export class EthereumStakingClient implements IStakingClient {
                 decimals: nativeDecimals,
                 symbol: liqSymbol,
             },
-            tracked: {
-                amount: liqBalance.toBigInt(),
-                decimals: nativeDecimals,
-                symbol: liqSymbol,
-            },
             staked: {
                 amount: stakedLiqBalance.toBigInt(),
                 decimals: nativeDecimals,

package/src/networks/solana/clients/deposit.client.ts

@@ -1,6 +1,5 @@
 import { AnchorProvider, BN, Program } from '@coral-xyz/anchor';
 import {
-    PublicKey,
     SystemProgram,
     Transaction,
     TransactionInstruction,
@@ -27,26 +26,54 @@ import {
     deriveReservePoolPda,
     deriveVaultPda,
     deriveStakeControllerStatePda,
+    derivePayoutStatePda,
     deriveBucketAuthorityPda,
     derivePayRateHistoryPda,
     deriveDistributionStatePda,
     deriveUserRecordPda,
-    derivePayoutStatePda,
     deriveEphemeralStakeAddress,
+    deriveWithdrawGlobalPda,
+    deriveStakeAllocationStatePda,
+    deriveStakeMetricsPda,
+    deriveMaintenanceLedgerPda,
+    deriveWithdrawMintAuthorityPda,
+    deriveWithdrawMintMetadataPda,
+    deriveWithdrawNftMintPda,
+    deriveLiqReceiptDataPda,
 } from '../constants';
 import { WalletLike } from '../types';
 
 export class DepositClient {
     private program: Program<LiqsolCore>;
 
-    get wallet(): WalletLike { return this.provider.wallet; }
+    get wallet(): WalletLike {
+        return this.provider.wallet;
+    }
 
     constructor(private provider: AnchorProvider) {
         const svc = new SolanaProgramService(provider);
         this.program = svc.getProgram('liqsolCore');
     }
 
-    async buildDepositTx(amount: bigint, user = this.wallet.publicKey): Promise<Transaction> {
+    /**
+     * Build a deposit transaction:
+     *   SOL -> liqSOL via liqsol_core::deposit.
+     */
+    async buildDepositTx(
+        amount: bigint,
+        user = this.wallet.publicKey,
+    ): Promise<Transaction> {
+        if (!user) {
+            throw new Error(
+                'DepositClient.buildDepositTx: wallet not connected',
+            );
+        }
+        if (!amount || amount <= BigInt(0)) {
+            throw new Error(
+                'DepositClient.buildDepositTx: amount must be greater than zero.',
+            );
+        }
+
         // -------------------------------------------------------------
         // PDAs
         // -------------------------------------------------------------
@@ -59,8 +86,6 @@ export class DepositClient {
         const payoutState = derivePayoutStatePda();
         const bucketAuthority = deriveBucketAuthorityPda();
         const payRateHistory = derivePayRateHistoryPda();
-        const distributionState = deriveDistributionStatePda();
-        const userRecord = deriveUserRecordPda(user);
 
         // -------------------------------------------------------------
         // Token-2022 ATAs
@@ -69,14 +94,20 @@ export class DepositClient {
             liqsolMint,
             user,
             false,
-            TOKEN_2022_PROGRAM_ID
+            TOKEN_2022_PROGRAM_ID,
         );
 
+        // -------------------------------------------------------------
+        // Distribution state + user_record (KEYED BY TOKEN ACCOUNT)
+        // -------------------------------------------------------------
+        const distributionState = deriveDistributionStatePda();
+        const userRecord = deriveUserRecordPda(userAta);
+
         const bucketTokenAccount = getAssociatedTokenAddressSync(
             liqsolMint,
             bucketAuthority,
             true,
-            TOKEN_2022_PROGRAM_ID
+            TOKEN_2022_PROGRAM_ID,
         );
 
         // -------------------------------------------------------------
@@ -124,4 +155,119 @@ export class DepositClient {
 
         return new Transaction().add(ix);
     }
+
+    /**
+     * Build a withdraw-request transaction:
+     *   liqSOL -> SOL via liqsol_core::requestWithdraw.
+     *
+     * This:
+     *  - burns liqSOL from the user
+     *  - increments totalEncumberedFunds in global state
+     *  - mints an NFT receipt (liqReceiptData + NFT ATA for owner)
+     */
+    async buildWithdrawTx(
+        amount: bigint,
+        user = this.wallet.publicKey,
+    ): Promise<Transaction> {
+        if (!user) {
+            throw new Error(
+                'DepositClient.buildWithdrawTx: wallet not connected',
+            );
+        }
+        if (!amount || amount <= BigInt(0)) {
+            throw new Error(
+                'DepositClient.buildWithdrawTx: amount must be greater than zero.',
+            );
+        }
+
+        // -------------------------------------------------------------
+        // Core program + liqSOL mint / user ATA
+        // -------------------------------------------------------------
+        const liqsolMint = deriveLiqsolMintPda();
+
+        const userAta = getAssociatedTokenAddressSync(
+            liqsolMint,
+            user,
+            false,
+            TOKEN_2022_PROGRAM_ID,
+        );
+
+        // Distribution / balance-tracking
+        // user_record is keyed by the user’s liqSOL ATA (same convention as deposit/purchase)
+        const userRecord = deriveUserRecordPda(userAta);
+        const distributionState = deriveDistributionStatePda();
+
+        // Reserve + stake controller PDAs
+        const global = deriveWithdrawGlobalPda();
+        const reservePool = deriveReservePoolPda();
+        const stakeAllocationState = deriveStakeAllocationStatePda();
+        const stakeMetrics = deriveStakeMetricsPda();
+        const maintenanceLedger = deriveMaintenanceLedgerPda();
+
+        // -------------------------------------------------------------
+        // Need nextReceiptId from withdraw global state
+        // -------------------------------------------------------------
+        const globalState = await this.program.account.global.fetch(global);
+        const receiptId = (globalState.nextReceiptId as BN).toBigInt();
+
+        // -------------------------------------------------------------
+        // NFT receipt PDAs (mint, metadata, data, ATA)
+        // -------------------------------------------------------------
+        const mintAuthority = deriveWithdrawMintAuthorityPda();
+        const metadata = deriveWithdrawMintMetadataPda();
+
+        const nftMint = deriveWithdrawNftMintPda(receiptId);
+        const receiptData = deriveLiqReceiptDataPda(nftMint);
+
+        const owner = user;
+        const nftAta = getAssociatedTokenAddressSync(
+            nftMint,
+            owner,
+            false,
+            TOKEN_2022_PROGRAM_ID,
+        );
+
+        // Bucket token account (same bucket used by deposit/distribution)
+        const bucketAuthority = deriveBucketAuthorityPda();
+        const bucketTokenAccount = getAssociatedTokenAddressSync(
+            liqsolMint,
+            bucketAuthority,
+            true,
+            TOKEN_2022_PROGRAM_ID,
+        );
+
+        // -------------------------------------------------------------
+        // BUILD IX (MUST MATCH requestWithdraw IDL)
+        // -------------------------------------------------------------
+        const ix: TransactionInstruction = await this.program.methods
+            .requestWithdraw(new BN(amount.toString()))
+            .accounts({
+                user,
+                owner,
+                global,
+                liqsolMint,
+                userAta,
+                userRecord,
+                reservePool,
+                stakeAllocationState,
+                stakeMetrics,
+                maintenanceLedger,
+                clock: SYSVAR_CLOCK_PUBKEY,
+                mintAuthority,
+                receiptData,
+                metadata,
+                nftMint,
+                nftAta,
+                distributionState,
+                bucketTokenAccount,
+                tokenProgram: TOKEN_2022_PROGRAM_ID,
+                tokenInterface: TOKEN_2022_PROGRAM_ID,
+                associatedTokenProgram: ASSOCIATED_TOKEN_PROGRAM_ID,
+                systemProgram: SystemProgram.programId,
+                rent: SYSVAR_RENT_PUBKEY,
+            })
+            .instruction();
+
+        return new Transaction().add(ix);
+    }
 }