SonaCORE

Referência / Quadra Core API

Journal

4 operações em Quadra Core API 0.5.0.

GET/v1/journal/accounts/{account_id}

List an account's journal deltas (JACC)

Parâmetros

NomeTipoDetalhe
account_idstringpathobrigatório
orderstringquery asc or desc (default newest-first)
limitintegerquery
cursorstring, opcionalquery

Respostas

StatusCorpoDetalhe
200AccountJournalListResponseResposta bem-sucedida
422HTTPValidationErrorErro de validação
GET/v1/journal/entries

List journal entries by sequence range

Parâmetros

NomeTipoDetalhe
from_seqintegerquery Range start (inclusive; default 0 = genesis)
to_seqinteger, opcionalquery Range end (inclusive; default = head)
orderstringquery asc or desc
limitintegerquery
cursorstring, opcionalquery

Respostas

StatusCorpoDetalhe
200JournalEntryListResponseResposta bem-sucedida
422HTTPValidationErrorErro de validação
GET/v1/journal/entries/{seq_no}

Get one journal entry (includes the canonical payload)

Parâmetros

NomeTipoDetalhe
seq_nointegerpathobrigatório

Respostas

StatusCorpoDetalhe
200JournalEntryDetailResposta bem-sucedida
422HTTPValidationErrorErro de validação
GET/v1/journal/obligations/{obligation_id}

Journal correlation for an obligation (creation + consumption entries)

Parâmetros

NomeTipoDetalhe
obligation_idstringpathobrigatório
limitintegerquery
cursorstring, opcionalquery

Respostas

StatusCorpoDetalhe
200ObligationJournalResponseResposta bem-sucedida
422HTTPValidationErrorErro de validação

Esquemas

Os modelos que as operações acima aceitam e devolvem. Campos opcionais estão marcados como tal; um campo tipado como outro modelo está documentado sob o nome dele.

AccountJournalEntryItem

One JACC row: the account-scoped delta of one committed entry.

CampoTipoDetalhe
action_typeintegerobrigatório
action_type_namestringobrigatório
commit_timestampstringobrigatório
consumedarray de AccountJournalDeltaPadrão []
createdarray de AccountJournalDeltaPadrão []
seq_nointegerobrigatório

AccountJournalListResponse

CampoTipoDetalhe
account_idstringobrigatório
itemsarray de AccountJournalEntryItemobrigatório
journal_head_seqinteger, opcional
next_cursorstring, opcional

HTTPValidationError

CampoTipoDetalhe
detailarray de ValidationError

JournalEntryDetail

CampoTipoDetalhe
accountsarray de stringPadrão []
action_typeintegerobrigatóriouint16 RFC-010 action code
action_type_namestringobrigatórioRegistry name, or UNKNOWN_<code>
commit_timestampstringobrigatórioISO-8601 instant (from commit_timestamp_unix_ms)
commit_timestamp_unix_msintegerobrigatório
controller_sigstring, opcional
evidence_hashstring, opcional
hydra_tx_hashstringobrigatório
input_positionsarray de JournalPositionProjectionPadrão []
journal_hashstringobrigatório
output_positionsarray de JournalPositionProjectionPadrão []
payload_b64stringobrigatórioCanonical RFC-010 CBOR payload (base64); BLAKE2b-256 of it is journal_hash
prev_journal_hashstringobrigatório
seq_nointegerobrigatório
value_movementsarray de objectPadrão []

JournalEntryItem

CampoTipoDetalhe
accountsarray de stringPadrão []
action_typeintegerobrigatóriouint16 RFC-010 action code
action_type_namestringobrigatórioRegistry name, or UNKNOWN_<code>
commit_timestampstringobrigatórioISO-8601 instant (from commit_timestamp_unix_ms)
commit_timestamp_unix_msintegerobrigatório
controller_sigstring, opcional
evidence_hashstring, opcional
hydra_tx_hashstringobrigatório
input_positionsarray de JournalPositionProjectionPadrão []
journal_hashstringobrigatório
output_positionsarray de JournalPositionProjectionPadrão []
prev_journal_hashstringobrigatório
seq_nointegerobrigatório
value_movementsarray de objectPadrão []

JournalEntryListResponse

CampoTipoDetalhe
itemsarray de JournalEntryItemobrigatório
journal_head_seqinteger, opcionalChain head at read time; null when the journal is uninitialised
next_cursorstring, opcional

JournalPositionProjection

One input/output position of a committed entry (plaintext projection). ``account_id`` follows the live read model's attribution (D3): the GSI1 custody owner, or the GSI2 pending-beneficiary for GL clearing positions. ``state`` is the state stamped by the *creating* entry — projection-side flips that happen without a Hydra tx are journal-invisible until Ticket 24 (D6); enrichment fields are null on pre-Ticket-03 entries.

CampoTipoDetalhe
account_idstring, opcional
assetstring, opcional
position_idstringobrigatório
statestring, opcional
valueinteger, opcional

ObligationJournalResponse

CampoTipoDetalhe
itemsarray de JournalEntryItemobrigatórioCreation + consumption entries across the obligation's positions, ascending seq
next_cursorstring, opcional
obligation_idstringobrigatório
positionsarray de ObligationPositionJournalobrigatório

ObligationPositionJournal

JPOS view of one UTxO row of an obligation (RFC-009 §6.2 items 1-2).

CampoTipoDetalhe
assetstring, opcional
consumed_by_seqinteger, opcional
created_by_seqinteger, opcionalNull for pre-journal positions (no JPOS row); 0 = GENESIS
owner_account_idstring, opcional
position_idstringobrigatório
valueinteger, opcional

ValidationError

CampoTipoDetalhe
ctxobject
inputnão declarado
locarray de string ou integerobrigatório
msgstringobrigatório
typestringobrigatório