Skip to content

fix(docs): update definitions of two attestation types #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikerzetic-aflabs merged 1 commit into from
Sep 8, 2025
Merged

fix(docs): update definitions of two attestation types #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/fdc/attestation-types/balance-decreasing-transaction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ A transaction is considered "balance decreasing" for the specified address if:

## Response

| Field | Solidity Type | Description |
| -------------------------- | ------------- | ---------------------------------------------------------------------- |
| `blockNumber` | `uint64` | Block number containing the transaction. |
| `blockTimestamp` | `uint64` | Timestamp of the block containing the transaction. |
| `sourceAddressHash` | `bytes32` | Standard hash of the address indicated by `sourceAddressIndicator`. |
| `spentAmount` | `int256` | Amount spent by the source address in minimal units (can be negative). |
| `standardPaymentReference` | `bytes32` | Standardized payment reference of the transaction, if available. |
| Field | Solidity Type | Description |
| -------------------------- | ------------- | ---------------------------------------------------------------------------------------------- |
| `blockNumber` | `uint64` | Block number containing the transaction. |
| `blockTimestamp` | `uint64` | Timestamp of the block containing the transaction. |
| `sourceAddressHash` | `bytes32` | Standard hash of the address indicated by `sourceAddressIndicator`. |
| `spentAmount` | `int256` | Amount spent by the source address in minimal units (can be negative). |
| `standardPaymentReference` | `bytes32` | Standard payment reference of the transaction. Zero value if the transaction has no reference. |

:::warning[Standard Payment Reference]

Expand Down Expand Up @@ -79,6 +79,7 @@ The verification process is chain-specific and can be computed with a [balance d

- `spentAmount`: Difference between the balance of the address **after** and **before** the transaction. Can be negative.
- `blockTimestamp`: The **close_time** of the ledger, converted to Unix time.
- `standardPaymentReference`: [Standard payment reference] for `Payment` transactions, otherwise zero.

:::note[Lowest used timestamp]

Expand Down
10 changes: 5 additions & 5 deletions docs/fdc/attestation-types/payment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ These provable payments mimic traditional banking transactions where entity A se

## Request

| Field | Solidity Type | Description |
| --------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `transactionId` | `bytes32` | Unique ID of the payment transaction. |
| `inUtxo` | `uint256` | For UTXO-based chains, this is the index of the transaction input associated with the source address. Set to `0` for non-UTXO chains. |
| `utxo` | `uint256` | For UTXO-based chains, this is the index of the transaction output associated with the receiving address. Set to `0` for non-UTXO chains. |
| Field | Solidity Type | Description |
| --------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transactionId` | `bytes32` | Unique ID of the payment transaction. |
| `inUtxo` | `uint256` | For UTXO chains, if the value is less than `2**16`, this field is the index of the transaction input with the source address. Otherwise, it represents the `standardAddressHash` of the input address for which the payment proof will be constructed. For non-UTXO chains, this is always `0`. |
| `utxo` | `uint256` | For UTXO chains, if the value is less than `2**16`, this field is the index of the transaction output with the receiving address. Otherwise, it represents the `standardAddressHash` of the output address for which the payment proof will be constructed. For non-UTXO chains, this is always `0`. |

## Response

Expand Down
Loading