@rainlanguage/ui-components 0.0.1-alpha.117 → 0.0.1-alpha.119

package/dist/index.d.ts

@@ -68,9 +68,8 @@ export { default as TransactionList } from './components/transactions/Transactio
 export { default as FixedBottomTransaction } from './components/transactions/FixedBottomTransaction.svelte';
 export type { AppStoresInterface } from './types/appStores.ts';
 export type { OrderbookConfigSource, OrderbookCfgRef } from '@rainlanguage/orderbook';
-export { TransactionStatusMessage, TransactionStoreErrorMessage, type ExtendedApprovalCalldata, type TransactionArgs } from './types/transaction';
+export { TransactionStatusMessage, TransactionStoreErrorMessage, type ExtendedApprovalCalldata, type TransactionArgs, type DeploymentArgs, type VaultActionArgs } from './types/transaction';
 export type { TransactionErrorMessage } from './stores/transactionStore';
-export type { DeploymentArgs, VaultActionArgs } from './types/transaction';
 export type { VaultActionModalProps, QuoteDebugModalHandler, DebugTradeModalHandler, DeployModalProps, DisclaimerModalProps, TransactionConfirmationProps } from './types/modal';
 export type { ValidStrategyDetail, InvalidStrategyDetail } from './types/strategy';
 export type { ToastProps } from './types/toast';

package/dist/providers/transactions/TransactionManager.d.ts

@@ -59,6 +59,26 @@ export declare class TransactionManager {
      * });
      */
     createRemoveOrderTransaction(args: InternalTransactionArgs): Promise<Transaction>;
