Hi,

On each documentation page, it would be great to have a link "Edit the page", that once clicked, would redirect to the correct GitHub to edit the page.

Everytime I see a typo in the document, I want to report it, but then I spend 90% of the time finding how to report the typo: finding back the repo, then the correct .md file, then the button to edit.

Do we have any ETA for docs on the new testing approach? 👇

There are two flavors of integration tests:

Black-box tests: execution imitates the blockchain, no access to private contract functions;
White-box tests: the test has access to the inner workings of the contract.

It isn't easy to learn the topic.
At least from the Testing overview section.
And I believe the Rust Testing Framework (in a different section) is outdated.

Topics to add:

• What I can and can't test with whitebox/blackbox, very simple examples,
• Which SC methods exactly can I access in both cases, and which not? For example, how to test the self.send().esdt_local_burn() triggered through the endpoint. What initial setup is required, what roles, how to set them, etc?
• Simple initialization for both (whitebox/blackbox) - file structure, best practices, examples

The docs could be added systematically, not necessarily all at once, to split the work and gather feedback.

Currently if you follow the crowdfunding smart contract tutorial instructions you will end up with the error

the `wasm32-unknown-unknown` target may not be installed

Nowhere in Elrond documentation there are instructions how to set up Rust environment for Elrond smart contract development.

Hello,

The commit 22a3b8e introduced an inconsistency between the fund function implementation and its explanation below in the doc.

The commit removes the #[payment_amount] payment: BigUint argument in the fund function, but does not modify the text below it accordingly. Thus, the doc talks about the argument when it does not exist in the code anymore:

Notice the #[payment_amount] payment: BigUint argument. This is not a real argument, but just syntactic sugar to pass the paid sum to the function.

I did not investigated further to see if other inconsistencies exist on the page, but I figured it could be useful to signal this, just so that it is written somewhere :)

By the way, I tried to look for a documentation about #[payment_amount] for the payable annotation, but did not find it. Did I miss something?

Thank you very much!

Very good to see the Detailed comparisons!

Would love to see Solana there, since it's the L1 blockchain with the largest market cap.

Currently, the instructions are long deprecated.

E.g. pip3 install --user --upgrade --no-cache-dir mxpy - this is wrong, mxpy is not the package to be installed.

This issue is open so new feedback or suggestions are written in the comments.

Please write in the comments any relevant improvements suggestions. These can include lack of documentation in some areas, things that one tried to do but didn't find any documentation about, and so on.

The config script page is here:

https://docs.elrond.com/validators/mainnet/config-scripts/

While the goal states "streamlining", this page has many issues that are opposite of this goal.

• It asks user to figure out its username and host name (these are available to any shell script)

• It asks user to hand edit config file (could be autogenerated)

• It asks user to give sudo permission to a random stuff downloaded from Github, a matter that any security expert would say is critically dangerous

Suggestion

Design the scripts so that none of this is needed. If necessary, look other projects for inspiration how this can be done without developer experience usability issues like above.

Currently networking (or open ports) is hidden at the end here:

https://docs.elrond.com/validators/system-requirements/

This should be promoted to its own chapter and updated.

• System administrators installing Elrond nodes will first look at what ports they need to open and this information is hard to find

• It does not describe traffic types (TCP/UDP) and RPC ports - this information should be also included

• UFW command does not make sense sudo ufw allow 37373:38383/tcp - why is it like this?

let payment = TokenPayment.nonFungible("ERDJS-38f249", 1);
let payload = new ESDTNFTTransferPayloadBuilder()
    .setPayment(payment)
    .setDestination(new Address("erd1..."))
    .build();

transactions.push(new Transaction({
    nonce: 7,
    // Same as sender address!
    receiver: new Address("erd1..."),
    data: data,
    gasLimit: 50000 + 1500 * data.length() + 1000000,
    chainID: "D"
}));

payload == data in the code.
There are many same mistakes in the page.

In the ESDT transfer example

https://docs.elrond.com/developers/esdt-tokens/#transfers

We use EGLD value 0 for token transfer and the amount of tokens is encoded separate in Data field.

