diff --git a/README.md b/README.md index fd7b2cb1..b667a48e 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ In order to ensure that the newly added content is correctly aligned and every M - clone the repository - run `npm install` (only for the first usage) +- run `npm run build` - run `npm start` - access `http://localhost:3000` to view your local version of the docs diff --git a/docs/sdk-and-tools/elastic-search.md b/docs/sdk-and-tools/elastic-search.md index 1549389c..be111c20 100644 --- a/docs/sdk-and-tools/elastic-search.md +++ b/docs/sdk-and-tools/elastic-search.md @@ -148,6 +148,7 @@ Each entry in an Elasticsearch index will have a format similar to this: | [events](/sdk-and-tools/indices/es-index-events) | Contains all the events generated by transactions and smart contract results. | | [delegators](/sdk-and-tools/indices/es-index-delegators) | Contains details about all the delegators. | | [operations](/sdk-and-tools/indices/es-index-operations) | Contains all transactions and smart contract results. | +| [executionresults](/sdk-and-tools/indices/es-index-executionresults) | Contains all execution results generated by blocks execution. | [comment]: # (mx-context-auto) diff --git a/docs/sdk-and-tools/indices/executionresults.md b/docs/sdk-and-tools/indices/executionresults.md new file mode 100644 index 00000000..d2aa3f84 --- /dev/null +++ b/docs/sdk-and-tools/indices/executionresults.md @@ -0,0 +1,80 @@ +--- +id: es-index-executionresults +title: execution results +description: "Elasticsearch executionresults index: execution result block hash, header fields and example queries." +--- + +[comment]: # (mx-abstract) + +This page describes the structure of the `executionresults` index (Elasticsearch), and also depicts a few examples of how to query it. + +[comment]: # (mx-context-auto) + +## _id + +The _id field of this index is the block hash associated with the execution result, in a hexadecimal encoding. + +[comment]: # (mx-context-auto) + +## Fields + +[comment]: # (table:blocks) + +| Field | Description | +|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nonce | The nonce field represents the sequence number of the block (block height) associated with the execution result. | +| round | The round field represents the round of the block associated with the execution result. | +| epoch | The epoch field represents the epoch of the block associated with the execution result. | +| 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. | +| timestampMs | The timestampMs field represents the timestamp of the block associated with the execution result. | +| rootHash | The rootHash field represents the trie's state root hash when of the block associated with the execution result. | +| shardId | The shardId field represents the shard this block belongs to. | +| txCount | The txCount field represents the number of transactions from the block associated with the execution result. | +| gasUsed | The gasUsed field represents the total gas that was used in the block associated with the execution result. | +| accumulatedFees | The accumulatedFees field represents the accumulated fees that were paid in the block associated with the execution result. | +| developerFees | The developerFees field represents the developer fees that were accumulated in the block. | +| epochStartInfo | The epochStartInfo field is a structure that contains economic data, such as total supply. | +| notarizedInBlockHash | The notarizedInBlockHash field represents the hash of the block in which the execution result was notarized. | + +[comment]: # (mx-context-auto) + +### Fetch blocks for a shard +In order to fetch the latest execution results from a shard, one has to do a query that matches the field `shardId`. +``` +curl --request GET \ + --url ${ES_URL}/executionresults/_search \ + --header 'Content-Type: application/json' \ + --data '{ + "query": { + "match": { + "shardId": "1" + } + }, + "sort": [ + { + "timestamp": { + "order": "desc" + } + } + ] +}' +``` + +### Fetch the latest 10 execution results for all shards + +``` +curl --request GET \ + --url ${ES_URL}/executionresults/_search \ + --header 'Content-Type: application/json' \ + --data '{ + "sort": [ + { + "timestamp": { + "order": "desc" + } + } + ], + "size":10 +}' +``` diff --git a/docs/tokens/fungible-tokens.mdx b/docs/tokens/fungible-tokens.mdx index 9bfd9779..2548390e 100644 --- a/docs/tokens/fungible-tokens.mdx +++ b/docs/tokens/fungible-tokens.mdx @@ -858,7 +858,7 @@ values={[ ]}> -Returns an array of ESDT Tokens that the specified address has interacted with (issued, sent or received). +Returns an array of ESDT Tokens owned by the specified address. ```bash https://gateway.multiversx.com/address/*bech32Address*/esdt diff --git a/static/llms-full.txt b/static/llms-full.txt index 61f098c5..537252bb 100644 --- a/static/llms-full.txt +++ b/static/llms-full.txt @@ -14656,6 +14656,7 @@ Each entry in an Elasticsearch index will have a format similar to this: | [events](/sdk-and-tools/indices/es-index-events) | Contains all the events generated by transactions and smart contract results. | | [delegators](/sdk-and-tools/indices/es-index-delegators) | Contains details about all the delegators. | | [operations](/sdk-and-tools/indices/es-index-operations) | Contains all transactions and smart contract results. | +| [executionresults](/sdk-and-tools/indices/es-index-executionresults) | Contains all execution results generated by blocks execution. | ## Troubleshooting @@ -18963,7 +18964,7 @@ values={[ ]}> -Returns an array of ESDT Tokens that the specified address has interacted with (issued, sent or received). +Returns an array of ESDT Tokens owned by the specified address. ```bash https://gateway.multiversx.com/address/*bech32Address*/esdt diff --git a/static/llms.txt b/static/llms.txt index 6e166718..9bc16333 100644 --- a/static/llms.txt +++ b/static/llms.txt @@ -238,7 +238,7 @@ This documentation is organized into major sections. Each section includes tutor - [Architecture](https://docs.multiversx.com/bridge/architecture): High-level architecture of the Ad‑Astra Bridge: core contracts on MultiversX and EVM chains, relayer quorum, and how cross‑chain transfers are coordinated. - [Axelar Amplifier Setup](https://docs.multiversx.com/bridge/axelar): Set up an Axelar Amplifier verifier for MultiversX: prerequisites, tofnd and ampd services, configuration, and verification steps. - [Bitcoin L2](https://docs.multiversx.com/sovereign/bitcoin-l2): Concept and architecture for a Bitcoin‑compatible Sovereign L2 and VM integration. -- [Concept](https://docs.multiversx.com/sovereign/concept): Concept and rationale for Sovereign Chains: performance, configurability, VM options and built‑in cross‑chain mechanism. +- [Concept](https://docs.multiversx.com/sovereign/concept): Learn about MultiversX Sovereign Chain architecture, cross-chain mechanisms, and smart contracts. - [Cross Chain Execution](https://docs.multiversx.com/sovereign/cross-chain-execution): Concept and flow of cross‑chain execution between MultiversX and Sovereign Chains: contracts, bridge service and fees. - [Custom Configurations](https://docs.multiversx.com/sovereign/custom-configurations): Configuration options to tailor a Sovereign network: chain ID, economics, ratings and system smart‑contract parameters. - [Disclaimer](https://docs.multiversx.com/sovereign/disclaimer): Disclaimer on scope: MultiversX provides core chain SDK and scripts; full production infrastructure and some components may require separate integration.