@blooo/hw-app-acre

GitHub,
Ledger Devs Discord,
Developer Portal

@blooo/hw-app-acre

Ledger Hardware Wallet Acre JavaScript bindings. Also supports many altcoins.

*

Are you adding Ledger support to your software wallet?

You may be using this package to communicate with the Acre Nano App.

For a smooth and quick integration:

* See the developers’ documentation on the Developer Portal and
* Go on Discord to chat with developer support and the developer community.

*

API

#### Table of Contents

* bippath
* Acre
* Parameters
* Examples
* getWalletXpub
* Parameters
* getWalletPublicKey
* Parameters
* Examples
* signMessage
* Parameters
* Examples
* createPaymentTransaction
* Parameters
* Examples
* signP2SHTransaction
* Parameters
* Examples
* splitTransaction
* Parameters
* Examples
* serializeTransactionOutputs
* Parameters
* Examples
* getTrustedInput
* Parameters
* getTrustedInputBIP143
* Parameters
* signWithdrawal
* Parameters
* Examples
* signERC4361Message
* Parameters
* Examples
* AcreBtcNew
* getWalletXpub
* Parameters
* getWalletPublicKey
* Parameters
* createPaymentTransaction
* Parameters
* signMessage
* Parameters
* signWithdrawal
* Parameters
* signERC4361Message
* Parameters
* descrTemplFrom
* Parameters
* AcreBtcOld
* getWalletPublicKey
* Parameters
* Examples
* createPaymentTransaction
* Parameters
* Examples
* CreateTransactionArg
* Properties
* AddressFormat
* AcreWithdrawalData
* Properties
* AccountType
* spendingCondition
* Parameters
* setInput
* Parameters
* setOwnOutput
* Parameters
* getDescriptorTemplate
* SingleKeyAccount
* getTaprootOutputKey
* Parameters
* AppClient
* Parameters
* ClientCommandInterpreter
* Parameters
* MerkelizedPsbt
* Parameters
* Merkle
* Parameters
* MerkleMap
* Parameters
* WalletPolicy
* Parameters
* extract
* Parameters
* finalize
* Parameters
* clearFinalizedInput
* Parameters
* writePush
* Parameters
* PsbtV2
* serializeTransactionOutputs
* Parameters
* Examples
* SignP2SHTransactionArg
* Properties
* TransactionInput
* TransactionOutput
* Transaction

$3

BIP32 Path Handling for Bitcoin Wallets

This file provides utility functions to handle BIP32 paths,
which are commonly used in hierarchical deterministic (HD) wallets.
It includes functions to convert BIP32 paths to and from different formats,
extract components from extended public keys (xpubs), and manipulate path elements.

$3

Acre app API.

#### Parameters

* transport The transport layer used for communication.
* scrambleKey This parameter is deprecated and no longer needed.
* currency The currency to use, defaults to "bitcoin".

#### Examples

