Pular para o conteúdo

Transactions

A transaction order is an order to transfer assets or request an operation on the ledger. In the simplest case, it relates to the transfer of a native cryptocurrency; in more advanced cases, it can apply to the execution of smart contract methods and other on-ledger features.

Transaction orders may differ from one ledger protocol to another, but they at least define the account origin, and normally have an amount and a destination address; for some protocols, a single transaction may include multiple destinations and amounts, possibly denominated in various currencies.

Transaction orders rely on property parameters to define ledger-specific transaction order parameters.

We present below the transaction order parameters for Bitcoin:

  • outputs: sequence of pairs of destination and amount;
  • feeStrategy: fee calculation strategy, which may be Low, Medium or High; the actual fee amount corresponding to the selected strategy is automatically set by the system at execution time based on a network metrics;
  • maximumFee: maximum fee the user is willing to pay to execute the transaction; in rare occasions, Harmonize may decide to rebroadcast a transaction with higher fees to ensure inclusion within the ledger, as long as maximumFee has not been reached.

For an exhaustive list corresponding to each respective ledger protocol, we refer to the reference manual.

Harmonize supports multiple types of destinations for transaction orders:

  • ledger address: a ledger address is a protocol-level address, whose format may differ from one ledger protocol to another;
  • account: an account destination is an account id, which is guaranteed to implicitly resolve to an address of the account; for protocols supporting multiple addresses per account, no guarantee is provided over which account address the resolution leads to;
  • endpoint: an endpoint destination is an endpoint id, which is guaranteed to implicitly resolve to the address of the endpoint.

Once a transaction order is fully approved the order becomes executable. The corresponding vault may capture the pending transaction order and build and sign a corresponding ledger transaction.

Transactions are incoming or outgoing ledger transactions that have been detected on the ledger or shall be broadcast. Transfers are the financial representation of their corresponding transactions.

List transaction orders

Requisição

Segurança
httpAuth
Caminho
domainIdstring, (uuid)obrigatório

Unique identifier for the domain.

Consulta
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""accountId""metadata.createdAt""metadata.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
accountIdArray of strings, (uuid)

Return entities matching given accountId.

Exemplo:accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&accountId=fdeeeb4b-f987-4ec4-9880-1eb280581d49
ledgerIdArray of strings

Return entities matching given ledgerId.

Exemplo:ledgerId=ledgerId1&ledgerId=ledgerId2
intentIdstring, (uuid)

Return entities matching given intentId.

Exemplo:intentId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
parameters.typestring

Return entities that matches given parameter type.

Enum:"Algorand""Bitcoin""BitcoinRedirect""Cardano""Ethereum""Hedera""Solana""Substrate""Tezos""XRPL"
Exemplo:parameters.type=XRPL
metadata.createdBystring, (uuid)

Return entities that were created by matching user.

Exemplo:metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49
metadata.lastModifiedBystring, (uuid)

Return entities that were last modified by matching user.

Exemplo:metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
metadata.createdAt.ltstring, (date-time)

Used to return only results created before the given date/time (lt=less than)

Exemplo:metadata.createdAt.lt=2022-11-22T14:06:00.0000000+00:00
metadata.createdAt.gtstring, (date-time)

Used to return only results created after the given date/time (gt=greater than)

Exemplo:metadata.createdAt.gt=2022-11-22T14:06:00.0000000+00:00
metadata.lastModifiedAt.ltstring, (date-time)

Used to return only results last modified before the given date/time (lt=less than)

Exemplo:metadata.lastModifiedAt.lt=2022-11-22T14:06:00.0000000+00:00
metadata.lastModifiedAt.gtstring, (date-time)

Used to return only results last modified after the given date/time (gt=greater than)

Exemplo:metadata.lastModifiedAt.gt=2022-11-22T14:06:00.0000000+00:00
metadata.descriptionstring, >= 0 characters

Return entities with descriptions that contains or equals to provided description.

Exemplo:metadata.description=description1
metadata.customPropertiesArray of strings

Return entities that contains provided custom properties.

Exemplo:metadata.customProperties=key1:value1&metadata.customProperties=key2:value2
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/devbox/v1/domains/{domainId}/transactions/orders?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be%2Cfdeeeb4b-f987-4ec4-9880-1eb280581d49&ledgerId=ledgerId1%2CledgerId2&intentId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&parameters.type=XRPL&metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49&metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&metadata.createdAt.lt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.createdAt.gt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.lastModifiedAt.lt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.lastModifiedAt.gt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&metadata.description=description1&metadata.customProperties=key1%3Avalue1%2Ckey2%3Avalue2' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json
itemsArray of objectsobrigatório
countinteger, (int32)obrigatório
currentStartingAfterstring
nextStartingAfterstring
Resposta
{ "items": [ { … } ], "count": 0, "currentStartingAfter": "string", "nextStartingAfter": "string" }