@pufferfinance/puffer-sdk 1.5.4 → 1.6.0

package/dist/api/puffer-client-helpers.d.ts

@@ -0,0 +1,33 @@
+import { CustomTransportConfig, PublicClient, WalletClient } from 'viem';
+import { Chain } from '../chains/constants';
+import { TransportProvider } from '../utils/types';
+export type ClientConfig = {
+    chain: Chain;
+} & ({
+    rpcUrls: string[];
+} | {
+    provider: TransportProvider;
+    config?: CustomTransportConfig;
+});
+/**
+ * Helper methods for the main `PufferClient`.
+ */
+export declare class PufferClientHelpers {
+    /**
+     * Helper method for creating a public client based on the
+     * configuration
+     *
+     * @param config Configuration for the public client.
+     * @returns The public client created with viem.
+     */
+    static createPublicClient(config: ClientConfig): PublicClient;
+    /**
+     * Helper method for creating a wallet client based on the
+     * configuration
+     *
+     * @param config Configuration for the wallet client.
+     * @returns The wallet client created with viem.
+     */
+    static createWalletClient(config: ClientConfig): WalletClient;
+    private static extractTransportConfig;
+}

package/dist/api/puffer-client.d.ts

@@ -0,0 +1,52 @@
+import { PublicClient, WalletClient } from 'viem';
+import { Chain } from '../chains/constants';
+import { PufferVaultHandler } from '../contracts/handlers/puffer-vault-handler';
+import { PufferDepositorHandler } from '../contracts/handlers/puffer-depositor-handler';
+import { PufTokenHandler } from '../contracts/handlers/puf-token-handler';
+import { PufferL2DepositorHandler } from '../contracts/handlers/puffer-l2-depositor-handler';
+import { ERC20PermitHandler } from '../contracts/handlers/erc20-permit-handler';
+import { PufLockerHandler } from '../contracts/handlers/puf-locker-handler';
+import { L2RewardManagerHandler } from '../contracts/handlers/l2-reward-manager-handler';
+import { L1RewardManagerHandler } from '../contracts/handlers/l1-reward-manager-handler';
+import { PufferWithdrawalManagerHandler } from '../contracts/handlers/puffer-withdrawal-manager-handler';
+/**
+ * The core class and the main entry point of the Puffer SDK.
+ */
+export declare class PufferClient {
+    private walletClient;
+    private publicClient;
+    /** Handler for the `ERC20Permit` contract. */
+    erc20Permit: ERC20PermitHandler;
+    /** Handler for the `PufferVaultV2` contract. */
+    vault: PufferVaultHandler;
+    /** Handler for the `PufferDepositor` contract. */
+    depositor: PufferDepositorHandler;
+    /** Handler for the `PufferL2Depositor` contract. */
+    l2Depositor: PufferL2DepositorHandler;
+    /** Handler for the `PufToken` contract. */
+    pufToken: PufTokenHandler;
+    /** Handler for the `PufLocker` contract. */
+    pufLocker: PufLockerHandler;
+    /** Handler for the `L2RewardManager` contract. */
+    l2RewardManager: L2RewardManagerHandler;
+    /** Handler for the `L1RewardManager` contract. */
+    l1RewardManager: L1RewardManagerHandler;
+    /** Handler for the `PufferWithdrawalManager` contract. */
+    pufferWithdrawalManager: PufferWithdrawalManagerHandler;
+    /**
+     * Create the Puffer Client.
+     *
+     * @param chain Chain to use for the client.
+     * @param walletClient The wallet client to use for wallet
+     * interactions.
+     * @param publicClient The public client to use for public
+     * interactions.
+     */
+    constructor(chain: Chain, walletClient?: WalletClient, publicClient?: PublicClient);
+    /**
+     * Request addresses from the wallet.
+     *
+     * @returns An array of wallet addresses.
+     */
+    requestAddresses(): Promise<import('viem').RequestAddressesReturnType>;
+}