However, the documentation does not describe what should happen in the situations if EGLD value is set to non-zero.

Very good to see the Detailed comparisons!

Would love to see Kadena there, since it's the most scalable PoW blockchain (480,000 tps).

Any 3 Rd. Company
Special units
Doc needed

I'm following the video in the crowdfunding tutorial and it shows them running a snippet by right-clicking on the snippets file and choosing "Run Contract Snippet", but that option doesn't exist for me. So how do I run a snippet?

For open source projects and documentation frameworks, the best practice is backlink each individual document page to their Github source, so that drive-by developers can easily update documentation.

E.g.

• "Edit on Github" on Sphinx
• "Edit on Github" on MkDocs (GitBook)

I did not see such links in docs.elrond.com. Is this planned, as it might significantly bring down the barrier to contribute to the documentation?

Add a paragraph / note / warning to instruct users to pay attention to the output of mxpy-up:

• https://docs.multiversx.com/sdk-and-tools/sdk-py/installing-mxpy/

Related to: multiversx/mx-sdk-py-cli#309.

The developer cannot complete any of the tutorials, because they cannot get testnet EGLD.

The documentation does not have any reference to a faucet.

The search result does not give any hits.

The link was only available through a Telegram chat room: https://r3d4.fr/elrond/devnet/index.php

When the tutorial gets to Deploy section it states

In order to deploy the contract on the Testnet you need to have an account with sufficient balance (required for the deployment fee) and the associated private key in PEM format.

While this clearly describes what the developer needs, it does not answer the question how the developer gets these. Thus, the developer cannot get past this point of tutorial, without further research that may take a long time and lose the developer interest.

Suggested solution

• Use a local development node, instead of a public testnet, for the tutorial

• A web wizard that generates testnet PEM file with an account that has testnet EGLD balance on it

The first example the developers encounter is written in C.

https://docs.elrond.com/developers/tutorials/counter/

This is counter-intutitive because we assume most of if not all Elrond smart contracts should be written in Rust.

Hello, I found missed param nonce here estimate-cost-of-transaction
It works without nonce if data is empty. In another cases response will be: txGasUnits=0, returnMessage="lower nonce in transaction".

In the Hello World tutorial, the contract is deployed on a shared testnet:

https://docs.elrond.com/developers/tutorials/counter/

All professional development happens on a local development node that can be spin up and tear down with a single line command. The development workflow advertised in the Hello World tutorial is not practical, though is good for tutorial purposes. Still, a local node development workflow similar to Ganache (Web3.js) or py-evm (Web3.py) should be described in the docs, as this is what professional developers want.

The documentation later describes how to set up a local testnet, but this is not what developers want. The developers want a single line node up and down, with some local explorer or logging output for transactions.

https://docs.elrond.com/developers/setup-local-testnet/

ROF-c85ab7

I'm trying to put a logo on the ROF token
can anyone help?

Currently the validator key page does not describe how validator keys are supposed to be generated.

Suggestions

• Make the key optionally in the first place if it is not needed: multiversx/mx-chain-go#3367

• Web based generator

• Static downloads for keygenerator binary

• Add erdpy commands or bash shell commands with openssl to generate necessary PEM files

• See also multiversx/mx-chain-go#3368

The ESDT tokens chapter details how to issue out a new token.

https://docs.elrond.com/developers/esdt-tokens/#issuance-of-fungible-esdt-tokens

This documentation is very outlining and is not helpful enough for outside readers - as it has gaps to let the user to understand the complete steps to issue and manage tokens.

• It does not cross-reference to any tooling (JavaScript, Python erdpy, Rust, how to issue out a token)

• It does not refer to have source code, or related, how the tokens are managed, or any detailed discussion about token standards - for example it asks to community feedback, but does not discuss how to give such feedback and where relevant discussion should take a place

Hi!

Somebody asked me today what the chain id is, because the docs are very misleading.

https://docs.elrond.com/sdk-and-tools/erdpy/configuring-erdpy/

Here it seems like the chain id is a version number or something like that. When in reality it's.

