@arkade-os/sdk 0.3.10 → 0.3.12

package/dist/types/arkfee/celenv.d.ts

@@ -0,0 +1,25 @@
+import { Environment } from "@marcbachmann/cel-js";
+/**
+ * Variable names used in CEL expressions
+ */
+export declare const AmountVariableName = "amount";
+export declare const ExpiryVariableName = "expiry";
+export declare const BirthVariableName = "birth";
+export declare const WeightVariableName = "weight";
+export declare const InputTypeVariableName = "inputType";
+export declare const OutputScriptVariableName = "script";
+/**
+ * IntentOutputEnv is the CEL environment for output fee calculation
+ * Variables: amount, script
+ */
+export declare const IntentOutputEnv: Environment;
+/**
+ * IntentOffchainInputEnv is the CEL environment for offchain input fee calculation
+ * Variables: amount, expiry, birth, weight, inputType
+ */
+export declare const IntentOffchainInputEnv: Environment;
+/**
+ * IntentOnchainInputEnv is the CEL environment for onchain input fee calculation
+ * Variables: amount
+ */
+export declare const IntentOnchainInputEnv: Environment;

package/dist/types/arkfee/estimator.d.ts

@@ -0,0 +1,49 @@
+import { IntentFeeConfig, OffchainInput, OnchainInput, FeeOutput, FeeAmount } from "./types.js";
+/**
+ * Estimator evaluates CEL expressions to calculate fees for Ark intents
+ */
+export declare class Estimator {
+    readonly config: IntentFeeConfig;
+    private intentOffchainInput?;
+    private intentOnchainInput?;
+    private intentOffchainOutput?;
+    private intentOnchainOutput?;
+    /**
+     * Creates a new Estimator with the given config
+     * @param config - Configuration containing CEL programs for fee calculation
+     */
+    constructor(config: IntentFeeConfig);
+    /**
+     * Evaluates the fee for a given vtxo input
+     * @param input - The offchain input to evaluate
+     * @returns The fee amount for this input
+     */
+    evalOffchainInput(input: OffchainInput): FeeAmount;
+    /**
+     * Evaluates the fee for a given boarding input
+     * @param input - The onchain input to evaluate
+     * @returns The fee amount for this input
+     */
+    evalOnchainInput(input: OnchainInput): FeeAmount;
+    /**
+     * Evaluates the fee for a given vtxo output
+     * @param output - The output to evaluate
+     * @returns The fee amount for this output
+     */
+    evalOffchainOutput(output: FeeOutput): FeeAmount;
+    /**
+     * Evaluates the fee for a given collaborative exit output
+     * @param output - The output to evaluate
+     * @returns The fee amount for this output
+     */
+    evalOnchainOutput(output: FeeOutput): FeeAmount;
+    /**
+     * Evaluates the fee for a given set of inputs and outputs
+     * @param offchainInputs - Array of offchain inputs to evaluate
+     * @param onchainInputs - Array of onchain inputs to evaluate
+     * @param offchainOutputs - Array of offchain outputs to evaluate
+     * @param onchainOutputs - Array of onchain outputs to evaluate
+     * @returns The total fee amount
+     */
+    eval(offchainInputs: OffchainInput[], onchainInputs: OnchainInput[], offchainOutputs: FeeOutput[], onchainOutputs: FeeOutput[]): FeeAmount;
+}

package/dist/types/arkfee/index.d.ts

@@ -0,0 +1,2 @@
+export { Estimator } from "./estimator";
+export type { FeeAmount, IntentFeeConfig, OffchainInput, OnchainInput, FeeOutput, VtxoType, } from "./types";

package/dist/types/arkfee/types.d.ts

@@ -0,0 +1,37 @@
+/**
+ * FeeAmount is a wrapper around a number that represents a fee amount in satoshis floating point.
+ * @param value - The fee amount in floating point.
+ * @method satoshis - Returns the fee amount in satoshis as a integer.
+ * @example
+ * const fee = new FeeAmount(1.23456789);
+ * console.log(fee.value); // 1.23456789
+ * console.log(fee.satoshis); // 2
+ */
+export declare class FeeAmount {
+    readonly value: number;
+    static ZERO: FeeAmount;
+    constructor(value: number);
+    get satoshis(): number;
+    add(other: FeeAmount): FeeAmount;
+}
+export interface IntentFeeConfig {
+    offchainInput?: string;
+    onchainInput?: string;
+    offchainOutput?: string;
+    onchainOutput?: string;
+}
+export type VtxoType = "recoverable" | "vtxo" | "note";
+export interface OffchainInput {
+    amount: bigint;
+    expiry?: Date;
+    birth?: Date;
+    type: VtxoType;
+    weight: number;
+}
+export interface OnchainInput {
+    amount: bigint;
+}
+export interface FeeOutput {
+    amount: bigint;
+    script: string;
+}

