Version: 0.23.0
events
The Trustlines events returned by the relay api have the following attributes:
Attribute | Type | Description |
---|---|---|
networkAddress | string | Address of currency network |
blockNumber | string | Number of block |
timestamp | int | UNIX timestamp |
type | string | Either TrustlineUpdate , TrustlineUpdateRequest , TrustlineUpdateCancel , Transfer , DebtUpdate , BalanceUpdate , or NetworkFreeze |
from | string | Address of from user |
to | string | Address of to user |
status | string | sent , pending or confirmed depending on block height |
transactionId | string | Transaction hash |
Following additional attributes for TrustlineUpdate
and TrustlineUpdateRequest
events:
Attribute | Type | Description |
---|---|---|
given | string | Proposed or accepted amount from -> to |
received | string | Proposed or accepted amount to -> from |
interestRateGiven | string | Proposed or accepted rate of interests from -> to |
interestRateReceived | string | Proposed or accepted rate of interests to -> from |
isFrozen | bool | Proposed or accepted frozen state |
Following additional attribute for TrustlineUpdateRequest
events:
Attribute | Type | Description |
---|---|---|
transfer | string | Proposed amount to be transferred, ca be >0 or <0 |
The transfer
attribute represents a proposal of a transfer that will be applied if the trustline is accepted.
The transfer is in the direction from -> to
if the value is positive and to -> from
otherwise,
in the point of view of the initiator of the trustline update.
Following additional attributes for BalanceUpdate
:
Attribute | Type | Description |
---|---|---|
amount | string | New balance of trustline from view of from |
Following additional attributes for Transfer
events:
Attribute | Type | Description |
---|---|---|
amount | string | Transfer amount from -> to |
extraData | string | extraData as specified in the corresponding transfer |
Following additional attributes for DebtUpdated
:
Attribute | Type | Description |
---|---|---|
debt | string | New debt in between from and to in the point of view of from |
#
Example ResponseAn example response for a list of events would be: