-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
138 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| components: | ||
| schemas: | ||
| EscrowCancelTransaction: | ||
| $id: EscrowCancelTransaction | ||
| allOf: | ||
| - $ref: '../base.yaml#/components/schemas/BaseTransaction' | ||
| type: object | ||
| description: | | ||
| Return escrowed XRP to the sender. | ||
| required: | ||
| - Owner | ||
| - OfferSequence | ||
| properties: | ||
| Owner: | ||
| type: string | ||
| description: | | ||
| Address of the source account that funded the escrow payment. | ||
| OfferSequence: | ||
| type: integer | ||
| format: uint32 | ||
| description: | | ||
| Transaction sequence (or Ticket number) of EscrowCreate transaction that created the escrow to cancel. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| components: | ||
| schemas: | ||
| EscrowCreateTransaction: | ||
| $id: EscrowCreateTransaction | ||
| allOf: | ||
| - $ref: '../base.yaml#/components/schemas/BaseTransaction' | ||
| type: object | ||
| description: | | ||
| Sequester XRP until the escrow process either finishes or is canceled. | ||
| required: | ||
| - Amount | ||
| - Destination | ||
| properties: | ||
| Amount: | ||
| type: string | ||
| description: | | ||
| Amount of XRP, in drops, to deduct from the sender's balance and escrow. Once escrowed, the XRP | ||
| can either go to the Destination address (after the FinishAfter time) or be returned to the | ||
| sender (after the CancelAfter time). | ||
| Destination: | ||
| type: string | ||
| description: | | ||
| Address to receive escrowed XRP. | ||
| CancelAfter: | ||
| type: integer | ||
| format: uint32 | ||
| description: | | ||
| (Optional) The time, in seconds since the Ripple Epoch, when this escrow expires. This value is | ||
| immutable; the funds can only be returned to the sender after this time. | ||
| FinishAfter: | ||
| type: integer | ||
| format: uint32 | ||
| description: | | ||
| (Optional) The time, in seconds since the Ripple Epoch, when the escrowed XRP can be released to | ||
| the recipient. This value is immutable, and the funds can't be accessed until this time. | ||
| Condition: | ||
| type: string | ||
| description: | | ||
| (Optional) Hex value representing a PREIMAGE-SHA-256 crypto-condition. The funds can only be | ||
| delivered to the recipient if this condition is fulfilled. If the condition is not fulfilled | ||
| before the expiration time specified in the CancelAfter field, the XRP can only revert to the sender. | ||
| DestinationTag: | ||
| type: integer | ||
| format: uint32 | ||
| description: | | ||
| (Optional) Arbitrary tag to further specify the destination for this escrowed payment, such as a | ||
| hosted recipient at the destination address. | ||
| x-custom-validation: | ||
| requireFieldComparison: | ||
| - smallerField: FinishAfter | ||
| largerField: CancelAfter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| components: | ||
| schemas: | ||
| EscrowFinishTransaction: | ||
| $id: EscrowFinishTransaction | ||
| allOf: | ||
| - $ref: '../base.yaml#/components/schemas/BaseTransaction' | ||
| type: object | ||
| description: | | ||
| Deliver XRP from an escrow (held payment) to the recipient. | ||
| required: | ||
| - Owner | ||
| - OfferSequence | ||
| properties: | ||
| Owner: | ||
| type: string | ||
| description: | | ||
| (Required) Address of the source account that funded the escrow. | ||
| OfferSequence: | ||
| type: integer | ||
| format: uint32 | ||
| description: | | ||
| (Required) Transaction sequence of EscrowCreate transaction that created the escrow to finish. | ||
| Condition: | ||
| type: string | ||
| description: | | ||
| (Optional) Hex value matching the previously-supplied PREIMAGE-SHA-256 crypto-condition of the escrow. | ||
| CredentialIDs: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: | | ||
| (Optional) Set of Credentials to authorize a deposit made by this transaction. Each member of the | ||
| array must be the ledger entry ID of a Credential entry in the ledger. For details, see Credential IDs. | ||
| Fulfillment: | ||
| type: string | ||
| description: | | ||
| (Optional) Hex value of the PREIMAGE-SHA-256 crypto-condition fulfillment matching the escrow's Condition. | ||
| x-custom-validation: | ||
| mutualPresence: | ||
| - field1: Condition | ||
| field2: Fulfillment |