@pufferfinance/puffer-sdk 1.0.2 → 1.1.0

package/dist/contracts/abis/tokens-abis.d.ts

@@ -0,0 +1,396 @@
+export declare const ERC20PERMIT_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "DOMAIN_SEPARATOR";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "approve";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "balanceOf";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "decimals";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "eip712Domain";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "fields";
+        readonly type: "bytes1";
+        readonly internalType: "bytes1";
+    }, {
+        readonly name: "name";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "version";
+        readonly type: "string";
+        readonly internalType: "string";
+    }, {
+        readonly name: "chainId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "verifyingContract";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "extensions";
+        readonly type: "uint256[]";
+        readonly internalType: "uint256[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "name";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "nonces";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "permit";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "deadline";
+        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 outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "symbol";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "totalSupply";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "transfer";
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "transferFrom";
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "event";
+    readonly name: "Approval";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "EIP712DomainChanged";
+    readonly inputs: readonly [];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "Transfer";
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "ECDSAInvalidSignature";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ECDSAInvalidSignatureLength";
+    readonly inputs: readonly [{
+        readonly name: "length";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ECDSAInvalidSignatureS";
+    readonly inputs: readonly [{
+        readonly name: "s";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC20InsufficientAllowance";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "allowance";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "needed";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC20InsufficientBalance";
+    readonly inputs: readonly [{
+        readonly name: "sender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "balance";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "needed";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC20InvalidApprover";
+    readonly inputs: readonly [{
+        readonly name: "approver";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC20InvalidReceiver";
+    readonly inputs: readonly [{
+        readonly name: "receiver";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC20InvalidSender";
+    readonly inputs: readonly [{
+        readonly name: "sender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC20InvalidSpender";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC2612ExpiredSignature";
+    readonly inputs: readonly [{
+        readonly name: "deadline";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ERC2612InvalidSigner";
+    readonly inputs: readonly [{
+        readonly name: "signer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidAccountNonce";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "currentNonce";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidShortString";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "StringTooLong";
+    readonly inputs: readonly [{
+        readonly name: "str";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+}];

package/dist/contracts/addresses.d.ts

@@ -1,11 +1,6 @@
 export declare const CHAIN_ADDRESSES: {
-    mainnet: {
-        PufferVault: string;
-    };
-    holesky: {
-        PufferVault: string;
-    };
-    anvil: {
+    [x: number]: {
         PufferVault: string;
+        PufferDepositor: string;
     };
 };

package/dist/contracts/handlers/puffer-depositor-handler.d.ts

@@ -0,0 +1,61 @@
+import { Address, PublicClient, WalletClient } from 'viem';
+import { Chain } from '../../chains/constants';
+import { TokensHandler } from './tokens-handler';
+
+/**
+ * Handler for the `PufferDepositor` contract exposing methods to
+ * interact with the contract.
+ */
+export declare class PufferDepositorHandler {
+    private chain;
+    private walletClient;
+    private publicClient;
+    private viemChain;
+    tokensHandler: TokensHandler;
+    /**
+     * Create the handler for the `PufferDepositor` contract exposing
+     * methods to interact with the contract.
+     *
+     * @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);
+    private getContract;
+    /**
+     * Deposit stETH in exchange for pufETH. This doesn't make the
+     * transaction but returns two methods namely `transact` and
+     * `estimate`.
+     *
+     * @param walletAddress Wallet address to get the stETH from.
+     * @param value Value in wei of the stETH to deposit.
+     * @returns `transact: () => Promise<Address>` - Used to make the
+     * transaction.
+     *
+     * `estimate: () => Promise<bigint>` - Gas estimate of the
+     * transaction.
+     */
+    depositStETH(walletAddress: Address, value: bigint): Promise<{
+        transact: () => Promise<`0x${string}`>;
+        estimate: () => Promise<bigint>;
+    }>;
+    /**
+     * Deposit wstETH in exchange for pufETH. This doesn't make the
+     * transaction but returns two methods namely `transact` and
+     * `estimate`.
+     *
+     * @param walletAddress Wallet address to get the stETH from.
+     * @param value Value in wei of the wstETH to deposit.
+     * @returns `transact: () => Promise<Address>` - Used to make the
+     * transaction.
+     *
+     * `estimate: () => Promise<bigint>` - Gas estimate of the
+     * transaction.
+     */
+    depositWstETH(walletAddress: Address, value: bigint): Promise<{
+        transact: () => Promise<`0x${string}`>;
+        estimate: () => Promise<bigint>;
+    }>;
+}

package/dist/contracts/handlers/puffer-vault-handler.d.ts

@@ -23,7 +23,7 @@ export declare class PufferVaultHandler {
     constructor(chain: Chain, walletClient: WalletClient, publicClient: PublicClient);
     private getContract;
     /**
-     * Deposit ETH to the given wallet address. This doesn't make the
+     * Deposit ETH in exchange for pufETH. This doesn't make the
      * transaction but returns two methods namely `transact` and
      * `estimate`.
      *
@@ -38,23 +38,6 @@ export declare class PufferVaultHandler {
         transact: (value: bigint) => Promise<`0x${string}`>;
         estimate: () => Promise<bigint>;
     };
-    /**
-     * Deposit stETH to the given wallet address. This doesn't make the
-     * transaction but returns two methods namely `transact` and
-     * `estimate`.
-     *
-     * @param walletAddress Wallet address to get the ETH from.
-     * @param value Value in wei of the stETH to deposit.
-     * @returns `transact: () => Promise<Address>` - Used to make the
-     * transaction with the given value.
-     *
-     * `estimate: () => Promise<bigint>` - Gas estimate of the
-     * transaction.
-     */
-    depositStETH(walletAddress: Address, value: bigint): {
-        transact: () => Promise<`0x${string}`>;
-        estimate: () => Promise<bigint>;
-    };
     /**
      * Check the pufETH balance of the wallet.
      *

package/dist/contracts/handlers/tokens-handler.d.ts

@@ -0,0 +1,46 @@
+import { WalletClient, PublicClient, Address } from 'viem';
+import { Chain } from '../../chains/constants';
+import { Token } from '../tokens';
+
+/**
+ * Handler for performing operations for and with tokens.
+ */
+export declare class TokensHandler {
+    private chain;
+    private walletClient;
+    private publicClient;
+    /**
+     * Create the handler for processing tokens.
+     *
+     * @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);
+    private getContract;
+    /**
+     * Process and get permit signature for the given token to perform
+     * transactions through the `PufferDepositor` contract.
+     *
+     * @param token Token for which to get the permit signature.
+     * @param walletAddress Wallet address making the transaction.
+     * @param value Value of the transaction.
+     * @returns Permit signature in the form `{ r, s, v?, yParity }`.
+     */
+    getPermitSignature(token: Token, walletAddress: Address, value: bigint): Promise<{
+        deadline: bigint;
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: bigint;
+        yParity: number;
+    } | {
+        deadline: bigint;
+        r: `0x${string}`;
+        s: `0x${string}`;
+        yParity: number;
+        v?: undefined;
+    }>;
+    private getPermitVersion;
+}

package/dist/contracts/tokens.d.ts

@@ -0,0 +1,14 @@
+import { Address } from 'viem';
+import { Chain } from '../chains/constants';
+
+export declare enum Token {
+    ETH = "ETH",
+    stETH = "stETH",
+    wstETH = "wstETH",
+    pufETH = "pufETH"
+}
+export declare const TOKENS_ADDRESSES: {
+    [key in Token]: {
+        [chain in Chain]: Address;
+    };
+};