PayInvoiceCommand class
Pay an invoice (builds BEEF, does NOT broadcast)
- Inheritance
-
- Object
- CoordinatorRequest<
PaymentReadyEvent> - PayInvoiceCommand
Constructors
-
PayInvoiceCommand({required String walletId, required String invoiceId, required List<
String> addresses, required BigInt amount, List<InvoiceOutputSpec> ? outputs, String? changeAddress, Map<String, dynamic> ? paymentMetadata, String? counterpartyMarker, String? memo, DateTime? deadline, PaymentPrivacy? privacy, String? requestId})
Properties
-
addresses
→ List<
String> -
final
- amount → BigInt
-
final
- changeAddress → String?
-
final
- correlationId → String
-
The correlation ID of the message.
no setterinherited
- counterpartyMarker → String?
-
The app's opaque marker for the counterparty of this payment (bead
libspiffy-cq16, spv-understanding.md "Core Data Management"
requirement 5): an Ed25519 identity key, an email address, a peer id,
an internal account id — whatever the app uses for identity. It is
stored with the payment and returned by the transaction queries;
libspiffy never interprets, validates or parses it, and the identity
record itself stays with the app. Null when none is supplied.
final
- deadline → DateTime?
-
When the wallet reclaims this payment by itself if it is still
outstanding then (bead libspiffy-8442): a half the counterparty has
not completed, a payment the recipient has not broadcast. Null for
never. The deadline bounds the option; the reclaim ends it only once
the network has it.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- invoiceId → String
-
final
- memo → String?
-
The payment's note, written by the payer for the payee. libspiffy
journals it and returns it and never interprets it. Null when none.
final
-
metadata
→ Map<
String, dynamic> -
The metadata of the message.
no setter
-
outputs
→ List<
InvoiceOutputSpec> ? -
final
-
paymentMetadata
→ Map<
String, dynamic> ? -
final
- privacy → PaymentPrivacy?
-
Split change and spread inputs; null builds the payment as before.
final
- replyTimeout → Duration
-
How long
WalletCoordinator.askwaits for the reply when the caller gives no timeout. A request that is still running then is not cancelled: its reply arrives on the event stream later.no setteroverride - replyTo → ActorRef?
-
The actor to reply to.
no setterinherited
- requestId → String
-
Identifies this request; its reply carries it back.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timestamp → DateTime
-
The timestamp of the message.
finalinherited
- walletId → String
-
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited