Skip to content
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

Merge development into main #760

Merged
merged 10 commits into from
Dec 4, 2023
Merged

Merge development into main #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f0989f6
Minor fixes of fields descriptions (ES indices).
andreibancioiu Oct 31, 2023
b112a44
Update overview.md
lcswillems Nov 4, 2023
c20f042
Update writing-and-running-sdk-js-snippets.md
lcswillems Nov 4, 2023
c203528
Fixed token example query and comsetic changes.
cristure Nov 28, 2023
d64a986
remove deprecated mint and burn transactions
popenta Dec 1, 2023
d493984
Merge pull request #759 from multiversx/remove-esdt-mint-and-burn
popenta Dec 1, 2023
2c1d252
Merge pull request #733 from multiversx/lcswillems-patch-2
andreibancioiu Dec 4, 2023
49bcb9c
Merge pull request #732 from multiversx/lcswillems-patch-4
andreibancioiu Dec 4, 2023
a526ca2
Merge pull request #757 from multiversx/fix-es-index-docs
andreibancioiu Dec 4, 2023
e14aa51
Merge pull request #729 from multiversx/update-es-tables
andreibancioiu Dec 4, 2023
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
6 changes: 4 additions & 2 deletions docs/sdk-and-tools/indices/accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ The `_id` field of this index is represented by a bech32 encoded address.

## Fields

[comment]: # (table:accounts)