package/dist/chains/constants.d.ts

@@ -0,0 +1,11 @@
+import { Chain as ViemChain } from 'viem';
+export declare enum Chain {
+    Mainnet,
+    Holesky,
+    Base,
+    Bsc
+}
+export declare const VIEM_CHAINS: {
+    [key in Chain]: ViemChain;
+};
+export { type ViemChain };

package/dist/contracts/abis/holesky/PufferDepositor.d.ts

@@ -0,0 +1,283 @@
+export declare const PufferDepositor: readonly [{
+    readonly type: "constructor";
+    readonly inputs: readonly [{
+        readonly name: "pufferVault";
+        readonly type: "address";
+        readonly internalType: "contract PufferVaultV2";
+    }, {
+        readonly name: "stETH";
+        readonly type: "address";
+        readonly internalType: "contract IStETH";
+    }];
+    readonly stateMutability: "payable";
+}, {
+    readonly type: "function";
+    readonly name: "PUFFER_VAULT";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "contract PufferVaultV2";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "UPGRADE_INTERFACE_VERSION";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "authority";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "depositStETH";
+    readonly inputs: readonly [{
+        readonly name: "permitData";
+        readonly type: "tuple";
+        readonly internalType: "struct Permit";
+        readonly components: readonly [{
+            readonly name: "deadline";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "v";
+            readonly type: "uint8";
+            readonly internalType: "uint8";
+        }, {
+            readonly name: "r";
+            readonly type: "bytes32";
+            readonly internalType: "bytes32";
+        }, {
+            readonly name: "s";
+            readonly type: "bytes32";
+            readonly internalType: "bytes32";
+        }];
+    }, {
+        readonly name: "recipient";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "pufETHAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "depositWstETH";
+    readonly inputs: readonly [{
+        readonly name: "permitData";
+        readonly type: "tuple";
+        readonly internalType: "struct Permit";
+        readonly components: readonly [{
+            readonly name: "deadline";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "v";
+            readonly type: "uint8";
+            readonly internalType: "uint8";
+        }, {
+            readonly name: "r";
+            readonly type: "bytes32";
+            readonly internalType: "bytes32";
+        }, {
+            readonly name: "s";
+            readonly type: "bytes32";
+            readonly internalType: "bytes32";
+        }];
+    }, {
+        readonly name: "recipient";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "pufETHAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "isConsumingScheduledOp";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes4";
+        readonly internalType: "bytes4";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "proxiableUUID";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setAuthority";
+    readonly inputs: readonly [{
+        readonly name: "newAuthority";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "upgradeToAndCall";
+    readonly inputs: readonly [{
+        readonly name: "newImplementation";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "data";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "payable";
+}, {
+    readonly type: "event";
+    readonly name: "AuthorityUpdated";
+    readonly inputs: readonly [{
+        readonly name: "authority";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "Initialized";
+    readonly inputs: readonly [{
+        readonly name: "version";
+        readonly type: "uint64";
+        readonly indexed: false;
+        readonly internalType: "uint64";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "Upgraded";
+    readonly inputs: readonly [{
+        readonly name: "implementation";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "AccessManagedInvalidAuthority";
+    readonly inputs: readonly [{
+        readonly name: "authority";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "AccessManagedRequiredDelay";
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "delay";
+        readonly type: "uint32";
+        readonly internalType: "uint32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "AccessManagedUnauthorized";
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "AddressEmptyCode";
+    readonly inputs: readonly [{
+        readonly name: "target";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "AddressInsufficientBalance";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC1967InvalidImplementation";
+    readonly inputs: readonly [{
+        readonly name: "implementation";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC1967NonPayable";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "FailedInnerCall";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidInitialization";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "NotInitializing";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "SafeERC20FailedOperation";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "UUPSUnauthorizedCallContext";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "UUPSUnsupportedProxiableUUID";
+    readonly inputs: readonly [{
+        readonly name: "slot";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+}];