Merge pull request #945 from multiversx/rm/template-exploration

New Homepage
multiversx · Jul 30, 2024 · 9c99279 · 9c99279
2 parents a51dc27 + ae4aa52
commit 9c99279
Show file tree

Hide file tree

Showing 51 changed files with 2,501 additions and 497 deletions.
diff --git a/docs/developers/sc-calls-format.md b/docs/developers/sc-calls-format.md
@@ -116,11 +116,13 @@ c70cf50b238372fffaf7b7c5723b06b57859d424a2da621bcc1b2f317543aa36
 
 ### Converting addresses using online tools
 
-There are multiple (_unofficial or community supported_) tools that one can use in order to convert an address into hexadecimal encoding:
+There are multiple tools that one can use in order to convert an address into hexadecimal encoding:
 
-- https://slowli.github.io/bech32-buffer/ (go to `Data`, select `erd` as Tag and `Bech32` as Encoding)
+- [https://utils.multiversx.com/converters#addresses-bech32-to-hexadecimal](https://utils.multiversx.com/converters#addresses-bech32-to-hexadecimal)
 
-- http://207.244.241.38/elrond-converters/#bech32-to-hex
+- [https://slowli.github.io/bech32-buffer](https://slowli.github.io/bech32-buffer) (go to `Data`, select `erd` as Tag and `Bech32` as Encoding)
+
+- [http://207.244.241.38/elrond-converters/#bech32-to-hex](http://207.244.241.38/elrond-converters/#bech32-to-hex)
 
 [comment]: # (mx-context-auto)
 

diff --git a/docs/developers/smart-contracts.md b/docs/developers/smart-contracts.md
@@ -11,10 +11,10 @@ The MultiversX Blockchain's virtual machine (VM) executes [WebAssembly](https://
 written in _any programming language_ that can be compiled to WASM bytecode. **Though, we only provide support for Rust.**
 
 Developers are encouraged to use Rust for their smart contracts, however. MultiversX provides a [Rust framework](https://github.com/multiversx/mx-sdk-rs) 
-which allows for unusually clean and efficient code in smart contracts, a rarity in the blockchain field. 
-A declarative testing framework is bundled as well. For the best coding experience, 
+which allows for unusually clean and efficient code in smart contracts, a rarity in the blockchain field.
+A declarative testing framework is bundled as well. For the best coding experience,
 developers have the [MultiversX IDE](https://marketplace.visualstudio.com/items?itemName=Elrond.vscode-elrond-ide) at their disposal.
 
-Read more about the MultiversX VM [here](/learn/space-vm). 
+Read more about the MultiversX VM [here](/learn/space-vm).
 
 Navigate through the sidebar to see some tutorials to get you started, as well as the Rust framework documentation.
diff --git a/docs/integrators/walletconnect-json-rpc-methods.md b/docs/integrators/walletconnect-json-rpc-methods.md
@@ -25,35 +25,39 @@ This method returns a signature and any additional properties ( e.g. Guardian in
 
 ### Parameters
 
-    1. `Object` - Signing parameters:
-        1.1. `transactions` : `Array<Object>` - Array of Transactions
-            1.1.1 `Object` - Transaction Object
-                1.1.1.1  `nonce` : `String` - The Nonce of the Sender.
-                1.1.1.2  `value` : `String` - The Value to transfer, as a string representation of a Big Integer (can be "0").
-                1.1.1.3  `receiver` : `String` - The Address (bech32) of the Receiver.
-                1.1.1.4  `sender` : `String` - The Address (bech32) of the Sender.
-                1.1.1.5  `gasPrice` : `Number` - The desired Gas Price (per Gas Unit).
-                1.1.1.6  `gasLimit` : `Number` -  The maximum amount of Gas Units to consume.
-                1.1.1.7  `data` : `String | undefined` -  The base64 string representation of the Transaction's message (data).
-                1.1.1.8  `chainID` : `String` - The Chain identifier. ( `1` for Mainnet, `T` for Testnet, `D` for Devnet )
-                1.1.1.9  `version` : `String | undefined` -  The Version of the Transaction (e.g. 1).
-                1.1.1.10 `options` : `String | undefined` -  The Options of the Transaction (e.g. 1).
-                1.1.1.11 `guardian` : `String | undefined` -  The Address (bech32) of the Guardian.
-                1.1.1.12 `receiverUsername` : `String | undefined` - The base64 string representation of the Sender's username.
-                1.1.1.10 `senderUsername` : `String | undefined` - The base64 string representation of the Receiver's username.
+```text
+1. `Object` - Signing parameters:
+    1.1. `transactions` : `Array<Object>` - Array of Transactions
+        1.1.1 `Object` - Transaction Object
+            1.1.1.1  `nonce` : `String` - The Nonce of the Sender.
+            1.1.1.2  `value` : `String` - The Value to transfer, as a string representation of a Big Integer (can be "0").
+            1.1.1.3  `receiver` : `String` - The Address (bech32) of the Receiver.
+            1.1.1.4  `sender` : `String` - The Address (bech32) of the Sender.
+            1.1.1.5  `gasPrice` : `Number` - The desired Gas Price (per Gas Unit).
+            1.1.1.6  `gasLimit` : `Number` -  The maximum amount of Gas Units to consume.
+            1.1.1.7  `data` : `String | undefined` -  The base64 string representation of the Transaction's message (data).
+            1.1.1.8  `chainID` : `String` - The Chain identifier. ( `1` for Mainnet, `T` for Testnet, `D` for Devnet )
+            1.1.1.9  `version` : `String | undefined` -  The Version of the Transaction (e.g. 1).
+            1.1.1.10 `options` : `String | undefined` -  The Options of the Transaction (e.g. 1).
+            1.1.1.11 `guardian` : `String | undefined` -  The Address (bech32) of the Guardian.
+            1.1.1.12 `receiverUsername` : `String | undefined` - The base64 string representation of the Sender's username.
+            1.1.1.10 `senderUsername` : `String | undefined` - The base64 string representation of the Receiver's username.
+```
 
 [comment]: # (mx-context-auto)
 
 ### Returns
 
-    1. `Object`
-        1.1. `signatures` : `Array<Object>`
-            1.1.1 `Object` - corresponding signature and optional properties response for the provided transaction
-                1.1.1.1 `signature` :  The Signature (hex-encoded) of the Transaction.
-                1.1.1.2 `guardian` : `String | undefined` - The Address (bech32) of the Guardian.
-                1.1.1.3 `guardianSignature` : `String | undefined` -  The Guardian's Signature (hex-encoded) of the Transaction.
-                1.1.1.4 `options` : `Number | undefined` -  The Version of the Transaction (e.g. 1).
-                1.1.1.5 `version` : `Number | undefined` -  The Options of the Transaction (e.g. 1).
+```text
+1. `Object`
+    1.1. `signatures` : `Array<Object>`
+        1.1.1 `Object` - corresponding signature and optional properties response for the provided transaction
+            1.1.1.1 `signature` :  The Signature (hex-encoded) of the Transaction.
+            1.1.1.2 `guardian` : `String | undefined` - The Address (bech32) of the Guardian.
+            1.1.1.3 `guardianSignature` : `String | undefined` -  The Guardian's Signature (hex-encoded) of the Transaction.
+            1.1.1.4 `options` : `Number | undefined` -  The Version of the Transaction (e.g. 1).
+            1.1.1.5 `version` : `Number | undefined` -  The Options of the Transaction (e.g. 1).
+```
 
 [comment]: # (mx-context-auto)
 
@@ -120,38 +124,42 @@ The same logic applies to the Transaction Object here too.
 
 [comment]: # (mx-context-auto)
 
-### Parameters
-
-    1. `Object` - Signing parameters:
-        1.1. `transaction` : `Object` - Transaction Object
-            1.1.1  `nonce` : `String` - The Nonce of the Sender.
-            1.1.2  `value` : `String` - The Value to transfer, as a string representation of a Big Integer (can be "0").
-            1.1.3  `receiver` : `String` - The Address (bech32) of the Receiver.
-            1.1.4  `sender` : `String` - The Address (bech32) of the Sender.
-            1.1.5  `gasPrice` : `Number` - The desired Gas Price (per Gas Unit).
-            1.1.6  `gasLimit` : `Number` -  The maximum amount of Gas Units to consume.
-            1.1.7  `data` : `String | undefined` -  The base64 string representation of the Transaction's message (data).
-            1.1.8  `chainID` : `String` - The Chain identifier. ( `1` for Mainnet, `T` for Testnet, `D` for Devnet )
-            1.1.9  `version` : `String | undefined` -  The Version of the Transaction (e.g. 1).
-            1.1.10 `options` : `String | undefined` -  The Options of the Transaction (e.g. 1).
-            1.1.11 `guardian` : `String | undefined` -  The Address (bech32) of the Guardian.
-            1.1.12 `receiverUsername` : `String | undefined` - The base64 string representation of the Sender's username.
-            1.1.10 `senderUsername` : `String | undefined` - The base64 string representation of the Receiver's username.
+### Parameters {#mvx_signTransaction-parameters}
+
+```text
+1. `Object` - Signing parameters:
+    1.1. `transaction` : `Object` - Transaction Object
+        1.1.1  `nonce` : `String` - The Nonce of the Sender.
+        1.1.2  `value` : `String` - The Value to transfer, as a string representation of a Big Integer (can be "0").
+        1.1.3  `receiver` : `String` - The Address (bech32) of the Receiver.
+        1.1.4  `sender` : `String` - The Address (bech32) of the Sender.
+        1.1.5  `gasPrice` : `Number` - The desired Gas Price (per Gas Unit).
+        1.1.6  `gasLimit` : `Number` -  The maximum amount of Gas Units to consume.
+        1.1.7  `data` : `String | undefined` -  The base64 string representation of the Transaction's message (data).
+        1.1.8  `chainID` : `String` - The Chain identifier. ( `1` for Mainnet, `T` for Testnet, `D` for Devnet )
+        1.1.9  `version` : `String | undefined` -  The Version of the Transaction (e.g. 1).
+        1.1.10 `options` : `String | undefined` -  The Options of the Transaction (e.g. 1).
+        1.1.11 `guardian` : `String | undefined` -  The Address (bech32) of the Guardian.
+        1.1.12 `receiverUsername` : `String | undefined` - The base64 string representation of the Sender's username.
+        1.1.10 `senderUsername` : `String | undefined` - The base64 string representation of the Receiver's username.
+```
 
 [comment]: # (mx-context-auto)
 
-### Returns
+### Returns {#mvx_signTransaction-returns}
 
-    1. `Object` - corresponding signature and optional properties response for the provided transaction
-        1.1 `signature` :  The Signature (hex-encoded) of the Transaction.
-        1.2 `guardian` : `String | undefined` - The Address (bech32) of the Guardian.
-        1.3 `guardianSignature` : `String | undefined` -  The Guardian's Signature (hex-encoded) of the Transaction.
-        1.4 `options` : `Number | undefined` -  The Version of the Transaction (e.g. 1).
-        1.5 `version` : `Number | undefined` -  The Options of the Transaction (e.g. 1).
+```text
+1. `Object` - corresponding signature and optional properties response for the provided transaction
+    1.1 `signature` :  The Signature (hex-encoded) of the Transaction.
+    1.2 `guardian` : `String | undefined` - The Address (bech32) of the Guardian.
+    1.3 `guardianSignature` : `String | undefined` -  The Guardian's Signature (hex-encoded) of the Transaction.
+    1.4 `options` : `Number | undefined` -  The Version of the Transaction (e.g. 1).
+    1.5 `version` : `Number | undefined` -  The Options of the Transaction (e.g. 1).
+```
 
 [comment]: # (mx-context-auto)
 
-### Example
+### Example {#mvx_signTransaction-example}
 
 ```javascript
 // Request
@@ -192,22 +200,26 @@ This method returns a signature for the provided message from the requested sign
 
 [comment]: # (mx-context-auto)
 
-### Parameters
+### Parameters {#mvx_signMessage-parameters}
 
-    1. `Object` - Signing parameters:
-        1.1. `message` : `String` -  the message to be signed
-        1.2. `address` : `String` -  bech32 formatted MultiversX address ( erd1... )
+```text
+1. `Object` - Signing parameters:
+    1.1. `message` : `String` -  the message to be signed
+    1.2. `address` : `String` -  bech32 formatted MultiversX address ( erd1... )
+```
 
 [comment]: # (mx-context-auto)
 
-### Returns
+### Returns {#mvx_signMessage-returns}
 
-    1. `Object`
-        1.1. `signature` : `String` - corresponding signature for the signed message
+```text
+1. `Object`
+    1.1. `signature` : `String` - corresponding signature for the signed message
+```
 
 [comment]: # (mx-context-auto)
 
-### Example
+### Example {#mvx_signMessage-example}
 
 ```javascript
 // Request
@@ -241,22 +253,26 @@ The functionality is mostly the same as `mvx_signMessage`, only in this case ins
 
 [comment]: # (mx-context-auto)
 
-### Parameters
+### Parameters {#mvx_signNativeAuthToken-parameters}
 
-    1. `Object` - Signing parameters:
-        1.1. `token` : `String` -  the loginToken to be signed
-        1.2. `address` : `String` -  bech32 formatted MultiversX address ( erd1... )
+```text
+1. `Object` - Signing parameters:
+    1.1. `token` : `String` -  the loginToken to be signed
+    1.2. `address` : `String` -  bech32 formatted MultiversX address ( erd1... )
+```
 
 [comment]: # (mx-context-auto)
 
-### Returns
+### Returns {#mvx_signNativeAuthToken-returns}
 
-    1. `Object`
-        1.1. `signature` : `String` - corresponding signature for the signed token
+```text
+1. `Object`
+    1.1. `signature` : `String` - corresponding signature for the signed token
+```
 
 [comment]: # (mx-context-auto)
 
-### Example
+### Example {#mvx_signNativeAuthToken-example}
 
 ```javascript
 // Request
@@ -294,20 +310,22 @@ Wallets can implement this method to improve the UX. It is used to transmit that
 
 [comment]: # (mx-context-auto)
 
-### Parameters
+### Parameters {#mvx_cancelAction-parameters}
 
-    1. `Object` - Action parameters
-        1.1. `action` : `String | undefined` -  Current action to be cancelled ( for ex. `cancelSignTx` )
+```text
+1. `Object` - Action parameters
+    1.1. `action` : `String | undefined` -  Current action to be cancelled ( for ex. `cancelSignTx` )
+```
 
 [comment]: # (mx-context-auto)
 
-### Returns
+### Returns {#mvx_cancelAction-parameters}
 
-    void
+`void`
 
 [comment]: # (mx-context-auto)
 
-### Example
+### Example {#mvx_cancelAction-parameters}
 
 ```javascript
 // Request

diff --git a/docs/learn/getting-started.md b/docs/learn/getting-started.md
@@ -10,13 +10,17 @@ If you're not on MultiversX, get started by creating your wallet with [xPortal](
 :::
 
 ## **Learn**
+
 If you want to learn more, get started by diving into these concepts:
+
 - [**MultiversX Blockchain Basics**](https://www.youtube.com/watch?v=tv6OBimIX98&list=PLQVcheGWwBRWFjgEGLx1Fv2qF_6UVpSXX) - Learn about the basics of the blockchain, cryptocurrencies, consensus models, MultiversX explorer, wallet and a live demo of how to interact with the network.
 - [**Architecture**](/docs/learn/architecture-overview.md) - A breakdown of Multiversx's onchain system.
 - [**Sovereign Chains**](/docs/sovereign/overview.md) - Learn what Sovereign Chains represent for MultiversX.
 
 ## **Build**
+
 If you are a developer, you've come to the right place. The development act is one of the easiest and most straight-forward that you will find in the entire space, with lots of tools and support offered by the foundation and community fellow developers.
+
 - [**Get EGLD**](/docs/learn/EGLD.md#getting-egld) - You need EGLD or xEGLD in order to be able to interact with the MultiversX Network.
 - [**Tutorials**](https://multiversx.com/builders/build-your-first-multiversx-dapp-in-30-minutes) - A great start for anyone looking to learn what it means to develop on the MultiversX blockchain.
 - [**Cryptozombies**](https://cryptozombies.io/en/multiversx) - Interactive tutorials for learning how to write MultiversX Smart Contracts.
@@ -27,13 +31,15 @@ If you are a developer, you've come to the right place. The development act is o
 - [**Support**](https://t.me/MultiversXDevelopers) - We encourage everyone to ask for support or seek answers for their questions if there are any. You can find us on [Telegram](https://t.me/MultiversXDevelopers), [Discord](https://discord.gg/multiversxbuilders) or [StackOverflow](https://stackoverflow.com/questions/tagged/multiversx).
 
 ## **Contribute**
+
 MultiversX highly values and encourages contributions from the community, especially those who make their code public. To stay engaged with the latest developments and connect with other developers, consider joining a developer session.
 
 :::note
 Contributing to the [MultiversX electric-capital repository](https://github.com/electric-capital/crypto-ecosystems/blob/master/data/ecosystems/m/multiversx-elrond.toml) by adding your product github repo, not only enhances visibility in the blockchain community but also showcases the dynamic nature of our builder group.
 :::
 
 ### **Repositories**
+
 | Repository   | Description   |
 |------------|------------|
 | [Protocol](https://github.com/multiversx/mx-chain-go)| Implementation of the protocol|
@@ -44,6 +50,7 @@ Contributing to the [MultiversX electric-capital repository](https://github.com/
 | [MultiversX Organization](https://github.com/multiversx/) | Official MultiversX Github Organization|
 
 ### **Developer Sessions**
+
 We host a bi-monthly developer session to discuss upcoming changes to the protocol, SDKs and Tools. The call is open to anyone and we expect any builder to join and get involved.
 
 - [Sessions Calendar](https://multiversx.com/events/sessions) - Calendar of all planned Developer and Validators Sessions.

diff --git a/docs/sdk-and-tools/rest-api/multiversx-api.md b/docs/sdk-and-tools/rest-api/multiversx-api.md
@@ -105,9 +105,9 @@ Rest API documentation of `api.multiversx.com` can be found on the [Swagger docs
 
 [comment]: # (mx-context-auto)
 
-## References:
+## References
 
 - Github repository: [https://github.com/multiversx/mx-api-service](https://github.com/multiversx/mx-api-service)
 - Swagger docs: [https://api.multiversx.com](https://api.multiversx.com)
 - Raw JSON Swagger OpenAPI definitions: [https://api.multiversx.com/-json](https://api.multiversx.com/-json)
-- MultiversX blog: [https://elrond.com/blog/elrond-api-internet-scale-defi](https://elrond.com/blog/elrond-api-internet-scale-defi)
+- MultiversX blog: [https://multiversx.com/blog/elrond-api-internet-scale-defi](https://multiversx.com/blog/elrond-api-internet-scale-defi)
diff --git a/docs/sdk-and-tools/sdk-js/extending-sdk-js.md b/docs/sdk-and-tools/sdk-js/extending-sdk-js.md
@@ -24,7 +24,7 @@ The default classes from `@multiversx/sdk-network-providers` should **only be us
 
 You can derive from the default network providers (`ApiNetworkProvider` and `ProxyNetworkProvider`) and overwrite / add additional methods, making use of `doGetGeneric()` and `doPostGeneric()`. For example:
 
-```
+```js
 export class MyTailoredNetworkProvider extends ApiNetworkProvider {
     async getEconomics(): Promise<{totalSupply: number, marketCap: number}> {
         let response = await this.doGetGeneric("economics");
@@ -41,7 +41,7 @@ export class MyTailoredNetworkProvider extends ApiNetworkProvider {
 
 If, for some reason, the default transaction completion detection algorithm provided by **sdk-js** does not satisfy your requirements, you may want to use a different strategy for transaction awaiting, such as:
 
-```
+```js
 await transactionWatcher.awaitAllEvents(txHash, ["mySpecialEventFoo", "mySpecialEventBar"]);
 await transactionWatcher.awaitAnyEvents(txHash, ["mySpecialEventFoo", "mySpecialEventBar"]);
 ```
diff --git a/docs/sdk-and-tools/sdk-js/migration-guides.md b/docs/sdk-and-tools/sdk-js/migration-guides.md
@@ -18,5 +18,3 @@ See [migration support](https://github.com/multiversx/mx-sdk-js-core/issues?q=la
 ## Migrate to a newer sdk-wallet
 
 See [migration support](https://github.com/multiversx/mx-sdk-js-wallet/issues?q=label:migration).
-
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,5 +18,3 @@ See [migration support](https://github.com/multiversx/mx-sdk-js-core/issues?q=la
		## Migrate to a newer sdk-wallet

		See [migration support](https://github.com/multiversx/mx-sdk-js-wallet/issues?q=label:migration).