package/dist/types/index.d.ts

@@ -36,5 +36,6 @@ import { ContractRepositoryImpl } from "./repositories/contractRepository";
 import { ArkError, maybeArkError } from "./providers/errors";
 import { validateVtxoTxGraph, validateConnectorsTxGraph } from "./tree/validation";
 import { buildForfeitTx } from "./forfeit";
+export * from "./arkfee";
 export { Wallet, ReadonlyWallet, SingleKey, ReadonlySingleKey, OnchainWallet, Ramps, VtxoManager, ESPLORA_URL, EsploraProvider, RestArkProvider, RestIndexerProvider, ArkAddress, DefaultVtxo, VtxoScript, VHTLC, TxType, IndexerTxType, ChainTxType, SettlementEventType, setupServiceWorker, Worker, ServiceWorkerWallet, ServiceWorkerReadonlyWallet, Request, Response, decodeTapscript, MultisigTapscript, CSVMultisigTapscript, ConditionCSVMultisigTapscript, ConditionMultisigTapscript, CLTVMultisigTapscript, TapTreeCoder, ArkPsbtFieldKey, ArkPsbtFieldKeyType, setArkPsbtField, getArkPsbtFields, CosignerPublicKey, VtxoTreeExpiry, VtxoTaprootTree, ConditionWitness, buildOffchainTx, verifyTapscriptSignatures, waitForIncomingFunds, hasBoardingTxExpired, combineTapscriptSigs, isVtxoExpiringSoon, ArkNote, networks, WalletRepositoryImpl, ContractRepositoryImpl, Intent, TxTree, P2A, Unroll, Transaction, ArkError, maybeArkError, Batch, validateVtxoTxGraph, validateConnectorsTxGraph, buildForfeitTx, isRecoverable, isSpendable, isSubdust, isExpired, getSequence, };
 export type { Identity, ReadonlyIdentity, IWallet, IReadonlyWallet, BaseWalletConfig, WalletConfig, ReadonlyWalletConfig, ProviderClass, ArkTransaction, Coin, ExtendedCoin, ExtendedVirtualCoin, WalletBalance, SendBitcoinParams, Recipient, SettleParams, Status, VirtualStatus, Outpoint, VirtualCoin, TxKey, TapscriptType, ArkTxInput, OffchainTx, TapLeaves, IncomingFunds, IndexerProvider, PageResponse, BatchInfo, ChainTx, CommitmentTx, TxHistoryRecord, Vtxo, VtxoChain, Tx, OnchainProvider, ArkProvider, SettlementEvent, FeeInfo, ArkInfo, SignedIntent, Output, TxNotification, ExplorerTransaction, BatchFinalizationEvent, BatchFinalizedEvent, BatchFailedEvent, TreeSigningStartedEvent, TreeNoncesEvent, BatchStartedEvent, TreeTxEvent, TreeSignatureEvent, ScheduledSession, PaginationOptions, SubscriptionResponse, SubscriptionHeartbeat, SubscriptionEvent, Network, NetworkName, ArkTapscript, RelativeTimelock, EncodedVtxoScript, TapLeafScript, SignerSession, TreeNonces, TreePartialSigs, GetVtxosFilter, Nonces, PartialSig, ArkPsbtFieldCoder, TxTreeNode, AnchorBumper, };

package/dist/types/intent/index.d.ts

