Skip to content

Add descriptions to AccountingInfo and Settlement schemas #769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
crtahlin wants to merge 1 commit into from
Closed

Add descriptions to AccountingInfo and Settlement schemas #769

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions openapi/SwarmCommon.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,25 @@ components:
type: object
properties:
balance:
description: Current SWAP balance with the peer. Negative values indicate debt owed to the peer, positive values indicate credit owed by the peer.
$ref: "#/components/schemas/BigInt"
thresholdReceived:
description: Payment threshold communicated to this peer — the debt limit at which the peer is expected to settle.
$ref: "#/components/schemas/BigInt"
thresholdGiven:
description: Payment threshold received from this peer — the debt limit at which this node is expected to settle. Adjusts over time based on the peer's repayment history.
$ref: "#/components/schemas/BigInt"
surplusBalance:
description: Surplus from incoming payments that exceeded the outstanding debt. Not considered debt for settlement purposes.
$ref: "#/components/schemas/BigInt"
reservedBalance:
description: Amount currently reserved for an active peer interaction to prevent overdrafts during concurrent operations.
$ref: "#/components/schemas/BigInt"
shadowReservedBalance:
description: Amount potentially to be debited for an active peer interaction. Reserves anticipated debits before they are applied.
$ref: "#/components/schemas/BigInt"
ghostBalance:
description: Amount that could have been debited but was not, used to detect misbehaving peers.
$ref: "#/components/schemas/BigInt"

ActGranteesCreateRequest:
Expand Down Expand Up @@ -594,20 +601,26 @@ components:
type: object
properties:
peer:
description: Swarm overlay address of the peer.
$ref: "#/components/schemas/SwarmAddress"
received:
description: Total amount of xBZZ (in PLUR) received from this peer through SWAP cheque settlements.
type: integer
sent:
description: Total amount of xBZZ (in PLUR) sent to this peer through SWAP cheque settlements.
type: integer

Settlements:
type: object
properties:
totalReceived:
description: Total amount of xBZZ (in PLUR) received from all peers through SWAP cheque settlements.
type: integer
totalSent:
description: Total amount of xBZZ (in PLUR) sent to all peers through SWAP cheque settlements.
type: integer
settlements:
description: Per-peer settlement details.
type: array
nullable: false
items:
Expand Down