@bestinslot/wallet-kit 0.7.0

package/dist/types/types/inscription.d.ts

@@ -0,0 +1,147 @@
+import { Buff } from '@cmdcode/buff-utils';
+/**
+ * Class representing the details of an inscription to be minted. This class is used to encapsulate
+ * the various properties of an inscription, such as its MIME type, metadata, metaprotocol, content
+ * encoding, delegate, and file data. Each property is optional and can be null. The constructor
+ * validates the types of the properties to ensure they are either Buff instances or null.
+ *
+ * @class InscriptionDetails
+ *
+ * @property {Buff|null} mime_type - The MIME type of the inscription content, or null if not specified.
+ * @property {Buff|null} metadata - Additional metadata associated with the inscription, or null if not specified.
+ * @property {Buff|null} metaprotocol - The metaprotocol information for the inscription, or null if not specified.
+ * @property {Buff|null} content_encoding - The content encoding used for the inscription, or null if not specified.
+ * @property {Buff|null} delegate - The delegate information for the inscription, or null if not specified.
+ * @property {Buff|null} file_data - The actual file data to be inscribed, or null if not specified.
+ */
+export declare class InscriptionDetails {
+    mimeType: Buff | null;
+    metadata: Buff | null;
+    metaprotocol: Buff | null;
+    contentEncoding: Buff | null;
+    delegate: Buff | null;
+    data: Buff | null;
+    /**
+     * Creates an instance of InscriptionDetails.
+     *
+     * @param {Buff|null} mimeType - The MIME type of the inscription content, or null if not specified.
+     * @param {Buff|null} metadata - Additional metadata associated with the inscription, or null if not specified.
+     * @param {Buff|null} metaprotocol - The metaprotocol information for the inscription, or null if not specified.
+     * @param {Buff|null} contentEncoding - The content encoding used for the inscription, or null if not specified.
+     * @param {Buff|null} delegate - The delegate information for the inscription, or null if not specified.
+     * @param {Buff|null} data - The actual file data to be inscribed, or null if not specified.
+     * @throws {Error} Throws an error if any of the parameters are not of type Buff or null.
+     * @returns {InscriptionDetails} An instance of the InscriptionDetails class.
+     * @example
+     *  const inscriptionDetails = new InscriptionDetails(
+     *    Buff.from('text/plain'),
+     *    Buff.from('{"name": "My Inscription", "description": "This is an example inscription."}'),
+     *    Buff.from('my-metaprotocol'),
+     *    Buff.from('utf-8'),
+     *    Buff.from('delegate-info'),
+     *    Buff.from('file data to be inscribed'),
+     *  );
+     */
+    constructor(mimeType: Buff | null, metadata: Buff | null, metaprotocol: Buff | null, contentEncoding: Buff | null, delegate: Buff | null, data: Buff | null);
+}
+/**
+ * Helper function to create an InscriptionDetails instance for a JSON file. This function takes a Buff
+ * containing JSON data and returns an InscriptionDetails instance with the appropriate MIME type, content
+ * encoding, and file data set. The metadata, metaprotocol, and delegate properties are set to null.
+ *
+ * @param {any} jsonData - The JSON data to be inscribed.
+ * @returns {InscriptionDetails} An instance of the InscriptionDetails class with the JSON data set for inscription.
+ */
+export declare function jsonInscription(jsonData: any): InscriptionDetails;
+/**
+ * Helper function to create an InscriptionDetails instance for a text file. This function takes a string
+ * containing the text data and returns an InscriptionDetails instance with the appropriate MIME type, content
+ * encoding, and file data set. The metadata, metaprotocol, and delegate properties are set to null.
+ *
+ * @param {string} text - A string containing the text data to be inscribed.
+ * @returns {InscriptionDetails} An instance of the InscriptionDetails class with the text data set for inscription.
+ */
+export declare function textInscription(text: string): InscriptionDetails;
+/**
+ * Helper function to create an InscriptionDetails instance for a delegated inscription. This function takes an inscription ID
+ * and returns an InscriptionDetails instance with the delegate property set to the provided inscription ID. The MIME type, metadata,
+ * metaprotocol, content encoding, and file data properties are set to null.
+ *
+ * @param inscriptionId - A string representing the inscription ID to delegate to.
+ * @returns An instance of the InscriptionDetails class with the delegate property set.
+ */
+export declare function delegateInscription(inscriptionId: string): InscriptionDetails;
+/**
+ * Inscribe fees for a single inscription, including total fee, commit fee, reveal fee, postage, and secret.
+ *
+ * @interface InscribeFees
+ * @property {number} totalFee - The total fee in satoshis for the inscription process, including both commit and reveal transactions.
+ * @property {number} commitFee - The fee in satoshis for the commit transaction that initiates the inscription process.
+ * @property {number} revealFee - The fee in satoshis for the reveal transaction that completes the inscription process.
+ * @property {number} postage - The amount of postage in satoshis included in the inscription transactions, which indicates the size of the utxo that holds the inscription.
+ * @property {string} secret - A secret token used during the inscription process, which may be required for certain operations related to the inscription.
+ */
+export interface InscribeFees {
+    totalFee: number;
+    commitFee: number;
+    revealFee: number;
+    postage: number;
+    secret: string;
+}
+/**
+ * Result of an inscription minting process, including commit transaction ID, signed commit transaction hex, reveal transaction ID, signed reveal transaction hex, inscription ID, postage used, and the secret token used for minting.
+ *
+ * @interface InscribeResult
+ * @property {string} commitTxId - The transaction ID of the commit transaction that initiated the inscription process.
+ * @property {string} signedCommitTxHex - The signed transaction hex of the commit transaction, which can be used for broadcasting or record-keeping purposes.
+ * @property {string} revealTxId - The transaction ID of the reveal transaction that completed the inscription process and revealed the inscription on the blockchain.
+ * @property {string} signedRevealTxHex - The signed transaction hex of the reveal transaction, which can be used for broadcasting or record-keeping purposes.
+ * @property {string} inscriptionId - The unique identifier of the newly minted inscription, which can be used to reference and interact with the inscription in future operations.
+ * @property {number} postage - The amount of postage in satoshis that was included in the inscription transactions, which indicates the cost paid for inscribing the content on the blockchain.
+ * @property {string} secret - The secret token used during the inscription process, which may be required for certain operations related to the inscription.
+ */
+export interface InscribeResult {
+    commitTxId: string;
+    signedCommitTxHex: string;
+    revealTxId: string;
+    signedRevealTxHex: string;
+    inscriptionId: string;
+    postage: number;
+    secret: string;
+}
+/**
+ * Inscribe multiple inscriptions result, including commit transaction ID, signed commit transaction hex, reveal transaction ID, signed reveal transaction hex, an array of inscription IDs, postage used, and the secret token used for minting.
+ *
+ * @interface InscribeMultipleResult
+ * @property {string} commitTxId - The transaction ID of the commit transaction that initiated the inscription process for multiple inscriptions.
+ * @property {string} signedCommitTxHex - The signed transaction hex of the commit transaction, which can be used for broadcasting or record-keeping purposes.
+ * @property {string} revealTxId - The transaction ID of the reveal transaction that completed the inscription process for multiple inscriptions.
+ * @property {string} signedRevealTxHex - The signed transaction hex of the reveal transaction, which can be used for broadcasting or record-keeping purposes.
+ * @property {string[]} inscriptionIds - An array of strings representing the IDs of the inscriptions that were minted in this batch process.
+ * @property {number} postage - The amount of postage in satoshis that was included in the inscription transactions, which indicates the cost associated with minting the inscriptions.
+ * @property {string} secret - A secret token used during the inscription process, which may be required
+ */
+export interface InscribeMultipleResult {
+    commitTxId: string;
+    signedCommitTxHex: string;
+    revealTxId: string;
+    signedRevealTxHex: string;
+    inscriptionIds: string[];
+    postage: number;
+    secret: string;
+}
+/**
+ * Result of sending an inscription, including the transaction ID of the send transaction, the signed transaction hex, the vout index of the output containing the inscription, and the value of that output in satoshis.
+ *
+ * @interface SendInscriptionResult
+ * @property {string} txId - The transaction ID of the send transaction that transferred the inscription to its new location.
+ * @property {string} signedTxHex - The signed transaction hex of the send transaction, which can be used for broadcasting or record-keeping purposes.
+ * @property {number} vout - The index of the output in the send transaction that contains the inscription after it has been transferred.
+ * @property {number} outputValue - The value of the output containing the inscription in satoshis, which indicates the amount of Bitcoin associated with the inscription after it has been sent.
+ */
+export interface SendInscriptionResult {
+    txId: string;
+    signedTxHex: string;
+    vout: number;
+    outputValue: number;
+}

