Class: Settlement
Defined in: bee-js/src/modules/settlement.ts:11
Settlement operations. Related to the bandwidth incentives and the chequebook.
Accessed as bee.settlement.
Constructors
Constructor
new Settlement(
context):Settlement
Defined in: bee-js/src/modules/settlement.ts:12
Parameters
context
BeeContext
Returns
Settlement
Methods
get()
get(
address,requestOptions?):Promise<Settlements>
Defined in: bee-js/src/modules/settlement.ts:20
Gets the amount of sent and received micropayments from settlements with a peer.
Parameters
address
Swarm address of peer
string | PeerAddress
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Settlements>
getAll()
getAll(
requestOptions?):Promise<AllSettlements>
Defined in: bee-js/src/modules/settlement.ts:31
Gets settlements with all known peers and total amount sent or received.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<AllSettlements>