@arkade-os/sdk 0.4.32 → 0.4.33

package/dist/contracts/handlers/index.d.ts

@@ -1,7 +1,7 @@
-export { D as DefaultContractHandler, a as DefaultContractParams, b as DelegateContractHandler, c as DelegateContractParams, d as VHTLCContractHandler, e as VHTLCContractParams, f as contractHandlers } from '../../index-BusKawmy.js';
-import '../../ark-ibLW4Hte.js';
+export { B as BoardingContractHandler, a as BoardingContractParams, D as DefaultContractHandler, b as DefaultContractParams, c as DelegateContractHandler, d as DelegateContractParams, e as VHTLCContractHandler, f as VHTLCContractParams, g as contractHandlers } from '../../index-BG2ooYKO.js';
+import '../../ark-DEsDMYGv.js';
 import '@scure/btc-signer/transaction.js';
 import '@scure/btc-signer/utils.js';
 import '@scure/btc-signer/psbt.js';
 import '@scure/btc-signer';
-import '../../delegate-BXaR1RNG.js';
+import '../../delegate-EXN2mfkb.js';

package/dist/contracts/handlers/index.js

@@ -1,4 +1,4 @@
-export { DefaultContractHandler, DelegateContractHandler, VHTLCContractHandler, contractHandlers } from '../../chunk-YA4G7RFB.js';
+export { BoardingContractHandler, DefaultContractHandler, DelegateContractHandler, VHTLCContractHandler, contractHandlers } from '../../chunk-AOJUURHM.js';
 import '../../chunk-TU3LVAPX.js';
 import '../../chunk-NSBPE2FW.js';
 //# sourceMappingURL=index.js.map

package/dist/{delegate-BvNTw44a.d.cts → delegate-BJeBNP5a.d.cts}

@@ -1,5 +1,5 @@
 import { Bytes } from '@scure/btc-signer/utils.js';
-import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript } from './ark-ibLW4Hte.cjs';
+import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript } from './ark-DEsDMYGv.cjs';
 
 /**
  * DefaultVtxo is the default implementation of a VtxoScript.
@@ -15,7 +15,7 @@ declare namespace DefaultVtxo {
     interface Options {
         pubKey: Bytes;
         serverPubKey: Bytes;
-        csvTimelock?: RelativeTimelock;
+        csvTimelock: RelativeTimelock;
     }
     /**
      * DefaultVtxo.Script is the class letting to create the vtxo script.
@@ -24,6 +24,10 @@ declare namespace DefaultVtxo {
      * const vtxoScript = new DefaultVtxo.Script({
      *     pubKey: new Uint8Array(32),
      *     serverPubKey: new Uint8Array(32),
+     *     csvTimelock: {
+     *         value: 605184n,
+     *         type: "seconds"
+     *     }
      * });
      *
      * console.log("script pub key:", vtxoScript.pkScript)
@@ -61,6 +65,10 @@ declare namespace DelegateVtxo {
      *     pubKey: new Uint8Array(32),
      *     serverPubKey: new Uint8Array(32),
      *     delegatePubKey: new Uint8Array(32),
+     *     csvTimelock: {
+     *         value: 605184n,
+     *         type: "seconds"
+     *     }
      * });
      *
      * console.log("script pub key:", vtxoScript.pkScript)

package/dist/{delegate-BXaR1RNG.d.ts → delegate-EXN2mfkb.d.ts}

@@ -1,5 +1,5 @@
 import { Bytes } from '@scure/btc-signer/utils.js';
-import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript } from './ark-ibLW4Hte.js';
+import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript } from './ark-DEsDMYGv.js';
 
 /**
  * DefaultVtxo is the default implementation of a VtxoScript.
@@ -15,7 +15,7 @@ declare namespace DefaultVtxo {
     interface Options {
         pubKey: Bytes;
         serverPubKey: Bytes;
-        csvTimelock?: RelativeTimelock;
+        csvTimelock: RelativeTimelock;
     }
     /**
      * DefaultVtxo.Script is the class letting to create the vtxo script.
@@ -24,6 +24,10 @@ declare namespace DefaultVtxo {
      * const vtxoScript = new DefaultVtxo.Script({
      *     pubKey: new Uint8Array(32),
      *     serverPubKey: new Uint8Array(32),
+     *     csvTimelock: {
+     *         value: 605184n,
+     *         type: "seconds"
+     *     }
      * });
      *
      * console.log("script pub key:", vtxoScript.pkScript)
@@ -61,6 +65,10 @@ declare namespace DelegateVtxo {
      *     pubKey: new Uint8Array(32),
      *     serverPubKey: new Uint8Array(32),
      *     delegatePubKey: new Uint8Array(32),
+     *     csvTimelock: {
+     *         value: 605184n,
+     *         type: "seconds"
+     *     }
      * });
      *
      * console.log("script pub key:", vtxoScript.pkScript)

package/dist/{index-BusKawmy.d.ts → index-BG2ooYKO.d.ts}

@@ -1,5 +1,5 @@
-import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript, aM as ContractHandler, aV as Discoverable } from './ark-ibLW4Hte.js';
-import { D as DefaultVtxo, a as DelegateVtxo } from './delegate-BXaR1RNG.js';
+import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript, aN as ContractHandler, aW as Discoverable } from './ark-DEsDMYGv.js';
+import { D as DefaultVtxo, a as DelegateVtxo } from './delegate-EXN2mfkb.js';
 import { Bytes } from '@scure/btc-signer/utils.js';
 
 /** Virtual Hash Time Lock Contract (VHTLC) namespace. */
