PaymentRequest (DotNetLightning)

PaymentRequest Type

Namespace: DotNetLightning.Payment
Assembly: DotNetLightning.Core.dll
Base Type: obj
All Interfaces: IEquatable<PaymentRequest>

bolt11 invoice.

Record fields

Record Field	Description
`Amount` Full Usage: `Amount` Field type: `LNMoney option`	Field type: `LNMoney option`
`NodeId` Full Usage: `NodeId` Field type: `NodeId`	Field type: `NodeId`
`Prefix` Full Usage: `Prefix` Field type: `string`	Field type: `string`
`Signature` Full Usage: `Signature` Field type: `(LNECDSASignature * byte) option`	Field type: `(LNECDSASignature * byte) option`
`Tags` Full Usage: `Tags` Field type: `TaggedFields`	Field type: `TaggedFields`
`Timestamp` Full Usage: `Timestamp` Field type: `DateTimeOffset`	Field type: `DateTimeOffset`

Instance members

Instance member	Description
`this.AmountValue` Full Usage: `this.AmountValue` Returns: `LNMoney option`	Returns: `LNMoney option`
`this.Description` Full Usage: `this.Description` Returns: `Choice<string, uint256>`	Returns: `Choice<string, uint256>`
`this.Expiry` Full Usage: `this.Expiry` Returns: `DateTimeOffset`	absolute expiry date. Returns: `DateTimeOffset`
`this.FallbackAddresses` Full Usage: `this.FallbackAddresses` Returns: `string list`	Returns: `string list`
`this.Features` Full Usage: `this.Features` Returns: `FeatureBits option`	Returns: `FeatureBits option`
`this.HumanReadablePart` Full Usage: `this.HumanReadablePart` Returns: `string`	Returns: `string`
`this.IsExpired` Full Usage: `this.IsExpired` Returns: `bool`	Returns: `bool`
`this.MinFinalCLTVExpiryDelta` Full Usage: `this.MinFinalCLTVExpiryDelta` Returns: `BlockHeightOffset32`	Returns: `BlockHeightOffset32`
`this.NodeIdValue` Full Usage: `this.NodeIdValue` Returns: `NodeId`	Returns: `NodeId`
`this.PaymentHash` Full Usage: `this.PaymentHash` Returns: `PaymentHash`	Returns: `PaymentHash`
`this.PaymentSecret` Full Usage: `this.PaymentSecret` Returns: `uint256 option`	Returns: `uint256 option`
`this.PrefixValue` Full Usage: `this.PrefixValue` Returns: `string`	Returns: `string`
`this.RoutingInfo` Full Usage: `this.RoutingInfo` Returns: `ExtraHop list list`	Returns: `ExtraHop list list`
`this.Sign` Full Usage: `this.Sign` Parameters: privKey : `Key` ?forceLowR : `bool` Returns: `PaymentRequest`	privKey : `Key` ?forceLowR : `bool` Returns: `PaymentRequest`
`this.SignatureValue` Full Usage: `this.SignatureValue` Returns: `(LNECDSASignature * byte) option`	Returns: `(LNECDSASignature * byte) option`
`this.TagsValue` Full Usage: `this.TagsValue` Returns: `TaggedFields`	Returns: `TaggedFields`
`this.TimestampValue` Full Usage: `this.TimestampValue` Returns: `DateTimeOffset`	Returns: `DateTimeOffset`
`this.ToString` Full Usage: `this.ToString` Parameters: signer : `IMessageSigner` Returns: `string`	signer : `IMessageSigner` Returns: `string`

Static members

Static member	Description
`PaymentRequest.Parse(str)` Full Usage: `PaymentRequest.Parse(str)` Parameters: str : `string` Returns: `Result<PaymentRequest, string>`	str : `string` Returns: `Result<PaymentRequest, string>`
`PaymentRequest.TryCreate(prefix, amount, timestamp, nodeId, tags, signer)` Full Usage: `PaymentRequest.TryCreate(prefix, amount, timestamp, nodeId, tags, signer)` Parameters: prefix : `string` amount : `LNMoney option` timestamp : `DateTimeOffset` nodeId : `NodeId` tags : `TaggedFields` signer : `IMessageSigner` Returns: `Result<PaymentRequest, string>`	signer must sign by node_secret which corresponds to node_id prefix : `string` amount : `LNMoney option` timestamp : `DateTimeOffset` nodeId : `NodeId` tags : `TaggedFields` signer : `IMessageSigner` Returns: `Result<PaymentRequest, string>`
`PaymentRequest.TryCreate(prefix, amount, timestamp, nodeId, tags, nodeSecret)` Full Usage: `PaymentRequest.TryCreate(prefix, amount, timestamp, nodeId, tags, nodeSecret)` Parameters: prefix : `string` amount : `LNMoney option` timestamp : `DateTimeOffset` nodeId : `NodeId` tags : `TaggedFields` nodeSecret : `Key` Returns: `Result<PaymentRequest, string>`	prefix : `string` amount : `LNMoney option` timestamp : `DateTimeOffset` nodeId : `NodeId` tags : `TaggedFields` nodeSecret : `Key` Returns: `Result<PaymentRequest, string>`
`PaymentRequest.TryCreate(prefix, amount, timestamp, tags, nodeSecret)` Full Usage: `PaymentRequest.TryCreate(prefix, amount, timestamp, tags, nodeSecret)` Parameters: prefix : `string` amount : `LNMoney option` timestamp : `DateTimeOffset` tags : `TaggedFields` nodeSecret : `Key` Returns: `Result<PaymentRequest, string>`	prefix : `string` amount : `LNMoney option` timestamp : `DateTimeOffset` tags : `TaggedFields` nodeSecret : `Key` Returns: `Result<PaymentRequest, string>`
`PaymentRequest.TryCreate(network, amount, timestamp, tags, nodeSecret)` Full Usage: `PaymentRequest.TryCreate(network, amount, timestamp, tags, nodeSecret)` Parameters: network : `Network` amount : `LNMoney option` timestamp : `DateTimeOffset` tags : `TaggedFields` nodeSecret : `Key` Returns: `Result<PaymentRequest, string>`	network : `Network` amount : `LNMoney option` timestamp : `DateTimeOffset` tags : `TaggedFields` nodeSecret : `Key` Returns: `Result<PaymentRequest, string>`