Journal
4 operações em Quadra Core API 0.5.0.
/v1/journal/accounts/{account_id}List an account's journal deltas (JACC)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| account_id | string | pathobrigatório |
| order | string | query asc or desc (default newest-first) |
| limit | integer | query |
| cursor | string, opcional | query |
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | AccountJournalListResponse | Resposta bem-sucedida |
| 422 | HTTPValidationError | Erro de validação |
/v1/journal/entriesList journal entries by sequence range
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| from_seq | integer | query Range start (inclusive; default 0 = genesis) |
| to_seq | integer, opcional | query Range end (inclusive; default = head) |
| order | string | query asc or desc |
| limit | integer | query |
| cursor | string, opcional | query |
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | JournalEntryListResponse | Resposta bem-sucedida |
| 422 | HTTPValidationError | Erro de validação |
/v1/journal/entries/{seq_no}Get one journal entry (includes the canonical payload)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| seq_no | integer | pathobrigatório |
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | JournalEntryDetail | Resposta bem-sucedida |
| 422 | HTTPValidationError | Erro de validação |
/v1/journal/obligations/{obligation_id}Journal correlation for an obligation (creation + consumption entries)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| obligation_id | string | pathobrigatório |
| limit | integer | query |
| cursor | string, opcional | query |
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | ObligationJournalResponse | Resposta bem-sucedida |
| 422 | HTTPValidationError | Erro 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.
| Campo | Tipo | Detalhe |
|---|---|---|
| action_type | integer | obrigatório |
| action_type_name | string | obrigatório |
| commit_timestamp | string | obrigatório |
| consumed | array de AccountJournalDelta | Padrão [] |
| created | array de AccountJournalDelta | Padrão [] |
| seq_no | integer | obrigatório |
AccountJournalListResponse
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string | obrigatório |
| items | array de AccountJournalEntryItem | obrigatório |
| journal_head_seq | integer, opcional | |
| next_cursor | string, opcional |
HTTPValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| detail | array de ValidationError |
JournalEntryDetail
| Campo | Tipo | Detalhe |
|---|---|---|
| accounts | array de string | Padrão [] |
| action_type | integer | obrigatóriouint16 RFC-010 action code |
| action_type_name | string | obrigatórioRegistry name, or UNKNOWN_<code> |
| commit_timestamp | string | obrigatórioISO-8601 instant (from commit_timestamp_unix_ms) |
| commit_timestamp_unix_ms | integer | obrigatório |
| controller_sig | string, opcional | |
| evidence_hash | string, opcional | |
| hydra_tx_hash | string | obrigatório |
| input_positions | array de JournalPositionProjection | Padrão [] |
| journal_hash | string | obrigatório |
| output_positions | array de JournalPositionProjection | Padrão [] |
| payload_b64 | string | obrigatórioCanonical RFC-010 CBOR payload (base64); BLAKE2b-256 of it is journal_hash |
| prev_journal_hash | string | obrigatório |
| seq_no | integer | obrigatório |
| value_movements | array de object | Padrão [] |
JournalEntryItem
| Campo | Tipo | Detalhe |
|---|---|---|
| accounts | array de string | Padrão [] |
| action_type | integer | obrigatóriouint16 RFC-010 action code |
| action_type_name | string | obrigatórioRegistry name, or UNKNOWN_<code> |
| commit_timestamp | string | obrigatórioISO-8601 instant (from commit_timestamp_unix_ms) |
| commit_timestamp_unix_ms | integer | obrigatório |
| controller_sig | string, opcional | |
| evidence_hash | string, opcional | |
| hydra_tx_hash | string | obrigatório |
| input_positions | array de JournalPositionProjection | Padrão [] |
| journal_hash | string | obrigatório |
| output_positions | array de JournalPositionProjection | Padrão [] |
| prev_journal_hash | string | obrigatório |
| seq_no | integer | obrigatório |
| value_movements | array de object | Padrão [] |
JournalEntryListResponse
| Campo | Tipo | Detalhe |
|---|---|---|
| items | array de JournalEntryItem | obrigatório |
| journal_head_seq | integer, opcional | Chain head at read time; null when the journal is uninitialised |
| next_cursor | string, 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.
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string, opcional | |
| asset | string, opcional | |
| position_id | string | obrigatório |
| state | string, opcional | |
| value | integer, opcional |
ObligationJournalResponse
| Campo | Tipo | Detalhe |
|---|---|---|
| items | array de JournalEntryItem | obrigatórioCreation + consumption entries across the obligation's positions, ascending seq |
| next_cursor | string, opcional | |
| obligation_id | string | obrigatório |
| positions | array de ObligationPositionJournal | obrigatório |
ObligationPositionJournal
JPOS view of one UTxO row of an obligation (RFC-009 §6.2 items 1-2).
| Campo | Tipo | Detalhe |
|---|---|---|
| asset | string, opcional | |
| consumed_by_seq | integer, opcional | |
| created_by_seq | integer, opcional | Null for pre-journal positions (no JPOS row); 0 = GENESIS |
| owner_account_id | string, opcional | |
| position_id | string | obrigatório |
| value | integer, opcional |
ValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| ctx | object | |
| input | não declarado | |
| loc | array de string ou integer | obrigatório |
| msg | string | obrigatório |
| type | string | obrigatório |