@@ -196,4 +196,58 @@ interface VHTLCContractParams {
  */
 declare const VHTLCContractHandler: ContractHandler<VHTLCContractParams, VHTLC.Script>;
 
-export { DefaultContractHandler as D, VHTLC as V, type DefaultContractParams as a, DelegateContractHandler as b, type DelegateContractParams as c, VHTLCContractHandler as d, type VHTLCContractParams as e, contractHandlers as f };
+/**
+ * Typed parameters for boarding contracts.
+ *
+ * Boarding reuses the exact `default` contract parameter shape
+ * (`pubKey` / `serverPubKey` / `csvTimelock`) rather than inventing
+ * boarding-specific names — the boarding semantics come from the
+ * contract type and from populating `csvTimelock` with the server's
+ * boarding-exit delay (`ArkInfo.boardingExitDelay`) instead of the
+ * offchain unilateral-exit delay.
+ */
+type BoardingContractParams = DefaultContractParams;
+/**
+ * Handler for the boarding contract (registered type `boarding`).
+ *
+ * The boarding contract derives the on-chain Bitcoin address used to
+ * board funds onto Arkade. It shares the exact `DefaultVtxo.Script`
+ * shape with the `default` contract — a Taproot output co-owned by the
+ * wallet and the Ark server, with a CSV exit path back to the wallet —
+ * and therefore reuses the `default` handler's path logic (forfeit via
+ * server cooperation, exit after the boarding CSV).
+ *
+ * Boarding semantics come entirely from the contract type and from
+ * sourcing the CSV timelock from the server's boarding-exit delay
+ * (`ArkInfo.boardingExitDelay`), not from renamed parameters. The
+ * offchain `default` contract is built from `ArkInfo.unilateralExitDelay`
+ * instead, so the two share a script shape but differ in their CSV
+ * timelock value. Parameters round-trip through the same
+ * `timelockToSequence` / `sequenceToTimelock` helpers and BIP68 sequence
+ * encoding as `default` / `delegate`.
+ *
+ * Unlike `default` / `delegate`, the boarding handler deliberately does
+ * **not** implement {@link Discoverable.discoverAt}: branch/index
+ * selection for HD wallets is owned by the wallet / address-provider
+ * layer, which hands this handler an already-derived pubkey. As a result
+ * `isDiscoverable(BoardingContractHandler)` is `false`.
+ *
+ * Identity & the default/boarding collision: a contract's `script` (pkScript)
+ * is its unique identity — a script owns exactly one repository row. `boarding`
+ * is a first-class type with its own row **when its script is distinct** from
+ * the wallet's `default` baseline — the real-world case, since a sound Ark
+ * server keeps boardingExitDelay strictly longer than unilateralExitDelay (equal
+ * delays would expose the provider to a double-spend). Should those delays ever
+ * coincide (a misconfigured/malicious server), the boarding script is
+ * byte-identical to the default script and the wallet coalesces the single
+ * shared row onto the `default` type ("default wins"; see `ensureWalletContract`)
+ * rather than persisting a second row. Either way the funds are equally spendable
+ * through the shared `DefaultVtxo.Script` paths. Consumers must NOT rely on
+ * `contract.type === "boarding"` to identify the boarding purpose — resolve the
+ * boarding script via `wallet.getBoardingAddress()` / `wallet.boardingTapscript`
+ * (which never depend on the persisted contract's type) and match by script when
+ * needed.
+ */
+declare const BoardingContractHandler: ContractHandler<BoardingContractParams, DefaultVtxo.Script>;
+
+export { BoardingContractHandler as B, DefaultContractHandler as D, VHTLC as V, type BoardingContractParams as a, type DefaultContractParams as b, DelegateContractHandler as c, type DelegateContractParams as d, VHTLCContractHandler as e, type VHTLCContractParams as f, contractHandlers as g };

package/dist/{index-C-5Tw7VA.d.cts → index-DHjEeHEp.d.cts}

@@ -1,5 +1,5 @@
-import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript, aM as ContractHandler, aV as Discoverable } from './ark-ibLW4Hte.cjs';
-import { D as DefaultVtxo, a as DelegateVtxo } from './delegate-BvNTw44a.cjs';
+import { o as RelativeTimelock, V as VtxoScript, p as TapLeafScript, aN as ContractHandler, aW as Discoverable } from './ark-DEsDMYGv.cjs';
+import { D as DefaultVtxo, a as DelegateVtxo } from './delegate-BJeBNP5a.cjs';
 import { Bytes } from '@scure/btc-signer/utils.js';
 
 /** Virtual Hash Time Lock Contract (VHTLC) namespace. */
