@ember-finance/sdk 2.0.0 → 2.0.2

package/README.md

@@ -16,21 +16,21 @@ yield-generating strategies.
 
 ### Supported Chains
 
--   **SUI** - Full support for SUI blockchain
--   **EVM** - Support for Ethereum and EVM-compatible chains (using ethers.js v6)
-    -   EVM vaults implement the **ERC-4626** tokenized vault standard
-    -   The vault contract itself is the share token (ERC20)
+- **SUI** - Full support for SUI blockchain
+- **EVM** - Support for Ethereum and EVM-compatible chains (using ethers.js v6)
+    - EVM vaults implement the **ERC-4626** tokenized vault standard
+    - The vault contract itself is the share token (ERC20)
 
 ### Architecture
 
 The SDK is built around several key classes:
 
--   **EmberVaults**: Main entry point for vault interactions (supports both SUI and EVM)
--   **AdminCalls**: Administrative functions for protocol management
--   **UserCalls**: User-facing operations for deposits and withdrawals
--   **OperatorCalls**: Operator functions for vault management
--   **VaultAdminCalls**: Vault-specific administrative functions
--   **TxBuilder**: Transaction building utilities
+- **EmberVaults**: Main entry point for vault interactions (supports both SUI and EVM)
+- **AdminCalls**: Administrative functions for protocol management
+- **UserCalls**: User-facing operations for deposits and withdrawals
+- **OperatorCalls**: Operator functions for vault management
+- **VaultAdminCalls**: Vault-specific administrative functions
+- **TxBuilder**: Transaction building utilities
 
 ## Installation
 