+    /**
+     * Creates and initializes a new transaction for withdrawing funds from a vault
+     * @param args - Configuration for the withdrawal transaction
+     * @param args.subgraphUrl - URL of the subgraph to query for transaction status
+     * @param args.txHash - Hash of the transaction to track
+     * @param args.orderHash - Identifier related to the transaction (e.g. vault ID or context-specific ID if applicable).
+     * @param args.chainId - Chain ID where the transaction is being executed
+     * @param args.queryKey - Identifier for the vault, used for cache invalidation and UI links.
+     * @param args.networkKey - Network identifier for UI links.
+     * @returns A new Transaction instance configured for withdrawal
+     * @throws {Error} If required transaction parameters are missing
+     * @example
+     * const tx = await manager.createWithdrawTransaction({
+     *   subgraphUrl: 'https://api.thegraph.com/subgraphs/name/...',
+     *   txHash: '0x123...',
+     *   orderHash: '0x456...',
+     *   chainId: 1
+     * });
+     */
+    createWithdrawTransaction(args: InternalTransactionArgs): Promise<Transaction>;
     /**
      * Creates and executes a new transaction instance
      * @param args - Configuration for the transaction

package/dist/providers/transactions/TransactionManager.js

@@ -2,7 +2,7 @@ import { writable } from 'svelte/store';
 import { TransactionStore } from '../../models/Transaction';
 import { getExplorerLink } from '../../services/getExplorerLink';
 import { TransactionName } from '../../types/transaction';
-import { getTransactionRemoveOrders } from '@rainlanguage/orderbook';
+import { getTransaction, getTransactionRemoveOrders } from '@rainlanguage/orderbook';
 /**
  * Manages blockchain transactions with toast notifications and query invalidation.
  * Handles transaction lifecycle, status updates, and UI feedback.
@@ -88,6 +88,58 @@ export class TransactionManager {
             }
         });
     }
+    /**
+     * Creates and initializes a new transaction for withdrawing funds from a vault
+     * @param args - Configuration for the withdrawal transaction
+     * @param args.subgraphUrl - URL of the subgraph to query for transaction status
+     * @param args.txHash - Hash of the transaction to track
+     * @param args.orderHash - Identifier related to the transaction (e.g. vault ID or context-specific ID if applicable).
+     * @param args.chainId - Chain ID where the transaction is being executed
+     * @param args.queryKey - Identifier for the vault, used for cache invalidation and UI links.
+     * @param args.networkKey - Network identifier for UI links.
+     * @returns A new Transaction instance configured for withdrawal
+     * @throws {Error} If required transaction parameters are missing
+     * @example
+     * const tx = await manager.createWithdrawTransaction({
+     *   subgraphUrl: 'https://api.thegraph.com/subgraphs/name/...',
+     *   txHash: '0x123...',
+     *   orderHash: '0x456...',
+     *   chainId: 1
+     * });
+     */
+    async createWithdrawTransaction(args) {
+        const name = TransactionName.WITHDRAWAL;
+        const errorMessage = 'Withdrawal failed.';
+        const successMessage = 'Withdrawal successful.';
+        const queryKey = args.queryKey;
+        const networkKey = args.networkKey;
+        const explorerLink = await getExplorerLink(args.txHash, args.chainId, 'tx');
+        const toastLinks = [
+            {
+                link: `/vaults/${networkKey}-${args.queryKey}`,
+                label: 'View vault'
+            },
+            {
+                link: explorerLink,
+                label: 'View transaction'
+            }
+        ];
+        return this.createTransaction({
+            ...args,
+            name,
+            errorMessage,
+            successMessage,
+            queryKey,
+            toastLinks,
+            awaitSubgraphConfig: {
+                subgraphUrl: args.subgraphUrl,
+                txHash: args.txHash,
+                successMessage,
+                fetchEntityFn: getTransaction,
+                isSuccess: (data) => !!data
+            }
+        });
+    }
     /**
      * Creates and executes a new transaction instance
      * @param args - Configuration for the transaction

package/dist/stores/transactionStore.js

@@ -1,9 +1,9 @@
 import { writable } from 'svelte/store';
 import { sendTransaction, switchChain, waitForTransactionReceipt } from '@wagmi/core';
-import { TransactionStatusMessage } from '../types/transaction';
-import { getTransaction, getTransactionAddOrders } from '@rainlanguage/orderbook';
 import { getExplorerLink } from '../services/getExplorerLink';
+import { TransactionStatusMessage } from '../types/transaction';
 import { awaitSubgraphIndexing } from '../services/awaitTransactionIndexing';
+import { getTransaction, getTransactionAddOrders } from '@rainlanguage/orderbook';
 export const ADDRESS_ZERO = '0x0000000000000000000000000000000000000000';
 export const ONE = BigInt('1000000000000000000');
 export var TransactionErrorMessage;

package/dist/types/modal.d.ts

@@ -1,9 +1,10 @@
-import type { SgOrder } from '@rainlanguage/orderbook';
-import type { VaultActionArgs, DeploymentArgs } from './transaction';
+import type { SgOrder, SgVault } from '@rainlanguage/orderbook';
+import type { DeploymentArgs, VaultActionArgs } from './transaction';
 import type { Hex } from 'viem';
 export type VaultActionModalProps = {
     open: boolean;
     args: VaultActionArgs;
+    onSubmit: (amount: bigint) => void;
 };
 export type DeployModalProps = {
     open: boolean;
@@ -20,7 +21,7 @@ export type TransactionConfirmationProps = {
         chainId: number;
         orderbookAddress: Hex;
         onConfirm: (hash: Hex) => void;
-        order: SgOrder;
+        entity: SgOrder | SgVault;
         calldata: string;
     };
 };

package/dist/types/transaction.d.ts

@@ -16,14 +16,15 @@ export type DeploymentArgs = {
 };
 export type VaultActionArgs = {
     vault: SgVault;
-    onSuccess: () => void;
     chainId: number;
+    onDeposit?: () => void;
     rpcUrl: string;
     subgraphUrl: string;
     account: Hex;
 };
 export declare enum TransactionName {
-    REMOVAL = "Order Removal"
+    REMOVAL = "Order Removal",
+    WITHDRAWAL = "Vault Withdrawal"
 }
 export declare enum TransactionStatusMessage {
     IDLE = "Idle",
@@ -55,11 +56,11 @@ export type DepositOrWithdrawTransactionArgs = {
     subgraphUrl: string;
 };
 export type InternalTransactionArgs = {
-    queryKey: string;
     chainId: number;
     subgraphUrl: string;
     txHash: Hex;
     networkKey: string;
+    queryKey: string;
 };
 export type TransactionArgs = InternalTransactionArgs & {
     name: TransactionName;

package/dist/types/transaction.js

@@ -1,6 +1,7 @@
 export var TransactionName;
 (function (TransactionName) {
     TransactionName["REMOVAL"] = "Order Removal";
+    TransactionName["WITHDRAWAL"] = "Vault Withdrawal";
 })(TransactionName || (TransactionName = {}));
 export var TransactionStatusMessage;
 (function (TransactionStatusMessage) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rainlanguage/ui-components",
-	"version": "0.0.1-alpha.117",
+	"version": "0.0.1-alpha.119",
 	"description": "A component library for building Svelte applications to be used with Raindex.",
 	"license": "LicenseRef-DCL-1.0",
 	"author": "Rain Open Source Software Ltd",
@@ -53,7 +53,7 @@
 		"@fontsource/dm-sans": "5.1.0",
 		"@imask/svelte": "7.6.1",
 		"@observablehq/plot": "0.6.16",
-		"@rainlanguage/orderbook": "0.0.1-alpha.117",
+		"@rainlanguage/orderbook": "0.0.1-alpha.119",
 		"@reown/appkit": "1.6.4",
 		"@reown/appkit-adapter-wagmi": "1.6.4",
 		"@sentry/sveltekit": "7.120.0",