| Field | Description |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| address | The address field holds the address in a bech32 encoding. Should be equal to the _id field. |
| address | The address field holds the address in bech32 encoding. Should be equal to the _id field. |
| balance | The balance field holds the amount of EGLD the address possesses. It is a string that also includes the number of decimals. Example: "1500000000000000000" (equivalent to 1.5 EGLD). |
| balanceNum | The balanceNum field holds the amount of EGLD the address possesses, in a numeric format. Example: 1.5. |
| nonce | The nonce field represents the sequence number of the address. |
| shardID | The shardID field represents the shard where the address belongs to, based on its bytes. |
| shardID | The shardID field represents the shard of the account. |
| timestamp | The timestamp field represents the last moment when the address balance was changed. |
| developerRewards | The developerRewards represents the fees that were accumulated after all the smart contract calls. They can be claimed by the owner. |
| currentOwner | The currentOwner field holds the address in a bech32 format of the current owner of the smart contract. This field is populated only for the smart contract addresses. |
Expand Down
10 changes: 7 additions & 3 deletions docs/sdk-and-tools/indices/accountsesdt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ The `_id` field of this index is composed in this way: `{bech32address}_{tokenId

## Fields

[comment]: # (table:accountsesdt)

| Field | Description |
|------------|---------------------------------------------------------------------------------------------------------------------------------------|
| identifier | The identifier field consists of `token` field and the `nonce` field hex encoded (example: `TOKEN-01abdc-01`). |
| address | The address field holds the address in a bech32 encoding. |
| address | The address field holds the address in bech32 encoding. |
| balance | The balance field holds the amount of ESDT token the address possesses. It includes the number of decimals. |
| balanceNum | The balanceNum field holds the amount of ESDT tokens the address possesses, in a numeric format. |
| data | The data field is a structure that contains extra data about a token, such as the creator of an NFT. |
Expand All @@ -32,6 +34,8 @@ The `_id` field of this index is composed in this way: `{bech32address}_{tokenId

Docs with a non-empty `tokenNonce` field will have the `data` field populated with the following structure:

[comment]: # (table:accountsesdt.data)

| data fields | Description |
|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| uris | The uris field holds a list of URIs. |
Expand All @@ -55,12 +59,12 @@ curl --request GET \
--data '{
"query": {
"match": {
"identifier": {
"token": {
"query": "MY-TOKEN-aaabbb",
"operator": "AND"
}
}
}
},
"sort": [
{
"balanceNum": {
Expand Down
6 changes: 4 additions & 2 deletions docs/sdk-and-tools/indices/accountsesdthistory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,18 @@ The `_id` field of this index is composed in this way: `{bech32address}_{tokenId

## Fields

[comment]: # (table:accountsesdthistory)

| Field | Description |
|-----------------|---------------------------------------------------------------------------------------------------------------------|
| address | The address field holds the address in a bech32 encoding. |
| address | The address field holds the address in bech32 encoding. |
| balance | The balance field holds the amount of ESDT tokens the address possesses. |
| token | The token field holds the token name of the token. |
| identifier | The identifier field is composed of the `token` field and the `nonce` field, hex encoded. |
| tokenNonce | The tokenNonce field holds the sequence number of the token. This field can be empty in the case of `FungibleESDT`. |
| timestamp | The timestamp field represents the timestamp when the address balance was changed. |
| isSmartContract | The isSmartContract field is true if the address is a smart contract address. |
| shardID | The shardID field represents the shard where the address belongs to, based on its bytes. |
| shardID | The shardID field represents the shard of the account. |

[comment]: # (mx-context-auto)

Expand Down
6 changes: 4 additions & 2 deletions docs/sdk-and-tools/indices/accountshistory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ The `_id` field of this index is composed in this way: `{bech32address}_{timesta

## Fields

[comment]: # (table:accountshistory)

| Field | Description |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| address | The address field holds the address in a bech32 encoding. |
| address | The address field holds the address in bech32 encoding. |
| balance | The balance field holds the amount of EGLD the address possesses. It is a string that also includes the number of decimals. Example: "1500000000000000000" (equivalent to 1.5 EGLD). |
| isSender | The isSender field is true if the address was the sender when the balance has changed. |
| timestamp | The timestamp field represents the timestamp when the address balance was changed. |
| isSmartContract | The isSmartContract field is true if the address is a smart contract address. |
| shardID | The shardID field represents the shard where the address belongs to, based on its bytes. |
| shardID | The shardID field represents the shard of the account. |

[comment]: # (mx-context-auto)

Expand Down
20 changes: 12 additions & 8 deletions docs/sdk-and-tools/indices/blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,44 +17,48 @@ The `_id` field of this index is represented by the block hash, in a hexadecimal

## Fields

[comment]: # (table:blocks)

| Field | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| nonce | The nonce field represents the sequence number of the block. |
| nonce | The nonce field represents the sequence number of the block (block height). |
| round | The round field represents the round when the block was proposed and executed. |
| epoch | The epoch field represents the epoch when the block was proposed and executed. |
| miniBlocksHashes | The miniBlocksHashes field contains an array of the miniblock hashes (hexadecimal encoded) that were included in the block. |
| miniBlocksDetails | The miniBlocksDetails field contains an array of structures indicating processing details of the miniblocks, such as the index of the first processed transaction. |
| notarizedBlocksHashes | The notarizedBlocksHashes field represents the hashes of the blocks that were notarized in the current block. |
| proposer | The proposer field represents the index of the validator that proposed the block. |
| validators | The validators field is an array that contains the indices of the validators that signed the block. The indices are to be found in the validators index. |
| validators | The validators field is an array that contains the indices of the validators that signed the block. |
| pubKeyBitmap | The pubKeyBitmap field represents the pub key bitmap. |
| size | The size field represents the size of the block in bytes. |
| sizeTxs | The sizeTxs field holds the size of the block's transactions in bytes. |
| timestamp | The timestamp field represents the timestamp when the block was proposed and executed. |
| stateRootHash | The stateRootHash field represents the trie's state root hash when the block was proposed and executed. |
| prevHash | The prevHash field represents the hash of the previous block. |
| shardId | The shardId field represents in which shard the block was executed. |
| shardId | The shardId field represents the shard this block belongs to. |
| txCount | The txCount field represents the number of transactions that were executed in the block. |
| notarizedTxsCount | The notarizedTxsCount field represents the number of transactions that were notarized in the block. |
| accumulatedFees | The accumulatedFees field represents the accumulated fees that were payed in the block. |
| developerFees | The developerFees field represents the fees that were accumulated in the block. |
| developerFees | The developerFees field represents the developer fees that were accumulated in the block. |
| epochStartBlock | The epochStartBlock field is true if the current block is an epoch-start block. |
| epochStartInfo | The epochStartInfo field is a structure that contains economic data, such as total supply. |
| gasProvided | The gasProvided field represents the total gas that was provided in the block. |
| gasRefunded | The gasRefunded field represents the total gas that was refunded in the block. |
| gasPenalized | The gasPenalized field represents the total gas that was penalized in the block. |
| maxGasLimit | The maxGasLimit field represents the total gas that can be provided in the block. |
| scheduledData | The scheduledData contains data about the scheduled execution. |
| epochStartShardsData | The epochStartShardsData is an array of structures that contains epoch-start data for each shard, such as pending miniblocks. |
| scheduledData | The scheduledData field is a structure that contains data about the scheduled execution. |
| epochStartShardsData | The epochStartShardsData field is an array of structures that contains epoch-start data for each shard, such as pending miniblocks. |

A `metachain` block (`shardId:4294967295`) with field `epochStartBlock:true` will have the field `epochStartInfo` field populated with the next data:

[comment]: # (table:blocks.epochStartInfo)

| epochStartInfo fields | Description |
|----------------------------------|----------------------------------------------------------------------------------------------------------------------|
| totalSupply | The totalSupply field represents the EGLD supply. |
| totalToDistribute | The totalToDistribute field represents the amount of EGLD that will be distributed to validators/delegators. |
| totalNewlyMinted | The totalNewlyMinted field represents the amount of the newly minted EGLG. |
| rewardsPerBlock | The rewardsPerBlock field represents the amount of rewards in EGLD per block. |
| totalNewlyMinted | The totalNewlyMinted field represents the amount of the newly minted EGLD. |
| rewardsPerBlock | The rewardsPerBlock field represents the amount of EGLD rewards per block. |
| rewardsForProtocolSustainability | The rewardsForProtocolSustainability field represents the amount of rewards for the protocol sustainability address. |
| nodePrice | The nodePrice field represents EGLD amount required to run a validator. |
| prevEpochStartRound | The prevEpochStartRound field represents the round of the previous epoch start block. |
Expand Down
6 changes: 5 additions & 1 deletion docs/sdk-and-tools/indices/delegators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ The `_id` field of this index is composed in this way: `blake2bHash(delegatorAdd

## Fields

[comment]: # (table:delegators)

| Field | Description |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------|
| address | The address field holds the address in a bech32 encoding of the delegator. |
| address | The address field holds the address in bech32 encoding of the delegator. |
| contract | This field holds the bech32 encoded address of the staking provider contract to whom it was delegated to. |
| activeStake | The activeStake field holds the EGLD amount of the active stake (not undelegated nor unbondable). |
| activeStakeNum | The activeStake field holds the EGLD amount of the active stake (not undelegated nor unbondable), in a numeric format. Example: 1.5. |
Expand All @@ -28,6 +30,8 @@ The `_id` field of this index is composed in this way: `blake2bHash(delegatorAdd

The `unDelegateInfo` field is populated with the fields below:

[comment]: # (table:delegators.unDelegateInfo)

| unDelegateInfo fields | Description |
|-----------------------|-------------------------------------------------------------------------------------------------|
| value | The value field holds the EGLD amount that was undelegated. |
Expand Down
2 changes: 2 additions & 0 deletions docs/sdk-and-tools/indices/epochinfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ The `_id` field of this index is represented by epoch.

## Fields

[comment]: # (table:epochinfo)

| Field | Description |
|------------------|--------------------------------------------------------------------------------------------|
| accumulatedFees | The accumulatedFees field represents the accumulated fees that were payed in the epoch. |
Expand Down
Loading
Loading