@btc-vision/wallet-sdk 1.0.0

package/lib/src/network/index.d.ts

@@ -0,0 +1,14 @@
+import { bitcoin } from '../bitcoin-core';
+export declare enum NetworkType {
+    MAINNET = 0,
+    TESTNET = 1,
+    REGTEST = 2
+}
+/**
+ * Convert network type to bitcoinjs-lib network.
+ */
+export declare function toPsbtNetwork(networkType: NetworkType): bitcoin.networks.Network;
+/**
+ * Convert bitcoinjs-lib network to network type.
+ */
+export declare function toNetworkType(network: bitcoin.Network): NetworkType;

package/lib/src/runes/index.d.ts

@@ -0,0 +1 @@
+export * from './varint';

package/lib/src/runes/rund_id.d.ts

@@ -0,0 +1,11 @@
+export declare class RuneId {
+    block: number;
+    tx: number;
+    constructor({ block, tx }: {
+        block: number;
+        tx: number;
+    });
+    static fromBigInt(n: any): RuneId;
+    toString(): string;
+    static fromString(s: string): RuneId;
+}

package/lib/src/runes/varint.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+declare function try_decode(buf: any): (string | number)[];
+declare function encodeToVec(n: any, v: any): void;
+declare function decode(buffer: any): {
+    num: string | number;
+    index: string | number;
+};
+declare function encode(n: any): Buffer;
+export declare const varint: {
+    encode: typeof encode;
+    decode: typeof decode;
+    try_decode: typeof try_decode;
+    encodeToVec: typeof encodeToVec;
+};
+export {};

package/lib/src/transaction/index.d.ts

@@ -0,0 +1,3 @@
+export * from './inscription-utxo';
+export * from './transaction';
+export * from './utxo';

package/lib/src/transaction/inscription-utxo.d.ts

@@ -0,0 +1,33 @@
+import { UnspentOutput } from '../types';
+export declare class InscriptionUnit {
+    satoshis: number;
+    inscriptions: {
+        id: string;
+        outputOffset: number;
+        unitOffset: number;
+    }[];
+    constructor(satoshis: number, inscriptions: {
+        id: string;
+        outputOffset: number;
+        unitOffset: number;
+    }[]);
+    hasInscriptions(): boolean;
+}
+export declare class InscriptionUnspendOutput {
+    inscriptionUnits: InscriptionUnit[];
+    utxo: UnspentOutput;
+    constructor(utxo: UnspentOutput, outputValue?: number);
+    private split;
+    /**
+     * Get non-Ord satoshis for spending
+     */
+    getNonInscriptionSatoshis(): number;
+    /**
+     * Get last non-ord satoshis for spending.
+     * Only the last one is available
+     * @returns
+     */
+    getLastUnitSatoshis(): number;
+    hasInscriptions(): boolean;
+    dump(): void;
+}

package/lib/src/transaction/transaction.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+import { bitcoin } from '../bitcoin-core';
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+interface TxOutput {
+    address?: string;
+    script?: Buffer;
+    value: number;
+}
+/**
+ * Transaction
+ */
+export declare class Transaction {
+    private utxos;
+    private inputs;
+    outputs: TxOutput[];
+    private changeOutputIndex;
+    changedAddress: string;
+    private networkType;
+    private feeRate;
+    private enableRBF;
+    private _cacheNetworkFee;
+    private _cacheBtcUtxos;
+    private _cacheToSignInputs;
+    constructor();
+    setNetworkType(network: NetworkType): void;
+    setEnableRBF(enable: boolean): void;
+    setFeeRate(feeRate: number): void;
+    setChangeAddress(address: string): void;
+    addInput(utxo: UnspentOutput): void;
+    removeLastInput(): void;
+    getTotalInput(): number;
+    getTotalOutput(): number;
+    getUnspent(): number;
+    calNetworkFee(): Promise<number>;
+    addOutput(address: string, value: number): void;
+    addOpreturn(data: Buffer[]): void;
+    addScriptOutput(script: Buffer, value: number): void;
+    getOutput(index: number): TxOutput;
+    addChangeOutput(value: number): void;
+    getChangeOutput(): TxOutput;
+    getChangeAmount(): number;
+    removeChangeOutput(): void;
+    removeRecentOutputs(count: number): void;
+    toPsbt(): bitcoin.Psbt;
+    clone(): Transaction;
+    createEstimatePsbt(): Promise<bitcoin.Psbt>;
+    private selectBtcUtxos;
+    addSufficientUtxosForFee(btcUtxos: UnspentOutput[], forceAsFee?: boolean): Promise<ToSignInput[]>;
+    dumpTx(psbt: any): Promise<void>;
+}
+export {};

