Class SettlementPlan

Namespace

NArk.Abstractions.Settlement

Assembly

NArk.Abstractions.dll

A policy's decision: settle Amount of SourceAsset to Destination.

public record SettlementPlan : IEquatable<SettlementPlan>

Inheritance

object

SettlementPlan

Implements

IEquatable<SettlementPlan>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SettlementPlan(SettlementDestination, long, string, IReadOnlyCollection<ArkCoin>?, string?)

A policy's decision: settle Amount of SourceAsset to Destination.

public SettlementPlan(SettlementDestination Destination, long Amount, string SourceAsset = "BTC", IReadOnlyCollection<ArkCoin>? Coins = null, string? Reference = null)

Parameters

Destination SettlementDestination

Where the funds should go.

Amount long

How much to move, in SourceAsset's atomic units — satoshis for BTC.

SourceAsset string

What leaves the wallet: Btc (the default) or the id of an Arkade-issued asset. This is the source side only; a rail that converts may deliver a different asset at Destination.

Coins IReadOnlyCollection<ArkCoin>

The exact coins to spend, when the policy picked them — the settlement counterpart of the coins an ISweepPolicy yields. null leaves coin selection to the settlement rail.

Reference string

Optional correlation id carried into Reference.

Properties

Amount

How much to move, in SourceAsset's atomic units — satoshis for BTC.

public long Amount { get; init; }

Property Value

long

Coins

The exact coins to spend, when the policy picked them — the settlement counterpart of the coins an ISweepPolicy yields. null leaves coin selection to the settlement rail.

public IReadOnlyCollection<ArkCoin>? Coins { get; init; }

Property Value

IReadOnlyCollection<ArkCoin>

Destination

Where the funds should go.

public SettlementDestination Destination { get; init; }

Property Value

SettlementDestination

Reference

Optional correlation id carried into Reference.

public string? Reference { get; init; }

Property Value

string

SourceAsset

What leaves the wallet: Btc (the default) or the id of an Arkade-issued asset. This is the source side only; a rail that converts may deliver a different asset at Destination.

public string SourceAsset { get; init; }

Property Value

string