@@ -196,4 +196,58 @@ interface VHTLCContractParams {
  */
 declare const VHTLCContractHandler: ContractHandler<VHTLCContractParams, VHTLC.Script>;
 
-export { DefaultContractHandler as D, VHTLC as V, type DefaultContractParams as a, DelegateContractHandler as b, type DelegateContractParams as c, VHTLCContractHandler as d, type VHTLCContractParams as e, contractHandlers as f };
+/**
+ * Typed parameters for boarding contracts.
+ *
+ * Boarding reuses the exact `default` contract parameter shape
+ * (`pubKey` / `serverPubKey` / `csvTimelock`) rather than inventing
+ * boarding-specific names — the boarding semantics come from the
+ * contract type and from populating `csvTimelock` with the server's
+ * boarding-exit delay (`ArkInfo.boardingExitDelay`) instead of the
+ * offchain unilateral-exit delay.
+ */
+type BoardingContractParams = DefaultContractParams;
+/**
+ * Handler for the boarding contract (registered type `boarding`).
+ *
+ * The boarding contract derives the on-chain Bitcoin address used to
+ * board funds onto Arkade. It shares the exact `DefaultVtxo.Script`
+ * shape with the `default` contract — a Taproot output co-owned by the
+ * wallet and the Ark server, with a CSV exit path back to the wallet —
+ * and therefore reuses the `default` handler's path logic (forfeit via
+ * server cooperation, exit after the boarding CSV).
+ *
+ * Boarding semantics come entirely from the contract type and from
+ * sourcing the CSV timelock from the server's boarding-exit delay
+ * (`ArkInfo.boardingExitDelay`), not from renamed parameters. The
+ * offchain `default` contract is built from `ArkInfo.unilateralExitDelay`
+ * instead, so the two share a script shape but differ in their CSV
+ * timelock value. Parameters round-trip through the same
+ * `timelockToSequence` / `sequenceToTimelock` helpers and BIP68 sequence
+ * encoding as `default` / `delegate`.
+ *
+ * Unlike `default` / `delegate`, the boarding handler deliberately does
+ * **not** implement {@link Discoverable.discoverAt}: branch/index
+ * selection for HD wallets is owned by the wallet / address-provider
+ * layer, which hands this handler an already-derived pubkey. As a result
+ * `isDiscoverable(BoardingContractHandler)` is `false`.
+ *
+ * Identity & the default/boarding collision: a contract's `script` (pkScript)
+ * is its unique identity — a script owns exactly one repository row. `boarding`
+ * is a first-class type with its own row **when its script is distinct** from
+ * the wallet's `default` baseline — the real-world case, since a sound Ark
+ * server keeps boardingExitDelay strictly longer than unilateralExitDelay (equal
+ * delays would expose the provider to a double-spend). Should those delays ever
+ * coincide (a misconfigured/malicious server), the boarding script is
+ * byte-identical to the default script and the wallet coalesces the single
+ * shared row onto the `default` type ("default wins"; see `ensureWalletContract`)
+ * rather than persisting a second row. Either way the funds are equally spendable
+ * through the shared `DefaultVtxo.Script` paths. Consumers must NOT rely on
+ * `contract.type === "boarding"` to identify the boarding purpose — resolve the
+ * boarding script via `wallet.getBoardingAddress()` / `wallet.boardingTapscript`
+ * (which never depend on the persisted contract's type) and match by script when
+ * needed.
+ */
+declare const BoardingContractHandler: ContractHandler<BoardingContractParams, DefaultVtxo.Script>;
+
+export { BoardingContractHandler as B, DefaultContractHandler as D, VHTLC as V, type BoardingContractParams as a, type DefaultContractParams as b, DelegateContractHandler as c, type DelegateContractParams as d, VHTLCContractHandler as e, type VHTLCContractParams as f, contractHandlers as g };