package/lib/src/transaction/utxo.d.ts

@@ -0,0 +1,35 @@
+import { NetworkType } from '../network';
+import { AddressType, UnspentOutput } from '../types';
+declare function hasInscription(utxos: UnspentOutput[]): boolean;
+declare function hasAtomicalsFT(utxos: UnspentOutput[]): boolean;
+declare function hasAtomicalsNFT(utxos: UnspentOutput[]): boolean;
+declare function hasAtomicals(utxos: UnspentOutput[]): boolean;
+declare function hasAnyAssets(utxos: UnspentOutput[]): boolean;
+/**
+ * select utxos so that the total amount of utxos is greater than or equal to targetAmount
+ * return the selected utxos and the unselected utxos
+ * @param utxos
+ * @param targetAmount
+ */
+declare function selectBtcUtxos(utxos: UnspentOutput[], targetAmount: number): {
+    selectedUtxos: UnspentOutput[];
+    remainingUtxos: UnspentOutput[];
+};
+/**
+ * return the added virtual size of the utxo
+ */
+declare function getAddedVirtualSize(addressType: AddressType): number;
+export declare function getUtxoDust(addressType: AddressType): 546 | 294 | 330;
+export declare function getAddressUtxoDust(address: string, networkType?: NetworkType): number;
+export declare const utxoHelper: {
+    hasAtomicalsFT: typeof hasAtomicalsFT;
+    hasAtomicalsNFT: typeof hasAtomicalsNFT;
+    hasAtomicals: typeof hasAtomicals;
+    hasInscription: typeof hasInscription;
+    hasAnyAssets: typeof hasAnyAssets;
+    selectBtcUtxos: typeof selectBtcUtxos;
+    getAddedVirtualSize: typeof getAddedVirtualSize;
+    getUtxoDust: typeof getUtxoDust;
+    getAddressUtxoDust: typeof getAddressUtxoDust;
+};
+export {};

package/lib/src/tx-helpers/index.d.ts

@@ -0,0 +1,8 @@
+import { sendAtomicalsFT } from './send-atomicals-ft';
+import { sendAtomicalsNFT } from './send-atomicals-nft';
+import { sendAllBTC, sendBTC } from './send-btc';
+import { sendInscription } from './send-inscription';
+import { sendInscriptions } from './send-inscriptions';
+import { sendRunes } from './send-runes';
+import { splitInscriptionUtxo } from './split-inscription-utxo';
+export { sendAllBTC, sendAtomicalsFT, sendAtomicalsNFT, sendBTC, sendInscription, sendInscriptions, sendRunes, splitInscriptionUtxo };

package/lib/src/tx-helpers/send-atomicals-ft.d.ts