@@ -38,6 +38,7 @@ export declare namespace Intent {
      * @returns An unsigned Intent proof transaction
      */
     function create(message: string | Message, inputs: TransactionInput[], outputs?: TransactionOutput[]): Proof;
+    function fee(proof: Proof): number;
     type RegisterMessage = {
         type: "register";
         onchain_output_indexes: number[];

package/dist/types/providers/ark.d.ts

@@ -1,6 +1,7 @@
 import { TxTreeNode } from "../tree/txTree";
 import { TreeNonces, TreePartialSigs } from "../tree/signingSession";
 import { Vtxo } from "./indexer";
+import type { IntentFeeConfig } from "../arkfee";
 import { Intent } from "../intent";
 export type Output = {
     address: string;
@@ -73,14 +74,8 @@ export interface ScheduledSession {
     nextStartTime: bigint;
     period: bigint;
 }
-export interface IntentFeeInfo {
-    offchainInput: string;
-    offchainOutput: string;
-    onchainInput: bigint;
-    onchainOutput: bigint;
-}
 export interface FeeInfo {
-    intentFee: IntentFeeInfo;
+    intentFee: IntentFeeConfig;
     txFeeRate: string;
 }
 export interface PendingTx {
@@ -103,7 +98,7 @@ export interface ArkInfo {
     forfeitAddress: string;
     forfeitPubkey: string;
     network: string;
-    scheduledSession: ScheduledSession;
+    scheduledSession?: ScheduledSession;
     serviceStatus: ServiceStatus;
     sessionDuration: bigint;
     signerPubkey: string;

package/dist/types/utils/transactionHistory.d.ts

@@ -1,8 +1,15 @@
 import { ArkTransaction, VirtualCoin } from "../wallet";
+type ExtendedArkTransaction = ArkTransaction & {
+    tag: "offchain" | "boarding" | "exit" | "batch";
+};
 /**
- * @param spendable - Vtxos that are spendable
- * @param spent - Vtxos that are spent
- * @param boardingBatchTxids - Set of boarding batch txids
- * @returns Ark transactions
+ * Builds the transaction history by analyzing virtual coins (VTXOs), boarding transactions, and ignored commitments.
+ * History is sorted from newest to oldest and is composed only of SENT and RECEIVED transactions.
+ *
+ * @param {VirtualCoin[]} vtxos - An array of virtual coins representing the user's transactions and balances.
+ * @param {ArkTransaction[]} allBoardingTxs - An array of boarding transactions to include in the history.
+ * @param {Set<string>} commitmentsToIgnore - A set of commitment IDs that should be excluded from processing.
+ * @return {ExtendedArkTransaction[]} A sorted array of extended Ark transactions, representing the transaction history.
  */
-export declare function vtxosToTxs(spendable: VirtualCoin[], spent: VirtualCoin[], boardingBatchTxids: Set<string>): ArkTransaction[];
+export declare function buildTransactionHistory(vtxos: VirtualCoin[], allBoardingTxs: ArkTransaction[], commitmentsToIgnore: Set<string>, getTxCreatedAt?: (txid: string) => Promise<number>): Promise<ExtendedArkTransaction[]>;
+export {};

package/dist/types/wallet/index.d.ts

@@ -137,6 +137,7 @@ export interface SettleParams {
 }
 export interface Status {
     confirmed: boolean;
+    isLeaf?: boolean;
     block_height?: number;
     block_hash?: string;
     block_time?: number;

package/dist/types/wallet/ramps.d.ts

@@ -16,11 +16,12 @@ export declare class Ramps {
     /**
      * Onboard boarding utxos.
      *
+     * @param feeInfo - The fee info to deduct from the onboard amount.
      * @param boardingUtxos - The boarding utxos to onboard. If not provided, all boarding utxos will be used.
      * @param amount - The amount to onboard. If not provided, the total amount of boarding utxos will be onboarded.
      * @param eventCallback - The callback to receive settlement events. optional.
      */
-    onboard(boardingUtxos?: ExtendedCoin[], amount?: bigint, eventCallback?: (event: SettlementEvent) => void): ReturnType<IWallet["settle"]>;
+    onboard(feeInfo: FeeInfo, boardingUtxos?: ExtendedCoin[], amount?: bigint, eventCallback?: (event: SettlementEvent) => void): ReturnType<IWallet["settle"]>;
     /**
      * Offboard vtxos, or "collaborative exit" vtxos to onchain address.
      *

package/dist/types/wallet/serviceWorker/worker.d.ts

@@ -32,7 +32,6 @@ export declare class Worker {
      * Get all boarding utxos from wallet repository
      */
     private getAllBoardingUtxos;
-    private getTransactionHistory;
     start(withServiceWorkerUpdate?: boolean): Promise<void>;
     clear(): Promise<void>;
     reload(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/sdk",
-  "version": "0.3.10",
+  "version": "0.3.12",
   "description": "Bitcoin wallet SDK with Taproot and Ark integration",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -57,7 +57,8 @@
     "@noble/secp256k1": "3.0.0",
     "@scure/base": "2.0.0",
     "@scure/btc-signer": "2.0.1",
-    "bip68": "1.0.4"
+    "bip68": "1.0.4",
+    "@marcbachmann/cel-js": "7.0.0"
   },
   "devDependencies": {
     "@types/node": "24.3.1",