Settlement account example
+Settlement account example
+ You deposit \$10,000 into a peer's liquidity account, meaning you've extended a credit line of \$10,000 to your peer. Your peer liquidity account balance is \$10,000 and your USD settlement account balance is now -\$10,000. diff --git a/packages/documentation/src/content/docs/resources/get-involved.mdx b/packages/documentation/src/content/docs/resources/get-involved.mdx index 5bcbdada4e..1e0847650e 100644 --- a/packages/documentation/src/content/docs/resources/get-involved.mdx +++ b/packages/documentation/src/content/docs/resources/get-involved.mdx @@ -13,7 +13,6 @@ Welcome to the Rafiki community! Whether you're a seasoned developer or just get - **Explore the project**: Browse theExpand for event sequence
- $2.55 was received before the payment expired. The recipient is thus credited with $2.55. + +$2.55 was received before the payment expired. The recipient is thus credited with $2.55.Expand for event sequence
- An outgoing payment for $12 was created. + +An outgoing payment for $12 was created.Expand for event sequences
-{' '} +debitAmount: $12, sentAmount: $11.50 - ASE->>R: Backend Admin API call: createOutgoingPaymentWithdrawal - R-->>ASE: success: true - ASE->>ASE: Remove hold and deduct $12 from sender's account,
credit your account with $0.50 + R->>ASE: Fires outgoing_payment.completed event to webhook endpoint,
debitAmount: $12, sentAmount: $11.50 + ASE->>R: Backend Admin API call: createOutgoingPaymentWithdrawal + R-->>ASE: success: true + ASE->>ASE: Remove hold and deduct $12 from sender's account,
credit your account with $0.50 `} /> {' '} -
debitAmount: $12, sentAmount: $11.50 - ASE->>R: Backend Admin API call: createOutgoingPaymentWithdrawal - R-->>ASE: success: true - ASE->>ASE: Remove hold and deduct $12 from sender's account,
credit your account with $0.50 - ASE->>R: Backend Admin API call: postLiquidityWithdrawal - R-->>ASE: success: true - R->>R: Two-phase transfer complete + R->>ASE: Fires outgoing_payment.completed event to webhook endpoint,
debitAmount: $12, sentAmount: $11.50 + ASE->>R: Backend Admin API call: createOutgoingPaymentWithdrawal + R-->>ASE: success: true + ASE->>ASE: Remove hold and deduct $12 from sender's account,
credit your account with $0.50 + ASE->>R: Backend Admin API call: postLiquidityWithdrawal + R-->>ASE: success: true + R->>R: Two-phase transfer complete `} /> @@ -433,7 +433,8 @@ If there is excess liquidity in Rafiki due to differences between the sent and r
Expand for event sequence
- An outgoing payment for $12 failed. $8 was sent successfully. + +An outgoing payment for $12 failed. $8 was sent successfully.Expand for event sequence
+ The wallet address, `https://wallet.example.com/carla_garcia` was requested but does not exist.Expand for event sequence
- A wallet address received a Web Monetization payment of $0.33 + +A wallet address received a Web Monetization payment of $0.33Expand for event sequence
- Your asset liquidity for USD (asset scale: 2) drops below $100.00. + +Your asset liquidity for USD (asset scale: 2) drops below $100.00.Expand for event sequence
+ The liquidity for your peer, Happy Life Bank, drops below $100.00 USD.
- 
+
+
+
-
-
+
@@ -2027,33 +913,14 @@
-
-
- Information to aid in pagination.
-
-
-
-
- A list of edges representing grants and cursors for
- pagination.
+ Information to aid in pagination.
+
+
+ A list of edges representing grants and cursors for pagination.
@@ -2071,11 +938,7 @@
Fields
pageInfo
- -
- PageInfo!
- edges
- -
- [GrantEdge!]!
+ pageInfo - PageInfo!
edges - [GrantEdge!]!
Example
ID
Description
-
- The ID scalar type represents a unique
- identifier, often used to refetch an object or as key for a
- cache. The ID type appears in a JSON response as a String;
- however, it is not intended to be human-readable. When
- expected as an input type, any string (such as
- "4") or integer (such as
- 4) input value will be accepted as an ID.
-
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
@@ -2104,11 +959,7 @@
Example
Int
Description
-
- The Int scalar type represents non-fractional
- signed whole numeric values. Int can represent values
- between -(2^31) and 2^31 - 1.
-
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
-987
+ 123
Fields
receiver
- -
- String
- debitAmount
- -
- PaymentAmount
- receiveAmount
- -
- PaymentAmount
- interval
- -
- String
- receiver - String
+ debitAmount - PaymentAmount
+ receiveAmount - PaymentAmount
+ interval - String
+ Fields
Example
{
- "receiver": "xyz789",
+ "receiver": "abc123",
"debitAmount": PaymentAmount,
"receiveAmount": PaymentAmount,
- "interval": "xyz789"
+ "interval": "abc123"
}
Model
-
-
+
@@ -2252,34 +1053,19 @@
-
+
@@ -2444,54 +1175,19 @@
-
-
- The value of the payment amount.
-
-
-
-
- Should be an ISO 4217 currency code whenever possible,
- e.g.
-
-
-
- The value of the payment amount.
+
+
+
- Difference in orders of magnitude between the standard
- unit of an asset and a corresponding fractional unit.
+ Should be an ISO 4217 currency code whenever possible, e.g.
+
+
+ Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit.
@@ -2510,11 +1206,7 @@
Fields
- id -
- ID!
+ | id - ID!
|
- Unique identifier for the model. | +Unique identifier for the model. |
- createdAt
- -
- String!
+ | createdAt - String!
|
- The date and time when the model was created. | +The date and time when the model was created. |
+
@@ -2290,16 +1076,17 @@
@@ -2413,7 +1148,7 @@
- Possible Types
|
-
- |
|||
|
-
- |
+ |||
| + | |||
- endCursor
- -
- String
- |
- - The cursor used to fetch the next page when paginating - forward. + | endCursor - String
|
+ The cursor used to fetch the next page when paginating forward. |
- hasNextPage
- -
- Boolean!
- |
- - Indicates if there are more pages when paginating - forward. + | hasNextPage - Boolean!
|
+ Indicates if there are more pages when paginating forward. |
- hasPreviousPage
- -
- Boolean!
- |
- - Indicates if there are more pages when paginating - backward. + | hasPreviousPage - Boolean!
|
+ Indicates if there are more pages when paginating backward. |
- startCursor
- -
- String
- |
- - The cursor used to fetch the next page when paginating - backward. + | startCursor - String
|
+ The cursor used to fetch the next page when paginating backward. |
Fields
Example
{
"endCursor": "xyz789",
- "hasNextPage": false,
+ "hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
@@ -2422,11 +1157,7 @@ Example
Fields
value
- -
- UInt64!
- assetCode
- -
- String!
+ value - UInt64!
USD. For more information, refer to
- assets.
- assetScale
- -
- UInt8!
+ assetCode - String!
USD. For more information, refer to assets. assetScale - UInt8!
Example
Fields
grantId
- -
- String!
- grantId - String!
+
+ Example
Fields
id -
- ID!
+ id - ID!
Fields
Example
-{"id": "4"}
+ {"id": 4}
Values
ASC
DESC
Example
String
Description
-
- The String scalar type represents textual data,
- represented as UTF-8 character sequences. The String type is
- most often used by GraphQL to represent free-form
- human-readable text.
-
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
@@ -2677,11 +1340,98 @@
Example
+ Types
+
+ Subject
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
sub_ids - [SubjectItem!]!
+ |
+ + | +
+
+
+
+ Example
+{"sub_ids": [SubjectItem]}
+
+ Types
+
+ SubjectItem
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ Unique identifier of the subject object. | +
subId - String!
+ |
+ Wallet address of the subject's account. | +
subIdFormat - String!
+ |
+ Format of the subject identifier | +
createdAt - String!
+ |
+ The date and time when the subject was created. | +
+
+
+
+ Example
+{
+ "id": "4",
+ "subId": "xyz789",
+ "subIdFormat": "xyz789",
+ "createdAt": "xyz789"
+}
+UInt64
Description
-
- The UInt64 scalar type represents unsigned
- 64-bit whole numeric values. It is capable of handling
- values that are larger than the JavaScript
- Number type limit (greater than 2^53).
-
The UInt64 scalar type represents unsigned 64-bit whole numeric values. It is capable of handling values that are larger than the JavaScript Number type limit (greater than 2^53).
@@ -2707,11 +1452,7 @@
Example
UInt8
Description
-
- The UInt8 scalar type represents unsigned 8-bit
- whole numeric values, ranging from 0 to 255.
-
The UInt8 scalar type represents unsigned 8-bit whole numeric values, ranging from 0 to 255.
@@ -2740,4 +1478,4 @@
-