@@ -0,0 +1,16 @@
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+export declare function sendAtomicalsFT(params: {
+    assetUtxos: UnspentOutput[];
+    btcUtxos: UnspentOutput[];
+    toAddress: string;
+    networkType: NetworkType;
+    changeAssetAddress: string;
+    sendAmount: number;
+    changeAddress: string;
+    feeRate: number;
+    enableRBF?: boolean;
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: ToSignInput[];
+}>;

package/lib/src/tx-helpers/send-atomicals-nft.d.ts

@@ -0,0 +1,14 @@
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+export declare function sendAtomicalsNFT(params: {
+    assetUtxo: UnspentOutput;
+    btcUtxos: UnspentOutput[];
+    toAddress: string;
+    networkType: NetworkType;
+    changeAddress: string;
+    feeRate: number;
+    enableRBF?: boolean;
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: ToSignInput[];
+}>;

package/lib/src/tx-helpers/send-btc.d.ts

@@ -0,0 +1,28 @@
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+export declare function sendBTC(params: {
+    btcUtxos: UnspentOutput[];
+    tos: {
+        address: string;
+        satoshis: number;
+    }[];
+    networkType: NetworkType;
+    changeAddress: string;
+    feeRate: number;
+    enableRBF?: boolean;
+    memo?: string;
+    memos?: string[];
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: ToSignInput[];
+}>;
+export declare function sendAllBTC(params: {
+    btcUtxos: UnspentOutput[];
+    toAddress: string;
+    networkType: NetworkType;
+    feeRate: number;
+    enableRBF?: boolean;
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: ToSignInput[];
+}>;

package/lib/src/tx-helpers/send-inscription.d.ts

@@ -0,0 +1,16 @@
+import { NetworkType } from '../network';
+import { UnspentOutput } from '../types';
+export declare function sendInscription({ assetUtxo, btcUtxos, toAddress, networkType, changeAddress, feeRate, outputValue, enableRBF, enableMixed }: {
+    assetUtxo: UnspentOutput;
+    btcUtxos: UnspentOutput[];
+    toAddress: string;
+    networkType: NetworkType;
+    changeAddress: string;
+    feeRate: number;
+    outputValue: number;
+    enableRBF?: boolean;
+    enableMixed?: boolean;
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: import("../types").ToSignInput[];
+}>;

package/lib/src/tx-helpers/send-inscriptions.d.ts

@@ -0,0 +1,14 @@
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+export declare function sendInscriptions({ assetUtxos, btcUtxos, toAddress, networkType, changeAddress, feeRate, enableRBF }: {
+    assetUtxos: UnspentOutput[];
+    btcUtxos: UnspentOutput[];
+    toAddress: string;
+    networkType: NetworkType;
+    changeAddress: string;
+    feeRate: number;
+    enableRBF?: boolean;
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: ToSignInput[];
+}>;

package/lib/src/tx-helpers/send-runes.d.ts

@@ -0,0 +1,19 @@
+import { bitcoin } from '../bitcoin-core';
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+export declare function sendRunes({ assetUtxos, btcUtxos, assetAddress, btcAddress, toAddress, networkType, runeid, runeAmount, outputValue, feeRate, enableRBF }: {
+    assetUtxos: UnspentOutput[];
+    btcUtxos: UnspentOutput[];
+    assetAddress: string;
+    btcAddress: string;
+    toAddress: string;
+    networkType: NetworkType;
+    runeid: string;
+    runeAmount: string;
+    outputValue: number;
+    feeRate: number;
+    enableRBF?: boolean;
+}): Promise<{
+    psbt: bitcoin.Psbt;
+    toSignInputs: ToSignInput[];
+}>;

package/lib/src/tx-helpers/split-inscription-utxo.d.ts

@@ -0,0 +1,15 @@
+import { NetworkType } from '../network';
+import { ToSignInput, UnspentOutput } from '../types';
+export declare function splitInscriptionUtxo({ btcUtxos, assetUtxo, networkType, changeAddress, feeRate, enableRBF, outputValue }: {
+    btcUtxos: UnspentOutput[];
+    assetUtxo: UnspentOutput;
+    networkType: NetworkType;
+    changeAddress: string;
+    feeRate?: number;
+    enableRBF?: boolean;
+    outputValue?: number;
+}): Promise<{
+    psbt: import("bitcoinjs-lib").Psbt;
+    toSignInputs: ToSignInput[];
+    splitedCount: number;
+}>;

package/lib/src/types.d.ts

@@ -0,0 +1,59 @@
+interface BaseUserToSignInput {
+    index: number;
+    sighashTypes?: number[] | undefined;
+    disableTweakSigner?: boolean;
+}
+export interface AddressUserToSignInput extends BaseUserToSignInput {
+    address: string;
+}
+export interface PublicKeyUserToSignInput extends BaseUserToSignInput {
+    publicKey: string;
+}
+export type UserToSignInput = AddressUserToSignInput | PublicKeyUserToSignInput;
+export interface SignPsbtOptions {
+    autoFinalized?: boolean;
+    toSignInputs?: UserToSignInput[];
+}
+export interface ToSignInput {
+    index: number;
+    publicKey: string;
+    sighashTypes?: number[];
+    disableTweakSigner?: boolean;
+}
+export interface UnspentOutput {
+    txid: string;
+    vout: number;
+    satoshis: number;
+    scriptPk: string;
+    pubkey: string;
+    addressType: AddressType;
+    inscriptions: {
+        inscriptionId: string;
+        inscriptionNumber?: number;
+        offset: number;
+    }[];
+    atomicals: {
+        atomicalId: string;
+        atomicalNumber: number;
+        type: 'FT' | 'NFT';
+        ticker?: string;
+        atomicalValue?: number;
+    }[];
+    runes?: {
+        runeid: string;
+        amount: string;
+    }[];
+    rawtx?: string;
+}
+export declare enum AddressType {
+    P2PKH = 0,
+    P2WPKH = 1,
+    P2TR = 2,
+    P2SH_P2WPKH = 3,
+    M44_P2WPKH = 4,
+    M44_P2TR = 5,
+    P2WSH = 6,
+    P2SH = 7,
+    UNKNOWN = 8
+}
+export {};

package/lib/src/utils.d.ts

@@ -0,0 +1,23 @@
+import { bitcoin } from './bitcoin-core';
+export declare const toXOnly: (pubKey: Buffer) => Buffer;
+/**
+ * Transform raw private key to taproot address private key
+ */
+export declare function tweakSigner(signer: bitcoin.Signer, opts?: any): bitcoin.Signer;
+/**
+ * ECDSA signature validator
+ */
+export declare const validator: (pubkey: Buffer, msghash: Buffer, signature: Buffer) => boolean;
+/**
+ * Schnorr signature validator
+ */
+export declare const schnorrValidator: (pubkey: Buffer, msghash: Buffer, signature: Buffer) => boolean;
+/**
+ * Transform satoshis to btc format
+ */
+export declare function satoshisToAmount(val: number): string;
+/**
+ * Transform btc format to satoshis
+ */
+export declare function amountToSaothis(val: any): number;
+export declare function shortAddress(address?: string, len?: number): string;

package/lib/src/wallet/abstract-wallet.d.ts

@@ -0,0 +1,6 @@
+import { bitcoin } from '../bitcoin-core';
+import { SignPsbtOptions } from '../types';
+export interface AbstractWallet {
+    signPsbt(psbt: bitcoin.Psbt, opts?: SignPsbtOptions): Promise<bitcoin.Psbt>;
+    signMessage(text: string, type: 'bip322-simple' | 'ecdsa'): Promise<string>;
+}

package/lib/src/wallet/estimate-wallet.d.ts

@@ -0,0 +1,23 @@
+import { bitcoin } from '../bitcoin-core';
+import { SimpleKeyring } from '../keyring';
+import { NetworkType } from '../network';
+import { AddressType, SignPsbtOptions } from '../types';
+import { AbstractWallet } from './abstract-wallet';
+/**
+ * EstimateWallet is a wallet that can be used to estimate the size of a transaction.
+ */
+export declare class EstimateWallet implements AbstractWallet {
+    keyring: SimpleKeyring;
+    address: string;
+    pubkey: string;
+    network: bitcoin.Network;
+    networkType: NetworkType;
+    addressType: AddressType;
+    constructor(wif: string, networkType?: NetworkType, addressType?: AddressType);
+    static fromRandom(addressType?: AddressType, networkType?: NetworkType): EstimateWallet;
+    getNetworkType(): NetworkType;
+    signPsbt(psbt: bitcoin.Psbt, opts?: SignPsbtOptions): Promise<bitcoin.Psbt>;
+    getPublicKey(): Promise<string>;
+    signMessage(text: string, type: 'bip322-simple' | 'ecdsa'): Promise<string>;
+    private formatOptionsToSignInputs;
+}

package/lib/src/wallet/index.d.ts

@@ -0,0 +1,3 @@
+export * from './abstract-wallet';
+export * from './estimate-wallet';
+export * from './local-wallet';

package/lib/src/wallet/local-wallet.d.ts

@@ -0,0 +1,23 @@
+import { bitcoin } from '../bitcoin-core';
+import { SimpleKeyring } from '../keyring';
+import { NetworkType } from '../network';
+import { AddressType, SignPsbtOptions } from '../types';
+import { AbstractWallet } from './abstract-wallet';
+export declare class LocalWallet implements AbstractWallet {
+    keyring: SimpleKeyring;
+    address: string;
+    pubkey: string;
+    network: bitcoin.Network;
+    addressType: AddressType;
+    networkType: NetworkType;
+    scriptPk: string;
+    constructor(wif: string, addressType?: AddressType, networkType?: NetworkType);
+    static fromMnemonic(addressType: AddressType, networkType: NetworkType, mnemonic: string, passPhrase?: string, hdPath?: string): LocalWallet;
+    static fromRandom(addressType?: AddressType, networkType?: NetworkType): LocalWallet;
+    getNetworkType(): NetworkType;
+    signPsbt(psbt: bitcoin.Psbt, opts?: SignPsbtOptions): Promise<bitcoin.Psbt>;
+    getPublicKey(): string;
+    signMessage(text: string, type: 'bip322-simple' | 'ecdsa'): Promise<string>;
+    signData(data: string, type?: 'ecdsa' | 'schnorr'): Promise<string>;
+    private formatOptionsToSignInputs;
+}

package/lib/test/address/address.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/keyring/hd-keyring.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/keyring/keystone-keyring.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/keyring/simple-keyring.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/message/message.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/runes/varint.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/transaction/transaction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/transaction/utxo.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/send-atomicals-ft.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/send-atomicals-nft.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/send-btc.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/send-inscription.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/send-inscriptions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/send-runes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/tx-helpers/split-inscription-utxo.test.d.ts

@@ -0,0 +1 @@
+export {};