Mainnet: 1
Testnet: T
Devnet: D

Thought I would ask first, because maybe I'm misunderstanding something myself :)

ESDT documentation does not discuss about string format and limitations.

https://docs.elrond.com/developers/esdt-tokens/#issuance-of-fungible-esdt-tokens

It can be assumed the string encoding is UTF-8. But, for example, is it legit to create a token with a name of 1,000,000 characters?

E.g. wallet creation etc. See sdk-py's cookbook.

Elrond chain ids are not covered in the documentation

The information like that D means devnet can be uncovered from the source code, but nowhere in the documentation it is not explained what chain ids are available now, how they are chosen, will they stay the same, how to have your own chain id and is it ever needed and so on.

Hi everyone!

Wasn't there an "?withResults=true" query param for the transaction endpoint?
I no longer find it documented anywhere 🤔

Thanks!

In the ESDT transfer example

https://docs.elrond.com/developers/esdt-tokens/#transfers

it says you need to use a gas limit of 250,00 to do an ESDT token transfer transaction.

This is incorrect and using the gas limit of 250,000 will result in a failed transaction.

external contributions will be made to the external branch.

Sourced from the README

However the external branch is 180 commits behind master. Is external still recommended for external contributors, or is it okay if my PRs target master?

The first tutorial should cover how to use a local testnet, deploy the contract locally and explore the testnet. This is because testing on a public testnet is difficult, as you need to access undocumented faucet to get testnet EGLD.

https://docs.elrond.com/developers/tutorials/counter/

Currently there exists erdpy tutorial for a local testnet, but it is not not connected to other tutorials. E.g. what keys are created and how to use them to deploy local testnet contracts.

multiversx/mx-sdk-py-cli#19

This is also important, because the public testnet is unstable, slower and trying to rely it for development is causing a drop of developer efficiency.

"""""(4*18>5]0°;"7[8

Feedback and Suggestions for Development Process Improvements

Hello,

I've been working with your development resources and templates and wanted to share some feedback and suggestions that could enhance the user experience and efficiency.

Issues and Suggestions

1. Outdated YouTube Videos

   • The YouTube tutorials linked seem outdated, leading to confusion.
   • Suggestion: Update these videos or remove them to avoid misleading information.

2. Node.js Version Recommendation

   • The default installation on Ubuntu 22 sets Node.js to version 12.
   • Suggestion: Recommend Node.js version 18, or suggest using NVM (Node Version Manager) to allow users to select a compatible Node.js version.

3. Contract Template Cloning Issue

   • The JSON configuration file in the contract template is no longer valid (Proxy and Chain ID settings are deprecated).
   • Suggestion: Update the template or provide instructions to use a fully parameterized command via the CLI.

4. DApp Template Configuration

   • After cloning the DApp template, 'src/config.tsx' file is missing.
   • Suggestion: Include steps in documentation to copy 'src/config/config.devnet.ts' to './config.tsx' and modify the import path of 'sharedConfig', or automate this process.

5. NPM Start Command in DApp Template

   • The command 'npm run start' is invalid; 'npm run start:devnet' is the correct command.
   • Suggestion: Update the documentation to reflect the correct command.

I hope these suggestions help in improving the development experience for this project. Thank you for your hard work and dedication.

Best regards,
@Noun

The link here point to the example smart contract, whereas it should probably lead to ping pong service.

Elrond Network overview clearly describes what Elrond does:

https://docs.elrond.com/validators/overview/

However it lacks "Why" - the target audience is smart contract developers and this audience is not addressed well in this overview - why to develop on Elrond (vs. something else).

The token issuance documentation

https://docs.elrond.com/developers/esdt-tokens/

describes

The contract will add a random string to the ticker thus creating the token identifier. The random string starts with “-” and has 6 more random characters. For example, a token identifier could look like ALC-6258d2.

However, the documentation fails to explain how the issuer will find out what the token identifier he or she has received. There is a random number created, but there is no documentation how to find out what this random number was.

There is no documentation of signature response value on the login webhook. So, there is no way to validate that signature on background.