package/dist/types/types/vite-env.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="vite/client" />
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue'
+
+  const component: DefineComponent<object, object, any>
+  export default component
+}

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

@@ -0,0 +1,50 @@
+import { Buffer } from 'node:buffer';
+/**
+ * Class representing wallet information for a Bitcoin address. This class is used to encapsulate the properties of a wallet, such as its address,
+ * redeem script, whether it is an OP_RETURN output, the output script, and the public key. The constructor validates the properties and sets the output
+ * script based on the provided address and output script. The class also includes a method to retrieve the redeem script, which can be derived from the public key if not provided.
+ *
+ * @class WalletInfo
+ * @property {string|null|undefined} addr - The Bitcoin address associated with the wallet, or null/undefined if not specified.
+ * @property {Buffer|null} redeemScript - The redeem script for the wallet, or null if not specified.
+ * @property {boolean} is_op_return - A boolean indicating whether the wallet is an OP_RETURN output.
+ * @property {Buffer} outputScript - The output script for the wallet, derived from the address or provided directly.
+ * @property {string|null} publicKey - The public key associated with the wallet, or null if not specified.
+ */
+export declare class WalletInfo {
+    addr: string | null | undefined;
+    redeemScript: Buffer | null;
+    isOpReturn: boolean;
+    outputScript: Buffer;
+    publicKey: string | null;
+    /**
+     * Creates an instance of WalletInfo.
+     *
+     * @param {boolean} isOpReturn - A boolean indicating whether the wallet is an OP_RETURN output.
+     * @param {Buffer|null} outputScript - The output script for the wallet, or null if it should be derived from the address.
+     * @param {string|null|undefined} addr - The Bitcoin address associated with the wallet, or null/undefined if not specified.
+     * @param {Buffer|null} redeemScript - The redeem script for the wallet, or null if not specified.
+     * @param {string|null} publicKey - The public key associated with the wallet, or null if not specified.
+     */
+    constructor(isOpReturn: boolean, outputScript: Buffer | null, addr: string | null | undefined, redeemScript: Buffer | null, publicKey: string | null);
+    /**
+     * Get the redeem script for the wallet. If the redeem script is already set, it returns the cached redeem script. If not, it derives the redeem script from the public key.
+     *
+     * @returns {Buffer} The redeem script for the wallet.
+     */
+    getRedeemScript(): Buffer;
+}
+/**
+ * Utility function to create a WalletInfo instance for an OP_RETURN output. This function takes an output script as input and returns a WalletInfo instance with the isOpReturn property set to true.
+ *
+ * @param outputScript - The output script for the OP_RETURN output, provided as a Buffer.
+ * @returns {WalletInfo} A WalletInfo instance representing the OP_RETURN output.
+ */
+export declare function opReturnWalletInfo(outputScript: Buffer): WalletInfo;
+/**
+ * Utility function to create a WalletInfo instance for a standard Bitcoin address. This function takes a Bitcoin address as input and returns a WalletInfo instance with the isOpReturn property set to false and the output script derived from the address.
+ *
+ * @param addr - The Bitcoin address for which to create the WalletInfo instance, provided as a string.
+ * @returns {WalletInfo} A WalletInfo instance representing the standard Bitcoin address.
+ */
+export declare function addressWalletInfo(addr: string): WalletInfo;

