Skip to content

Commit

Permalink
Addressed the review comments on the field descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
harsha-stellar-data committed Jul 31, 2024
1 parent 927aac8 commit 50a2550
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions models/docs/sources/contract_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ The address/account that holds the balance of the asset in contract data
{% enddocs %}

{% docs key %}
The encoded key used to identify a specific piece of contract data. This key is typically a hashed value representing the unique identifier for the data entry.
The encoded key used to identify a specific piece of contract data. The encoded key has two components (type and value) where type describes the data type and the value describes the encoded value of the data type for the contract data.
{% enddocs %}

{% docs key_decoded %}
The human-readable or decoded version of the key. This provides an understandable format of the key, making it easier to interpret and use in analysis.
{% enddocs %}

{% docs val %}
The encoded value associated with the key in the contract data. This value is typically stored in a compact, machine-readable format.
The encoded value associated with the key in the contract data. The encoded val has two components (type and value) where type describes the data type and the value describes the encoded value of the data type for the contract data.
{% enddocs %}

{% docs val_decoded %}
Expand Down
2 changes: 1 addition & 1 deletion models/docs/sources/history_effects.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Soroban ledger change entries related to contract extension
{% enddocs %}

{% docs id %}
A unique identifier for the effect. This is typically an auto-incremented integer that uniquely distinguishes each effect record in the table.
This unique effect id is the concatenation of the operation id and the effect index
{% enddocs %}

{% docs index %}
Expand Down
6 changes: 3 additions & 3 deletions models/docs/sources/history_operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -1461,15 +1461,15 @@ The identifier of the asset involved in the operation. This field provides detai
{% enddocs %}

{% docs details_buying_asset_id %}
The identifier of the asset being bought in the operation. This is relevant for operations involving trades, where one asset is exchanged for another.
The identifier of the asset being bought in the operation. This is relevant for trade and offer operations, where one asset is exchanged for another.
{% enddocs %}

{% docs details_selling_asset_id %}
The identifier of the asset being sold in the operation. This field is used in trade operations, where one asset is exchanged for another.
The identifier of the asset being sold in the operation. This field is used in trade and offer operations, where one asset is exchanged for another.
{% enddocs %}

{% docs details_source_asset_id %}
The identifier of the source asset in the operation. This is used in operations where an asset is transferred or converted from one form to another.
The identifier of the source asset in the operation. This is used in payment operations where an asset is transferred or converted from one form to another.
{% enddocs %}

{% docs details_reserve_a_asset_id %}
Expand Down
2 changes: 1 addition & 1 deletion models/docs/sources/history_transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ The amount of the resource fee charged for the transaction that is refundable. T
{% enddocs %}

{% docs rent_fee_charged %}
The fee charged for renting resources on the network, such as storage space for data. This fee is deducted from the transaction initiator's account and is typically non-refundable, covering the ongoing cost of maintaining the data on the network.
The fee charged for renting resources on the network, such as storage space for data. This fee is deducted from the transaction initiator's account and is non-refundable, covering the ongoing cost of maintaining the data on the network. A rent fee wouldn't be charged on failed transactions.
{% enddocs %}

{% docs refundable_fee %}
Expand Down

0 comments on commit 50a2550

Please sign in to comment.