``javascript
import Acre from "@blooo/hw-app-acre:";
const acre = new Acre({ transport, currency: "bitcoin" });
`

#### getWalletXpub

Get an XPUB with a ledger device

##### Parameters

arg {path: string, xpubVersion: number} 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 Promise<string> XPUB of the account

#### getWalletPublicKey

##### Parameters

* path string a BIP 32 path (i.e. the purpose’ / coin_type’ / account’ / change / address_index standard)
* opts {verify: boolean?, format: AddressFormat?}?
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

##### Examples

`javascript
acre.getWalletPublicKey("44'/0'/0'/0/0").then(o => o.bitcoinAddress)
acre.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinAddress)
`

Returns Promise<{publicKey: string, bitcoinAddress: string, chainCode: string}>

#### signMessage

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.

##### Parameters

* path string
* messageHex string

##### Examples

`javascript
acre.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);});
`

Returns Promise<{v: number, r: string, s: string}>

#### createPaymentTransaction

To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters

##### Parameters

* arg CreateTransactionArg
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
* associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
* changePath is an optional BIP 32 path pointing to the path to the public key used to compute the change address
* outputScriptHex is the hexadecimal serialized outputs of the transaction to sign, including leading vararg voutCount
* lockTime is the optional lockTime of the transaction to sign, or default (0)
* sigHashType is the hash type of the transaction to sign, or default (all)
* segwit is an optional boolean indicating wether to use segwit or not. This includes wrapped segwit.
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)
* expiryHeight is an optional Buffer for zec overwinter / sapling Txs
* useTrustedInputForSegwit trust inputs for segwit transactions. If app version >= 1.4.0 this should be true.

##### Examples

`javascript
acre.createTransaction({
inputs: [ [tx1, 1] ],
associatedKeysets: ["0'/0/0"],
outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
}).then(res => ...);
`

Returns Promise<string> the signed transaction ready to be broadcast

#### signP2SHTransaction

To obtain the signature of multisignature (P2SH) inputs, call signP2SHTransaction\_async with the folowing parameters

##### Parameters

* arg SignP2SHTransactionArg
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
* associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
* outputScriptHex is the hexadecimal serialized outputs of the transaction to sign
* lockTime is the optional lockTime of the transaction to sign, or default (0)
* sigHashType is the hash type of the transaction to sign, or default (all)

##### Examples

`javascript
acre.signP2SHTransaction({
inputs: [ [tx, 1, "52210289b4a3ad52a919abd2bdd6920d8a6879b1e788c38aa76f0440a6f32a9f1996d02103a3393b1439d1693b063482c04bd40142db97bdf139eedd1b51ffb7070a37eac321030b9a409a1e476b0d5d17b804fcdb81cf30f9b99c6f3ae1178206e08bc500639853ae"] ],
associatedKeysets: ["0'/0/0"],
outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
}).then(result => ...);
`

Returns Promise<Array<string>> the signed transaction ready to be broadcast

#### splitTransaction

For each UTXO included in your transaction, create a transaction object from the raw serialized version of the transaction used in this UTXO.

##### Parameters

* transactionHex string a raw hexadecimal serialized transaction
* isSegwitSupported (boolean | null | undefined) is a boolean indicating if the segwit is supported (optional, default false)
* hasExtraData is a boolean (komodo, zencash and zcash include extraData in their transactions, others don't) (optional, default false)
* additionals Array<string> list of additionnal options (optional, default [])

##### Examples

`javascript
const tx1 = acre.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
`

Returns Transaction the transaction object deserialized from the raw hexadecimal transaction

#### serializeTransactionOutputs

Serialize a transaction's outputs to hexadecimal

##### Parameters

* t Transaction

##### Examples

`javascript
const tx1 = acre.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
const outputScript = acre.serializeTransactionOutputs(tx1).toString('hex');
`

Returns Buffer

#### getTrustedInput

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

##### Parameters

* indexLookup number
* transaction Transaction
* additionals Array<string> (optional, default [])

Returns Promise<string>

#### getTrustedInputBIP143

Trusted input is the hash of a UTXO that needs to be signed. BIP143 is used for Segwit inputs.

##### Parameters

* indexLookup number
* transaction Transaction
* additionals Array<string> (optional, default [])

Returns string

#### signWithdrawal

Signs an Acre Withdrawal message with the private key at
the provided derivation path according to the Bitcoin Signature format
and returns v, r, s.

##### Parameters

* $0 {path: string, withdrawalData: AcreWithdrawalData}

* $0.path
* $0.withdrawalData

##### Examples

`javascript
var withdrawalData = {
to: "0xc14972DC5a4443E4f5e89E3655BE48Ee95A795aB",
value: "0x0",
data: "0xcae9ca510000000000000000000000000e781e9d538895ee99bd6e9bf28664942beff32f00000000000000000000000000000000000000000000000000470de4df820000000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000001000000000000000000000000006083Bde64CCBF08470a1a0dAa9a0281B4951be7C4b5e4623765ec95cfa6e261406d5c446012eff9300000000000000000000000008dcc842b8ed75efe1f222ebdc22d1b06ef35efff6469f708057266816f0595200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000587f579c500000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000001a1976a914c8e9edf5e915c0482b1b236fc917011a4b943e6e88ac000000000000",
operation: "0",
safeTxGas: "0x0",
baseGas: "0x0",
gasPrice: "0x0",
gasToken: "0x0000000000000000000000000000000000000000",
refundReceiver: "0x0000000000000000000000000000000000000000",
nonce: "0xC",
};
acre.signWithdrawal({"m/44'/0'/0'/0/0", withdrawalData}).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);});
`

#### signERC4361Message

Signs an Ethereum Sign-In (ERC-4361) message with the private key at
the provided derivation path according to the Bitcoin Signature format
and returns v, r, s.

##### Parameters

* path string
* messageHex string

##### Examples

`javascript
acre.signERC4361Message("44'/60'/0'/0'/0", Buffer.from("Example ERC-4361 message").toString("hex")).then(function(result) {
const v = result['v'] + 27 + 4;
const signature = Buffer.from(v.toString(16) + result['r'] + result['s'], 'hex').toString('base64');
console.log("Signature : " + signature);
}).catch(function(ex) {console.log(ex);});
`

Returns Promise<{v: number, r: string, s: string}>

Note: The message is restricted to maximum 128 character lines.

Returns Promise<{v: number, r: string, s: string}>

$3

This class implements the same interface as AcreBtcOld (formerly
named Btc), but interacts with Acre hardware app from version 1.0.0
which uses the same APDU protocol as the Bitcoin app version 2.1.0+.
This protocol is documented at


Since the interface must remain compatible with AcreBtcOld, the methods
of this class are quite clunky, because it needs to adapt legacy
input data into the PSBT process.

#### getWalletXpub

This is a new method that allow users to get an xpub at a standard path.
Standard paths are described at


This boils down to paths (N=0 for Bitcoin, N=1 for Testnet):
M/44'/N'/x'/\\
M/48'/N'/x'/y'/\\
M/49'/N'/x'/\\
M/84'/N'/x'/\\
M/86'/N'/x'/\\

The method was added because of added security in the hardware app v2+. The
new hardware app will allow export of any xpub up to and including the
deepest hardened key of standard derivation paths, whereas the old app
would allow export of any key.

This caused an issue for callers of this class, who only had
getWalletPublicKey() to call which means they have to constuct xpub
themselves:

Suppose a user of this class wants to create an account xpub on a standard
path, M/44'/0'/Z'. The user must get the parent key fingerprint (see BIP32)
by requesting the parent key M/44'/0'. The new app won't allow that, because
it only allows exporting deepest level hardened path. So the options are to
allow requesting M/44'/0' from the app, or to add a new function
"getWalletXpub".

We opted for adding a new function, which can greatly simplify client code.

##### Parameters

* $0 {path: string, xpubVersion: number}

* $0.path
* $0.xpubVersion

Returns Promise<string>

#### getWalletPublicKey

This method returns a public key, a bitcoin address, and and a chaincode
for a specific derivation path.

Limitation: If the path is not a leaf node of a standard path, the address
will be the empty string "", see this.getWalletAddress() for details.

##### Parameters

* path string
* opts {verify: boolean?, format: AddressFormat?}?

Returns Promise<{publicKey: string, bitcoinAddress: string, chainCode: string}>

#### createPaymentTransaction

Build and sign a transaction. See Acre.createPaymentTransaction for
details on how to use this method.

This method will convert the legacy arguments, CreateTransactionArg, into
a psbt which is finally signed and finalized, and the extracted fully signed
transaction is returned.

##### Parameters

* arg CreateTransactionArg

Returns Promise<string>

#### signMessage

Signs an arbitrary hex-formatted message with the private key at
the provided derivation path according to the Bitcoin Signature format
and returns v, r, s.

##### Parameters

* $0 {path: string, withdrawalData: AcreWithdrawalData}

* $0.path
* $0.withdrawalData

Returns Promise<{v: number, r: string, s: string}>

#### signWithdrawal

Signs an Acre Withdrawal message with the private key at
the provided derivation path according to the Bitcoin Signature format
and returns v, r, s.

##### Parameters

* $0 {path: string, withdrawalData: AcreWithdrawalData}

* $0.path
* $0.withdrawalData

Returns Promise<{v: number, r: string, s: string}>

#### signERC4361Message

Signs an ERC-4361 (Sign-In with Ethereum) formatted message with the private key at
the provided derivation path according to the Bitcoin Signature format
and returns v, r, s.

##### Parameters

* $0 {path: string, messageHex: string}

* $0.path The BIP32 derivation path of the key to use for signing
* $0.messageHex The ERC-4361 formatted message to sign, in hexadecimal format

Returns Promise<{v: number, r: string, s: string}>

$3

This function returns a descriptor template based on the address format.
See for details of
the bitcoin descriptor template.

#### Parameters

* path string a BIP 32 path
* opts {verify: boolean?, format: AddressFormat?}?
options an object with optional these fields: verify (boolean) will 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

##### Examples

`javascript
acre.getWalletPublicKey("44'/0'/0'/0/0").then(o => o.bitcoinAddress)
acre.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinAddress)
`

Returns Promise<{publicKey: string, bitcoinAddress: string, chainCode: string}>

#### createPaymentTransaction

To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters

##### Parameters

* arg CreateTransactionArg
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
* associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
* changePath is an optional BIP 32 path pointing to the path to the public key used to compute the change address
* outputScriptHex is the hexadecimal serialized outputs of the transaction to sign
* lockTime is the optional lockTime of the transaction to sign, or default (0)
* sigHashType is the hash type of the transaction to sign, or default (all)
* segwit is an optional boolean indicating wether to use segwit or not
additionals list of additionnal options "bech32" for spending native segwit 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)
* expiryHeight is an optional Buffer for zec overwinter / sapling Txs
* useTrustedInputForSegwit trust inputs for segwit transactions

##### Examples

`javascript
acre.createTransaction({
inputs: [ [tx1, 1] ],
associatedKeysets: ["0'/0/0"],
outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
}).then(res => ...);
`

Returns Promise<string> the signed transaction ready to be broadcast

$3

Type: {inputs: Array<\[Transaction, number, (string | null | undefined), (number | null | undefined)]>, associatedKeysets: Array<string>, changePath: string?, outputScriptHex: string, lockTime: number?, sigHashType: number?, segwit: boolean?, additionals: Array<string>, expiryHeight: Buffer?, useTrustedInputForSegwit: boolean?, onDeviceStreaming: function (arg0: {progress: number, total: number, index: number}): void?, onDeviceSignatureRequested: function (): void?, onDeviceSignatureGranted: function (): void?}

#### Properties

* inputs Array<\[Transaction, number, (string | null | undefined), (number | null | undefined)]>
* associatedKeysets Array<string>
* changePath string?
* outputScriptHex string
* lockTime number?
* sigHashType number?
* segwit boolean?
* additionals Array<string>
* expiryHeight Buffer?
* useTrustedInputForSegwit boolean?
* onDeviceStreaming function (arg0: {progress: number, total: number, index: number}): void?
* onDeviceSignatureRequested function (): void?
* onDeviceSignatureGranted function (): void?

$3

The AcreWithdrawalData type contains the following properties related to a withdrawal transaction, where each property is a hexadecimal string.

#### Properties
* to string (hexadecimal)
* value string (hexadecimal)
* data string (hexadecimal)
* operation string (hexadecimal)
* safeTxGas string (hexadecimal)
* baseGas string (hexadecimal)
* gasPrice string (hexadecimal)
* gasToken string (hexadecimal)
* refundReceiver string (hexadecimal)
* nonce string (hexadecimal)

$3

address format is one of legacy | p2sh | bech32 | bech32m | cashaddr

Type: ("legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr")

$3

Encapsulates differences between account types, for example p2wpkh,
p2wpkhWrapped, p2tr.

#### spendingCondition

Generates a scriptPubKey (output script) from a list of public keys. If a
p2sh redeemScript or a p2wsh witnessScript is needed it will also be set on
the returned SpendingCondition.

The pubkeys are expected to be 33 byte ecdsa compressed pubkeys.

##### Parameters

* pubkeys Array<Buffer>

Returns SpendingCondition

#### setInput

Populates the psbt with account type-specific data for an input.

##### Parameters

* i number The index of the input map to populate
* inputTx (Buffer | undefined) The full transaction containing the spent output. This may
be omitted for taproot.
* spentOutput SpentOutput The amount and spending condition of the spent output
* pubkeys Array<Buffer> The 33 byte ecdsa compressed public keys involved in the input
* pathElems Array<Array<number>> The paths corresponding to the pubkeys, in same order.

Returns void

#### setOwnOutput

Populates the psbt with account type-specific data for an output. This is typically
done for change outputs and other outputs that goes to the same account as
being spent from.

##### Parameters

* i number The index of the output map to populate
* cond SpendingCondition The spending condition for this output
* pubkeys Array<Buffer> The 33 byte ecdsa compressed public keys involved in this output
* paths Array<Array<number>> The paths corresponding to the pubkeys, in same order.

Returns void

#### getDescriptorTemplate

Returns the descriptor template for this account type. Currently only
DefaultDescriptorTemplates are allowed, but that might be changed in the
future. See class WalletPolicy for more information on descriptor
templates.

Returns DefaultDescriptorTemplate

$3

Extends BaseAccount

Superclass for single signature accounts. This will make sure that the pubkey
arrays and path arrays in the method arguments contains exactly one element
and calls an abstract method to do the actual work.

$3

Calculates a taproot output key from an internal key. This output key will be
used as witness program in a taproot output. The internal key is tweaked
according to recommendation in BIP341:


#### Parameters

* internalPubkey Buffer A 32 byte x-only taproot internal key

Returns Buffer The output key

$3

This class encapsulates the APDU protocol documented at


#### Parameters

* transport Transport

$3

This class will dispatch a client command coming from the hardware device to
the appropriate client command implementation. Those client commands
typically requests data from a merkle tree or merkelized maps.

A ClientCommandInterpreter is prepared by adding the merkle trees and
merkelized maps it should be able to serve to the hardware device. This class
doesn't know anything about the semantics of the data it holds, it just
serves merkle data. It doesn't even know in what context it is being
executed, ie SignPsbt, getWalletAddress, etc.

If the command yelds results to the client, as signPsbt does, the yielded
data will be accessible after the command completed by calling getYielded(),
which will return the yields in the same order as they came in.

#### Parameters

* progressCallback function (): void

$3

Extends PsbtV2

This class merkelizes a PSBTv2, by merkelizing the different
maps of the psbt. This is used during the transaction signing process,
where the hardware app can request specific parts of the psbt from the
client code and be sure that the response data actually belong to the psbt.
The reason for this is the limited amount of memory available to the app,
so it can't always store the full psbt in memory.

The signing process is documented at


#### Parameters

* psbt PsbtV2

$3

This class implements the merkle tree used by Ledger Acre app,
which is documented at


#### Parameters

* leaves Array<Buffer>
* hasher function (buf: Buffer): Buffer (optional, default crypto.sha256)

$3

This implements "Merkelized Maps", documented at


A merkelized map consist of two merkle trees, one for the keys of
a map and one for the values of the same map, thus the two merkle
trees have the same shape. The commitment is the number elements
in the map followed by the keys' merkle root followed by the
values' merkle root.

#### Parameters

* keys Array<Buffer> Sorted list of (unhashed) keys
* values Array<Buffer> values, in corresponding order as the keys, and of equal length

$3

The Bitcon hardware app uses a descriptors-like thing to describe
how to construct output scripts from keys. A "Wallet Policy" consists
of a "Descriptor Template" and a list of "keys". A key is basically
a serialized BIP32 extended public key with some added derivation path
information. This is documented at


#### Parameters

* descriptorTemplate DefaultDescriptorTemplate
* key string

$3

This implements the "Transaction Extractor" role of BIP370 (PSBTv2
). However
the role is partially documented in BIP174 (PSBTv0
).

#### Parameters

* psbt PsbtV2

Returns Buffer

$3

This roughly implements the "input finalizer" role of BIP370 (PSBTv2
). However
the role is documented in BIP174 (PSBTv0
).

Verify that all inputs have a signature, and set inputFinalScriptwitness
and/or inputFinalScriptSig depending on the type of the spent outputs. Clean
fields that aren't useful anymore, partial signatures, redeem script and
derivation paths.

#### Parameters

* psbt PsbtV2 The psbt with all signatures added as partial sigs, either
through PSBT\_IN\_PARTIAL\_SIG or PSBT\_IN\_TAP\_KEY\_SIG

Returns void

$3

Deletes fields that are no longer neccesary from the psbt.

Note, the spec doesn't say anything about removing ouput fields
like PSBT\_OUT\_BIP32\_DERIVATION\_PATH and others, so we keep them
without actually knowing why. I think we should remove them too.

#### Parameters

* psbt PsbtV2
* inputIndex number

$3

Writes a script push operation to buf, which looks different
depending on the size of the data. See


#### Parameters

* buf BufferWriter the BufferWriter to write to
* data Buffer the Buffer to be pushed.

$3

Implements Partially Signed Bitcoin Transaction version 2, BIP370, as
documented at
and

A psbt is a data structure that can carry all relevant information about a
transaction through all stages of the signing process. From constructing an
unsigned transaction to extracting the final serialized transaction ready for
broadcast.

This implementation is limited to what's needed in ledgerjs to carry out its
duties, which means that support for features like multisig or taproot script
path spending are not implemented. Specifically, it supports p2pkh,
p2wpkhWrappedInP2sh, p2wpkh and p2tr key path spending.

This class is made purposefully dumb, so it's easy to add support for
complemantary fields as needed in the future.

$3

#### Parameters

* $0 Transaction

* $0.outputs

#### Examples

`javascript
const tx1 = acre.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
const outputScript = acre.serializeTransactionOutputs(tx1).toString('hex');
`

Returns Buffer

$3

Type: {inputs: Array<\[Transaction, number, (string | null | undefined), (number | null | undefined)]>, associatedKeysets: Array<string>, outputScriptHex: string, lockTime: number?, sigHashType: number?, segwit: boolean?, transactionVersion: number?}

#### Properties

* inputs Array<\[Transaction, number, (string | null | undefined), (number | null | undefined)]>
* associatedKeysets Array<string>
* outputScriptHex string
* lockTime number?
* sigHashType number?
* segwit boolean?
* transactionVersion` number?

$3

$3

$3