Mock LND

Create mocking versions of LND gRPC for use in unit tests.

makeForwardsResponse

Make a forwardingHistory response

{
  offset: <Paging Offset Number>
}

@returns
<LND Forwards gRPC Response Object>

makeInvoice

Lookup invoice mock response

{
  [description_hash]: <Description Hash Hex String>
  [is_confirmed]: <Invoice is Settled Bool>
  [is_push]: <Invoice is KeySend Bool>
  [payments]: [<Payment Object>]
}

@returns
<LND Invoice gRPC Response Object>

makeInvoiceSubscription

Make an invoice subscription

{
  invoice: <Invoice Data Object>
}

@returns
<EventEmitter Object>

makeLnd

Make an LND mock object for testing

{
  fundPsbt: <Override Fund PSBT Function>
  getChainTransactions: <Override Get Chain Transactions Response Function>
  getChannels: <Override Get Channels Response Function>
  getForwards: <Override Get Forwards Response Function>
  getInvoice: <Override Get Invoice Response Function>
  getUtxos: <Override Get Utxos Response Function>
  getWalletVersion: <Override Get Wallet Version Response Function>
  payViaRoutes: <Override Pay Via Routes Function>
  subscribeToInvoice: <Override Subscribe to Invoice Emitter>
  subscribeToPay: <Override Subscribe to Pay Emitter>
}

@returns
<Mock Authenticated LND API Object>

makePaySubscription

Make a payment subscription

{
  [payment]: <Payment Data Object>
}

@returns
<EventEmitter Object>

makePayViaRoutesResponse

Make a response for send to route

{
  [is_unknown_failure]: <Route is Failed Bool>
}

@returns
<Paid Via Routes Response Object>

makePaymentData

Make payment data

{
  [htlcs]: [<HTLC Object>]
}

@returns
<Payment Object>

makePaymentRequest

Make a BOLT 11 payment request

{
  [mtokens]: <Millitokens String>
}

@returns
{
  request: <BOLT 11 Payment Request String>
}

makeWalletVersionResponse

Make a response for getVersion

{
  [hash]: <Override Commit Hash Hex String>
}

@returns
<GetVersion Response Object>

Versions

2.0.0

Breaking Changes

• Require node v18 or higher
• makePaymentRequest: Ecpair factory argument ecp is now required

1.4.4

• makeLnd: Support previous outpoints in chain transactions

1.4.3

• makeLnd: Fix support for confirmed invoices

1.4.2

• makeLnd: Fix support for channel list past LND 0.15.0

1.4.1

• makeLnd: Add support for getChainTransactions method and override
• makeLnd: Add support for getChannels method and override
• makeLnd: Add support for getPendingChannels method
• makeLnd: Add support for getUtxos method and override

1.3.0

• makeLnd: Add support for fundPsbt method and override
• makeLnd: Add support for getChainFeeRate method
• makeLnd: Add support for getWalletVersion method and override
• makeLnd: Add support for signPsbt method
• makeLnd: Add support for unlockUtxo method
• makeWalletVersionResponse: Add method to create a wallet version

1.2.1

• makeLnd: Add support for forwards and add payViaRoutes override
• makePayViaRoutesResponse: Add method to make pay via routes response

1.1.0

• makeForwardsResponse: Add method to create a forwards response
• makeLnd: Add support for forwards and add getForwards override

1.0.1

• makeInvoice: Add method to make an invoice message
• makeInvoiceSubscription: Add method to make an invoice subscription
• makeLnd: Add method to make a mock LND Authenticated gRPC object
• makePaySubscription: Add method to make a pay subscription
• makePaymentData: Add method to make a payment data message
• makePaymentRequest: Add method to construct a payment request