package/dist/types/vue.d.ts

@@ -0,0 +1,2 @@
+export { useNetwork } from './adapters/vue/use-network';
+export type { BISNetwork, BISSession, BISWallet, BISWalletProvider } from './types/common';

package/dist/vue.js

@@ -0,0 +1,13 @@
+import { ref as s, onScopeDispose as i, watch as u } from "vue";
+import { d as r, w as c, i as w } from "./mint-BXVHw4CQ.js";
+function n() {
+  const e = s(r()), t = c((o) => {
+    e.value !== o && (e.value = o);
+  });
+  return i(t, !0), u(e, (o) => {
+    o !== r() && w(o);
+  }), e;
+}
+export {
+  n as useNetwork
+};

package/package.json

@@ -0,0 +1,133 @@
+{
+  "name": "@bestinslot/wallet-kit",
+  "type": "module",
+  "version": "0.7.0",
+  "private": false,
+  "description": "A lightweight JavaScript library for connecting Bitcoin wallets with a unified API.",
+  "exports": {
+    ".": {
+      "node": {
+        "types": "./dist/types/node.d.ts",
+        "import": "./dist/node.js"
+      },
+      "browser": {
+        "types": "./dist/types/browser.d.ts",
+        "import": "./dist/browser.js"
+      },
+      "default": {
+        "types": "./dist/types/browser.d.ts",
+        "import": "./dist/browser.js"
+      }
+    },
+    "./node": {
+      "types": "./dist/types/node.d.ts",
+      "import": "./dist/node.js"
+    },
+    "./browser": {
+      "types": "./dist/types/browser.d.ts",
+      "import": "./dist/browser.js"
+    },
+    "./core": {
+      "types": "./dist/types/core.d.ts",
+      "import": "./dist/core.js"
+    },
+    "./react": {
+      "types": "./dist/types/react.d.ts",
+      "import": "./dist/react.js"
+    },
+    "./vue": {
+      "types": "./dist/types/vue.d.ts",
+      "import": "./dist/vue.js"
+    }
+  },
+  "module": "dist/browser.js",
+  "types": "dist/types/browser.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "react": ">=18",
+    "vue": "^3.5.13"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@bestinslot/nada": "^0.1.6",
+    "@bitcoinerlab/secp256k1": "^1.2.0",
+    "@bokuweb/zstd-wasm": "^0.0.27",
+    "@cmdcode/buff-utils": "^2.0.0",
+    "@cmdcode/crypto-tools": "^2.8.0",
+    "@cmdcode/tapscript": "1.5.3",
+    "@noble/curves": "2.0.1",
+    "@noble/hashes": "2.0.1",
+    "@noble/secp256k1": "^3.0.0",
+    "base64-arraybuffer": "^1.0.2",
+    "bip322-js": "^3.0.0",
+    "bitcoinjs-lib": "^6.1.7",
+    "bitcoinjs-message": "^2.2.0",
+    "cbor2": "^1.12.0",
+    "ecpair": "^3.0.0",
+    "ethers": "^6.16.0",
+    "tiny-secp256k1": "^2.2.4",
+    "varuint-bitcoin": "^2.0.0",
+    "web3": "^4.16.0"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^6.7.3",
+    "@leather-wallet/types": "^0.2.1",
+    "@tailwindcss/vite": "^4.1.18",
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.2.17",
+    "@vitejs/plugin-vue": "^6.0.3",
+    "@vue/tsconfig": "^0.8.1",
+    "@vueuse/core": "^14.1.0",
+    "clsx": "^2.1.1",
+    "dotenv": "^17.3.1",
+    "eslint": "^9.39.2",
+    "eslint-plugin-jsdoc": "^62.6.1",
+    "jsdom": "^29.1.1",
+    "prettier": "^3.8.1",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "solc": "^0.8.33",
+    "tailwind-merge": "^3.4.0",
+    "tailwindcss": "^4.1.18",
+    "ts-morph": "^27.0.2",
+    "typedoc": "^0.28.17",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vite-plugin-node-polyfills": "^0.24.0",
+    "vite-plugin-wasm": "^3.5.0",
+    "vitest": "^4.0.18",
+    "vue": "^3.5.13",
+    "vue-tsc": "^3.2.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc -b && vite build",
+    "build:debug": "vue-tsc -b && vite build --minify=false",
+    "preview": "vite preview",
+    "lint": "eslint",
+    "lint:fix": "prettier --write . && eslint --fix",
+    "test": "vitest run",
+    "verify:bundles": "node scripts/verify-build-flavours.mjs",
+    "test:signet": "vitest run tests/signet/ --config vitest.signet.config.ts",
+    "test:mainnet": "vitest run tests/mainnet/ --config vitest.mainnet.config.ts",
+    "docs:api": "typedoc",
+    "examples:install": "pnpm install",
+    "examples:build": "pnpm build && pnpm -r --filter \"./examples/*\" build",
+    "example:react": "pnpm build && pnpm --filter example-react dev",
+    "example:vue": "pnpm build && pnpm --filter example-vue dev",
+    "example:vanilla": "pnpm build && pnpm --filter example-vanillajs dev"
+  }
+}