///
///
import type Transport from "@ledgerhq/hw-transport";
import BtcNew from "./BtcNew";
import BtcOld from "./BtcOld";
import type { CreateTransactionArg } from "./createTransaction";
import type { AddressFormat } from "./getWalletPublicKey";
import type { SignP2SHTransactionArg } from "./signP2SHTransaction";
import type { Transaction } from "./types";
import type { SignPsbtBufferOptions } from "./signPsbt/types";
export type { AddressFormat };
/**
* @class Btc
* @description Bitcoin API.
* @param transport The transport layer used for communication.
* @param scrambleKey This parameter is deprecated and no longer needed.
* @param currency The currency to use, defaults to "bitcoin".
* @example
* import Btc from "@ledgerhq/hw-app-btc";
* const btc = new Btc({ transport, currency: "bitcoin" });
*/
export default class Btc {
private _transport;
private _impl;
constructor({ transport, scrambleKey, currency, }: {
transport: Transport;
scrambleKey?: string;
currency?: string;
});
/**
* Get an XPUB with a ledger device
* @param arg derivation parameter
* - path: a BIP 32 path of the account level. (e.g. The derivation path `84'/0'/0'`
* follows the `purpose' / coin_type' / account'` standard, with purpose=84, coin_type=0, account=0)
* - xpubVersion: the XPUBVersion of the coin used. (refer to ledgerjs/packages/cryptoassets/src/currencies.ts
* for the XPUBVersion value if needed)
* @returns XPUB of the account
*/
getWalletXpub(arg: {
path: string;
xpubVersion: number;
}): Promise;
/**
* @param path a BIP 32 path (i.e. the `purpose’ / coin_type’ / account’ / change / address_index` standard)
* @param options an object with optional these fields:
*
* - verify (boolean) whether ask user to confirm the address on the device
*
* - format ("legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr") to use different bitcoin address formatter.
*
* NB The normal usage is to use:
*
* - legacy format with 44' paths
*
* - p2sh format with 49' paths
*
* - bech32 format with 84' paths
*
* - bech32m format with 86' paths
*
* - cashaddr in case of Bitcoin Cash
*
* @example
* btc.getWalletPublicKey("44'/0'/0'/0/0").then(o => o.bitcoinAddress)
* btc.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinAddress)
*/
getWalletPublicKey(path: string, opts?: {
verify?: boolean;
format?: AddressFormat;
}): Promise<{
publicKey: string;
bitcoinAddress: string;
chainCode: string;
}>;
/**
* You can sign a message according to the Bitcoin Signature format and retrieve v, r, s given the message and the BIP 32 path of the account to sign.
* @example
btc.signMessage("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
var v = result['v'] + 27 + 4;
var signature = Buffer.from(v.toString(16) + result['r'] + result['s'], 'hex').toString('base64');
console.log("Signature : " + signature);
}).catch(function(ex) {console.log(ex);});
*/
signMessage(path: string, messageHex: string): Promise<{
v: number;
r: string;
s: string;
}>;
/**
* To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters
* @param inputs is an array of [ transaction, output_index, optional redeem script, optional sequence ] where
*
* * transaction is the previously computed transaction object for this UTXO
* * output_index is the output in the transaction used as input for this UTXO (counting from 0)
* * redeem script is the optional redeem script to use when consuming a Segregated Witness input
* * sequence is the sequence number to use for this input (when using RBF), or non present
* @param associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
* @param changePath is an optional BIP 32 path pointing to the path to the public key used to compute the change address
* @param outputScriptHex is the hexadecimal serialized outputs of the transaction to sign, including leading vararg voutCount
* @param lockTime is the optional lockTime of the transaction to sign, or default (0)
* @param sigHashType is the hash type of the transaction to sign, or default (all)
* @param segwit is an optional boolean indicating wether to use segwit or not. This includes wrapped segwit.
* @param additionals list of additionnal options
*
* - "bech32" for spending native segwit outputs
* - "bech32m" for spending segwit v1+ outputs
* - "abc" for bch
* - "gold" for btg
* - "decred" for decred
* - "zcash" for zcash
* - "bipxxx" for using BIPxxx
* - "sapling" to indicate a zec transaction is supporting sapling (to be set over block 419200)
* @param expiryHeight is an optional Buffer for zec overwinter / sapling Txs
* @param useTrustedInputForSegwit trust inputs for segwit transactions. If app version >= 1.4.0 this should be true.
* @return the signed transaction ready to be broadcast
* @example
btc.createTransaction({
inputs: [ [tx1, 1] ],
associatedKeysets: ["0'/0/0"],
outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
}).then(res => ...);
*/
createPaymentTransaction(arg: CreateTransactionArg): Promise;
/**
* Signs a PSBT buffer using the Bitcoin app (new protocol).
*
* - If the PSBT is v2, it is deserialized directly.
* - If the PSBT is v0, it is converted to v2 internally.
* - The account type (legacy, wrapped segwit, native segwit, taproot) is
* inferred from PSBT data when possible, or from the provided options.
*
* Note: All internal inputs (inputs that can be signed by the device) must
* belong to the same account and use the same account type. Mixed input types
* or inputs from different accounts are not supported and will throw an error.
*
* @param psbtBuffer - Raw PSBT buffer (v0 or v2) to be signed.
* @param options - Signing configuration.
* @param options.finalizePsbt - Whether to finalize the PSBT after signing.
* If true, the returned `tx` is a fully signed
* transaction ready for broadcast.
* @param options.accountPath - BIP32 account path (for example,
* "m/84'/0'/0'"). Required. Used to populate missing BIP32 derivation
* information when the PSBT lacks it, and as the signing account path.
* @param options.addressFormat - Explicit address format to use when the
* account type cannot be inferred from the PSBT ("legacy", "p2sh",
* "bech32", or "bech32m").
* @param options.onDeviceSignatureRequested - Callback when signature is about to be requested from device.
* @param options.onDeviceSignatureGranted - Callback when the first signature is granted by device.
* @param options.onDeviceStreaming - Callback to track signing progress with index and total.
* @param options.knownAddressDerivations - Map from scriptPubKey hash (hex) to { pubkey, path }.
* Required. Built by the caller from the wallet's known addresses (receive/change).
*
* @returns An object containing:
* - `psbt`: the serialized PSBT (with signatures; finalized if
* `finalizePsbt` is true).
* - `tx`: the fully signed transaction hex string, only when
* `finalizePsbt` is true; omitted when not finalizing.
*/
signPsbtBuffer(psbtBuffer: Buffer, options: SignPsbtBufferOptions): Promise<{
psbt: Buffer;
tx?: string;
}>;
/**
* To obtain the signature of multisignature (P2SH) inputs, call signP2SHTransaction_async with the folowing parameters
* @param inputs is an array of [ transaction, output_index, redeem script, optional sequence ] where
* * transaction is the previously computed transaction object for this UTXO
* * output_index is the output in the transaction used as input for this UTXO (counting from 0)
* * redeem script is the mandatory redeem script associated to the current P2SH input
* * sequence is the sequence number to use for this input (when using RBF), or non present
* @param associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
* @param outputScriptHex is the hexadecimal serialized outputs of the transaction to sign
* @param lockTime is the optional lockTime of the transaction to sign, or default (0)
* @param sigHashType is the hash type of the transaction to sign, or default (all)
* @return the signed transaction ready to be broadcast
* @example
btc.signP2SHTransaction({
inputs: [ [tx, 1, "52210289b4a3ad52a919abd2bdd6920d8a6879b1e788c38aa76f0440a6f32a9f1996d02103a3393b1439d1693b063482c04bd40142db97bdf139eedd1b51ffb7070a37eac321030b9a409a1e476b0d5d17b804fcdb81cf30f9b99c6f3ae1178206e08bc500639853ae"] ],
associatedKeysets: ["0'/0/0"],
outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
}).then(result => ...);
*/
signP2SHTransaction(arg: SignP2SHTransactionArg): Promise;
/**
* For each UTXO included in your transaction, create a transaction object from the raw serialized version of the transaction used in this UTXO.
* @param transactionHex a raw hexadecimal serialized transaction
* @param isSegwitSupported is a boolean indicating if the segwit is supported
* @param hasExtraData is a boolean (komodo, zencash and zcash include extraData in their transactions, others don't)
* @param additionals list of additionnal options
* @return the transaction object deserialized from the raw hexadecimal transaction
* @example
const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
*/
splitTransaction(transactionHex: string, isSegwitSupported?: boolean | null | undefined, hasExtraData?: boolean, additionals?: Array): Transaction;
/**
* Serialize a transaction's outputs to hexadecimal
* @example
const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
*/
serializeTransactionOutputs(t: Transaction): Buffer;
/**
* Trusted input is the hash of a UTXO that needs to be signed
* For Legacy transactions, the app has some APDUs flows that do the amount check for an UTXO,
* by parsing the transaction that created this UTXO
*/
getTrustedInput(indexLookup: number, transaction: Transaction, additionals?: Array): Promise;
/**
* Trusted input is the hash of a UTXO that needs to be signed. BIP143 is used for Segwit inputs.
*/
getTrustedInputBIP143(indexLookup: number, transaction: Transaction, additionals?: Array): string;
changeImplIfNecessary(): Promise;
}
//# sourceMappingURL=Btc.d.ts.map