@bitgo-beta/babylonlabs-io-btc-staking-ts 0.4.0-alpha.57 → 0.4.0-alpha.59

package/README.md

@@ -1 +1 @@
-BitGo Fork of https://github.com/babylonlabs-io/btc-staking-ts/tree/v1.0.3
+BitGo Fork of https://github.com/babylonlabs-io/btc-staking-ts/tree/v0.4.0-rc.2

package/dist/index.cjs

@@ -1861,6 +1861,17 @@ var ObservableStaking = class extends Staking {
   }
 };
 
+// src/utils/babylon.ts
+var import_encoding = require("@cosmjs/encoding");
+var isValidBabylonAddress = (address4) => {
+  try {
+    const { prefix } = (0, import_encoding.fromBech32)(address4);
+    return prefix === "bbn";
+  } catch (error) {
+    return false;
+  }
+};
+
 // src/utils/staking/param.ts
 var getBabylonParamByBtcHeight = (height, babylonParamsVersions) => {
   const sortedParams = [...babylonParamsVersions].sort(
@@ -1903,17 +1914,6 @@ var reverseBuffer = (buffer) => {
   return clonedBuffer;
 };
 
-// src/utils/babylon.ts
-var import_encoding = require("@cosmjs/encoding");
-var isValidBabylonAddress = (address4) => {
-  try {
-    const { prefix } = (0, import_encoding.fromBech32)(address4);
-    return prefix === "bbn";
-  } catch (error) {
-    return false;
-  }
-};
-
 // src/staking/manager.ts
 var SigningStep = /* @__PURE__ */ ((SigningStep2) => {
   SigningStep2["STAKING_SLASHING"] = "staking-slashing";

package/dist/index.d.cts

@@ -578,6 +578,129 @@ export declare const getPublicKeyNoCoord: (pkHex: string) => String;
  * @returns {Buffer} - The transaction hash.
  */
 export declare const transactionIdToHash: (txId: string) => Buffer;
+/**
+ * Validates a Babylon address. Babylon addresses are encoded in Bech32 format
+ * and have a prefix of "bbn".
+ * @param address - The address to validate.
+ * @returns True if the address is valid, false otherwise.
+ */
+export declare const isValidBabylonAddress: (address: string) => boolean;
+export type TransactionOutput = {
+	scriptPubKey: Buffer;
+	value: number;
+};
+export interface OutputInfo {
+	scriptPubKey: Buffer;
+	outputAddress: string;
+}
+/**
+ * Build the staking output for the transaction which contains p2tr output
+ * with staking scripts.
+ *
+ * @param {StakingScripts} scripts - The staking scripts.
+ * @param {networks.Network} network - The Bitcoin network.
+ * @param {number} amount - The amount to stake.
+ * @returns {TransactionOutput[]} - The staking transaction outputs.
+ * @throws {Error} - If the staking output cannot be built.
+ */
+export declare const buildStakingTransactionOutputs: (scripts: {
+	timelockScript: Buffer;
+	unbondingScript: Buffer;
+	slashingScript: Buffer;
+	dataEmbedScript?: Buffer;
+}, network: networks.Network, amount: number) => TransactionOutput[];
+/**
+ * Derive the staking output address from the staking scripts.
+ *
+ * @param {StakingScripts} scripts - The staking scripts.
+ * @param {networks.Network} network - The Bitcoin network.
+ * @returns {StakingOutput} - The staking output address and scriptPubKey.
+ * @throws {StakingError} - If the staking output address cannot be derived.
+ */
+export declare const deriveStakingOutputInfo: (scripts: {
+	timelockScript: Buffer;
+	unbondingScript: Buffer;
+	slashingScript: Buffer;
+}, network: networks.Network) => {
+	outputAddress: string;
+	scriptPubKey: Buffer<ArrayBufferLike>;
+};
+/**
+ * Derive the unbonding output address and scriptPubKey from the staking scripts.
+ *
+ * @param {StakingScripts} scripts - The staking scripts.
+ * @param {networks.Network} network - The Bitcoin network.
+ * @returns {OutputInfo} - The unbonding output address and scriptPubKey.
+ * @throws {StakingError} - If the unbonding output address cannot be derived.
+ */
+export declare const deriveUnbondingOutputInfo: (scripts: {
+	unbondingTimelockScript: Buffer;
+	slashingScript: Buffer;
+}, network: networks.Network) => {
+	outputAddress: string;
+	scriptPubKey: Buffer<ArrayBufferLike>;
+};
+/**
+ * Derive the slashing output address and scriptPubKey from the staking scripts.
+ *
+ * @param {StakingScripts} scripts - The unbonding timelock scripts, we use the
+ * unbonding timelock script as the timelock of the slashing transaction.
+ * This is due to slashing tx timelock is the same as the unbonding timelock.
+ * @param {networks.Network} network - The Bitcoin network.
+ * @returns {OutputInfo} - The slashing output address and scriptPubKey.
+ * @throws {StakingError} - If the slashing output address cannot be derived.
+ */
+export declare const deriveSlashingOutput: (scripts: {
+	unbondingTimelockScript: Buffer;
+}, network: networks.Network) => {
+	outputAddress: string;
+	scriptPubKey: Buffer<ArrayBufferLike>;
+};
+/**
+ * Find the matching output index for the given transaction.
+ *
+ * @param {Transaction} tx - The transaction.
+ * @param {string} outputAddress - The output address.
+ * @param {networks.Network} network - The Bitcoin network.
+ * @returns {number} - The output index.
+ * @throws {Error} - If the matching output is not found.
+ */
+export declare const findMatchingTxOutputIndex: (tx: Transaction, outputAddress: string, network: networks.Network) => number;
+/**
+ * Validate the staking transaction input data.
+ *
+ * @param {number} stakingAmountSat - The staking amount in satoshis.
+ * @param {number} timelock - The staking time in blocks.
+ * @param {StakingParams} params - The staking parameters.
+ * @param {UTXO[]} inputUTXOs - The input UTXOs.
+ * @param {number} feeRate - The Bitcoin fee rate in sat/vbyte
+ * @throws {StakingError} - If the input data is invalid.
+ */
+export declare const validateStakingTxInputData: (stakingAmountSat: number, timelock: number, params: StakingParams, inputUTXOs: UTXO[], feeRate: number) => void;
+/**
+ * Validate the staking parameters.
+ * Extend this method to add additional validation for staking parameters based
+ * on the staking type.
+ * @param {StakingParams} params - The staking parameters.
+ * @throws {StakingError} - If the parameters are invalid.
+ */
+export declare const validateParams: (params: StakingParams) => void;
+/**
+ * Validate the staking timelock.
+ *
+ * @param {number} stakingTimelock - The staking timelock.
+ * @param {StakingParams} params - The staking parameters.
+ * @throws {StakingError} - If the staking timelock is invalid.
+ */
+export declare const validateStakingTimelock: (stakingTimelock: number, params: StakingParams) => void;
+/**
+ * toBuffers converts an array of strings to an array of buffers.
+ *
+ * @param {string[]} inputs - The input strings.
+ * @returns {Buffer[]} - The buffers.
+ * @throws {StakingError} - If the values cannot be converted to buffers.
+ */
+export declare const toBuffers: (inputs: string[]) => Buffer[];
 export declare const findInputUTXO: (inputUTXOs: UTXO[], input: Input) => UTXO;
 /**
  * Determines and constructs the correct PSBT input fields for a given UTXO based on its script type.
@@ -852,128 +975,5 @@ export declare class BabylonBtcStakingManager {
  * @returns The staker signature
  */
 export declare const getUnbondingTxStakerSignature: (unbondingTx: Transaction) => string;
-/**
- * Validates a Babylon address. Babylon addresses are encoded in Bech32 format
- * and have a prefix of "bbn".
- * @param address - The address to validate.
- * @returns True if the address is valid, false otherwise.
- */
-export declare const isValidBabylonAddress: (address: string) => boolean;
-export type TransactionOutput = {
-	scriptPubKey: Buffer;
-	value: number;
-};
-export interface OutputInfo {
-	scriptPubKey: Buffer;
-	outputAddress: string;
-}
-/**
- * Build the staking output for the transaction which contains p2tr output
- * with staking scripts.
- *
- * @param {StakingScripts} scripts - The staking scripts.
- * @param {networks.Network} network - The Bitcoin network.
- * @param {number} amount - The amount to stake.
- * @returns {TransactionOutput[]} - The staking transaction outputs.
- * @throws {Error} - If the staking output cannot be built.
- */
-export declare const buildStakingTransactionOutputs: (scripts: {
-	timelockScript: Buffer;
-	unbondingScript: Buffer;
-	slashingScript: Buffer;
-	dataEmbedScript?: Buffer;
-}, network: networks.Network, amount: number) => TransactionOutput[];
-/**
- * Derive the staking output address from the staking scripts.
- *
- * @param {StakingScripts} scripts - The staking scripts.
- * @param {networks.Network} network - The Bitcoin network.
- * @returns {StakingOutput} - The staking output address and scriptPubKey.
- * @throws {StakingError} - If the staking output address cannot be derived.
- */
-export declare const deriveStakingOutputInfo: (scripts: {
-	timelockScript: Buffer;
-	unbondingScript: Buffer;
-	slashingScript: Buffer;
-}, network: networks.Network) => {
-	outputAddress: string;
-	scriptPubKey: Buffer<ArrayBufferLike>;
-};
-/**
- * Derive the unbonding output address and scriptPubKey from the staking scripts.
- *
- * @param {StakingScripts} scripts - The staking scripts.
- * @param {networks.Network} network - The Bitcoin network.
- * @returns {OutputInfo} - The unbonding output address and scriptPubKey.
- * @throws {StakingError} - If the unbonding output address cannot be derived.
- */
-export declare const deriveUnbondingOutputInfo: (scripts: {
-	unbondingTimelockScript: Buffer;
-	slashingScript: Buffer;
-}, network: networks.Network) => {
-	outputAddress: string;
-	scriptPubKey: Buffer<ArrayBufferLike>;
-};
-/**
- * Derive the slashing output address and scriptPubKey from the staking scripts.
- *
- * @param {StakingScripts} scripts - The unbonding timelock scripts, we use the
- * unbonding timelock script as the timelock of the slashing transaction.
- * This is due to slashing tx timelock is the same as the unbonding timelock.
- * @param {networks.Network} network - The Bitcoin network.
- * @returns {OutputInfo} - The slashing output address and scriptPubKey.
- * @throws {StakingError} - If the slashing output address cannot be derived.
- */
-export declare const deriveSlashingOutput: (scripts: {
-	unbondingTimelockScript: Buffer;
-}, network: networks.Network) => {
-	outputAddress: string;
-	scriptPubKey: Buffer<ArrayBufferLike>;
-};
-/**
- * Find the matching output index for the given transaction.
- *
- * @param {Transaction} tx - The transaction.
- * @param {string} outputAddress - The output address.
- * @param {networks.Network} network - The Bitcoin network.
- * @returns {number} - The output index.
- * @throws {Error} - If the matching output is not found.
- */
-export declare const findMatchingTxOutputIndex: (tx: Transaction, outputAddress: string, network: networks.Network) => number;
-/**
- * Validate the staking transaction input data.
- *
- * @param {number} stakingAmountSat - The staking amount in satoshis.
- * @param {number} timelock - The staking time in blocks.
- * @param {StakingParams} params - The staking parameters.
- * @param {UTXO[]} inputUTXOs - The input UTXOs.
- * @param {number} feeRate - The Bitcoin fee rate in sat/vbyte
- * @throws {StakingError} - If the input data is invalid.
- */
-export declare const validateStakingTxInputData: (stakingAmountSat: number, timelock: number, params: StakingParams, inputUTXOs: UTXO[], feeRate: number) => void;
-/**
- * Validate the staking parameters.
- * Extend this method to add additional validation for staking parameters based
- * on the staking type.
- * @param {StakingParams} params - The staking parameters.
- * @throws {StakingError} - If the parameters are invalid.
- */
-export declare const validateParams: (params: StakingParams) => void;
-/**
- * Validate the staking timelock.
- *
- * @param {number} stakingTimelock - The staking timelock.
- * @param {StakingParams} params - The staking parameters.
- * @throws {StakingError} - If the staking timelock is invalid.
- */
-export declare const validateStakingTimelock: (stakingTimelock: number, params: StakingParams) => void;
-/**
- * toBuffers converts an array of strings to an array of buffers.
- *
- * @param {string[]} inputs - The input strings.
- * @returns {Buffer[]} - The buffers.
- * @throws {StakingError} - If the values cannot be converted to buffers.
- */
-export declare const toBuffers: (inputs: string[]) => Buffer[];
 
 export {};

package/dist/index.js

@@ -1788,6 +1788,17 @@ var ObservableStaking = class extends Staking {
   }
 };
 
+// src/utils/babylon.ts
+import { fromBech32 } from "@cosmjs/encoding";
+var isValidBabylonAddress = (address4) => {
+  try {
+    const { prefix } = fromBech32(address4);
+    return prefix === "bbn";
+  } catch (error) {
+    return false;
+  }
+};
+
 // src/utils/staking/param.ts
 var getBabylonParamByBtcHeight = (height, babylonParamsVersions) => {
   const sortedParams = [...babylonParamsVersions].sort(
@@ -1837,17 +1848,6 @@ var reverseBuffer = (buffer) => {
   return clonedBuffer;
 };
 
-// src/utils/babylon.ts
-import { fromBech32 } from "@cosmjs/encoding";
-var isValidBabylonAddress = (address4) => {
-  try {
-    const { prefix } = fromBech32(address4);
-    return prefix === "bbn";
-  } catch (error) {
-    return false;
-  }
-};
-
 // src/staking/manager.ts
 var SigningStep = /* @__PURE__ */ ((SigningStep2) => {
   SigningStep2["STAKING_SLASHING"] = "staking-slashing";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitgo-beta/babylonlabs-io-btc-staking-ts",
-  "version": "0.4.0-alpha.57",
+  "version": "0.4.0-alpha.59",
   "description": "Library exposing methods for the creation and consumption of Bitcoin transactions pertaining to Babylon's Bitcoin Staking protocol.",
   "module": "dist/index.js",
   "main": "dist/index.cjs",
@@ -45,5 +45,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cba7d0f0ebb708aed7ade6bdfdd226ddfafb6a1a"
+  "gitHead": "d11a6a5dde37cbaae12c871ddadfee7106ebbae9"
 }