@@ -50,10 +50,14 @@ yarn add @ember-finance/sdk
 
 ```typescript
 import { EmberVaults } from "@ember-finance/sdk";
-import { SuiClient, Ed25519Keypair } from "@mysten/sui.js";
+import { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
+import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
 
 // Setup SUI client and signer
-const suiClient = new SuiClient({ url: "https://fullnode.mainnet.sui.io" });
+const suiClient = new SuiJsonRpcClient({
+    url: "https://fullnode.mainnet.sui.io",
+    network: "mainnet"
+});
 const keypair = Ed25519Keypair.fromSecretKey(privateKeyBytes);
 
 // Initialize EmberVaults for SUI
@@ -313,64 +317,64 @@ Handle user-facing vault operations:
 
 **EVM (ERC-4626):**
 
--   **deposit**: Deposit assets and receive shares (ERC-4626 standard, requires approval)
--   **depositWithPermit**: Deposit assets using EIP-2612 permit (single transaction, no
-    approval needed) ✨ **NEW**
--   **mint**: Mint specific shares by depositing required assets (ERC-4626 standard,
-    requires approval)
--   **mintWithPermit**: Mint shares using EIP-2612 permit (single transaction, no approval
-    needed) ✨ **NEW**
--   **redeemShares**: Redeem shares to initiate withdrawal request
--   **cancelPendingWithdrawalRequest**: Cancel pending withdrawal requests
--   **approveToken**: Approve token spending
--   **approveTokenMax**: Approve maximum token spending
+- **deposit**: Deposit assets and receive shares (ERC-4626 standard, requires approval)
+- **depositWithPermit**: Deposit assets using EIP-2612 permit (single transaction, no
+  approval needed) ✨ **NEW**
+- **mint**: Mint specific shares by depositing required assets (ERC-4626 standard,
+  requires approval)
+- **mintWithPermit**: Mint shares using EIP-2612 permit (single transaction, no approval
+  needed) ✨ **NEW**
+- **redeemShares**: Redeem shares to initiate withdrawal request
+- **cancelPendingWithdrawalRequest**: Cancel pending withdrawal requests
+- **approveToken**: Approve token spending
+- **approveTokenMax**: Approve maximum token spending
 
 **Permit Utilities (EVM):** ✨ **NEW**
 
--   **signPermitSimple**: Generate EIP-2612 permit signature with automatic nonce and
-    deadline
--   **signPermit**: Generate EIP-2612 permit signature with custom parameters
--   **getPermitNonce**: Get current permit nonce for a user
+- **signPermitSimple**: Generate EIP-2612 permit signature with automatic nonce and
+  deadline
+- **signPermit**: Generate EIP-2612 permit signature with custom parameters
+- **getPermitNonce**: Get current permit nonce for a user
 
 **SUI:**
 
--   **depositAsset**: Deposit assets into a vault
--   **mintShares**: Mint vault shares with specific amount
--   **redeemShares**: Redeem shares for underlying assets
--   **cancelPendingWithdrawalRequest**: Cancel pending withdrawal requests
+- **depositAsset**: Deposit assets into a vault
+- **mintShares**: Mint vault shares with specific amount
+- **redeemShares**: Redeem shares for underlying assets
+- **cancelPendingWithdrawalRequest**: Cancel pending withdrawal requests
 
 ### Admin Functions (AdminCalls)
 
 Protocol-level administrative functions:
 
--   **updateMaxFeePercentage**: Update protocol fee limits
--   **pauseNonAdminOperations**: Emergency protocol controls
--   **updatePlatformFeeRecipient**: Update fee recipient
--   **setBlacklistedAccount**: Manage blacklisted accounts
--   **updateVaultAdmin**: Update vault admin address
+- **updateMaxFeePercentage**: Update protocol fee limits
+- **pauseNonAdminOperations**: Emergency protocol controls
+- **updatePlatformFeeRecipient**: Update fee recipient
+- **setBlacklistedAccount**: Manage blacklisted accounts
+- **updateVaultAdmin**: Update vault admin address
 
 ### Operator Functions (OperatorCalls)
 
 Vault operator management functions:
 
--   **collectPlatformFee**: Collect accumulated fees
--   **processWithdrawalRequests**: Process pending withdrawals
--   **updateVaultRate**: Update vault exchange rates (rate manager role)
--   **withdrawFromVaultWithoutRedeemingShares**: Withdraw for strategy execution
+- **collectPlatformFee**: Collect accumulated fees
+- **processWithdrawalRequests**: Process pending withdrawals
+- **updateVaultRate**: Update vault exchange rates (rate manager role)
+- **withdrawFromVaultWithoutRedeemingShares**: Withdraw for strategy execution
 
 ### Vault Admin Functions (VaultAdminCalls)
 
 Vault-specific administrative controls (called via ProtocolConfig on EVM):
 
--   **updateVaultMinWithdrawableShares**: Configure minimum withdrawal amounts
--   **setVaultSubAccount**: Manage vault sub-accounts
--   **updateVaultOperator**: Change vault operators
--   **updateVaultRateManager**: Change rate manager
--   **setVaultPausedStatus**: Pause/unpause vault operations
--   **updateVaultFeePercentage**: Update vault fee percentage
--   **updateVaultMaxTVL**: Update maximum TVL
--   **updateVaultRateUpdateInterval**: Update rate update interval
--   **updateVaultName**: Update vault name
+- **updateVaultMinWithdrawableShares**: Configure minimum withdrawal amounts
+- **setVaultSubAccount**: Manage vault sub-accounts
+- **updateVaultOperator**: Change vault operators
+- **updateVaultRateManager**: Change rate manager
+- **setVaultPausedStatus**: Pause/unpause vault operations
+- **updateVaultFeePercentage**: Update vault fee percentage
+- **updateVaultMaxTVL**: Update maximum TVL
+- **updateVaultRateUpdateInterval**: Update rate update interval
+- **updateVaultName**: Update vault name
 
 ## EIP-2612 Permit Support (EVM) ✨ **NEW**
 
@@ -378,9 +382,9 @@ The Ember vaults now support **EIP-2612 permit signatures**, allowing users to d
 mint shares in a **single transaction** without requiring a separate approval transaction.
 This significantly improves the user experience by:
 
--   Reducing gas costs (one transaction instead of two)
--   Eliminating the need to wait for approval transaction confirmation
--   Providing a smoother, faster deposit flow
+- Reducing gas costs (one transaction instead of two)
+- Eliminating the need to wait for approval transaction confirmation
+- Providing a smoother, faster deposit flow
 
 ### How Permit Works
 
@@ -441,14 +445,14 @@ await ember.user.depositWithPermit(vaultAddress, amount, permitSig);
 
 ### Important Notes
 
--   **Token Support**: The underlying token must support EIP-2612 permit. Most modern
-    tokens (USDC, DAI, etc.) support this standard.
--   **Token Name**: The token name passed to `signPermit` must match the token's EIP-2612
-    domain name exactly.
--   **Deadline**: Permit signatures have a deadline. After the deadline, the signature
-    becomes invalid.
--   **Nonce**: Each permit signature uses a nonce. Once used, the nonce increments and the
-    signature cannot be reused.
+- **Token Support**: The underlying token must support EIP-2612 permit. Most modern tokens
+  (USDC, DAI, etc.) support this standard.
+- **Token Name**: The token name passed to `signPermit` must match the token's EIP-2612
+  domain name exactly.
+- **Deadline**: Permit signatures have a deadline. After the deadline, the signature
+  becomes invalid.
+- **Nonce**: Each permit signature uses a nonce. Once used, the nonce increments and the
+  signature cannot be reused.
 
 ## ERC-4626 Compatibility (EVM)
 

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -1 +1 @@
-"use strict";
+export {};