icon-project / devportal Goto Github PK

What needs to be done

Add Drogon as an option for smart contract development in sections Getting Started -> How to Write a Smart Contract and ICON Stack -> Building/Testing/Deploying Smart Contracts

Why it needs to be done

Drogon is a tool with the potential to make smart contract development a much friendlier process for developers of all levels. This tool should be promoted to the community so that they can use it, provide feedback on it, and hopefully contribute to it so that it can be continually improved

Acceptance Criteria

• When reading the docs for smart contract development, it should be clear how to use drogon

I think is important to add a section, with a description and a link to the communication protocol for ICONex.

to explain it better, basically the devs of ICONex created an event based protocol to allow communication between a webpage / webapp and ICONex (installed as a plugin in the browser), this allows for the webapp to sign transactions without having to know the user private key, you basically make the user login with ICONex and the ICONex plugin signs the tx without exposing the private key.

to allow for compatibility the Hana team also implemented the same event based protocol to communicate with the Hana wallet, so at this point this event based protocol is a standard that we should continue to use with future wallets and with all the web apps.

because of this I believe is important to add a section maybe named "Communication protocol for ICON wallets" or something more descriptive, inside the article we can copy/paste the content of the link describing the protocol or improve it a little bit by explaining it more

This diagram should include the following:

• goloop
• gochain
• icon2-node
• prep-node
• other pertinent components

What needs to be done

Need to add steps to create local multi-node test network

Why it needs to be done

This is important for project debugging

Tests

Link associated tests here

Stories

As a developer, I should be able to create a local, multi-node test network

Acceptance Criteria

• Proof of test run from start to finish. Include photos from start to finish

Additional Information

See info from Discord users 'espanicon' and 'Aj| ICONosphere'

https://discord.com/channels/880651922682560582/888476176237080687/1072755735332663296

#Aj| ICONosphere
You would need to activate IISS features. There were 3 criteria for that. Let me try to find it.

#espanicon
after getting the local chain up and running is necessary to do these steps:


* send icx from God wallet to the 4 node wallets 
* run the 'registerPrep' command to make those wallets validators
* self stake and self bond on each wallet so that they can start producing blocks

#Aj| ICONosphere
To decentralize your network, the following conditions are required:
1. # of registered preps >= main prep count
2. The last main prep's power should be more than totalSupply * 0.2% in power descending order.
3. revision >= 6

Overview

Technical community members are interested to see more technical specifications on ICON consensus and execution environments

Story

As a technical user, I want to know more about the following network specifications so that I can hold discussions and contribute to areas that could use improvement

• Transactions per second limit
• Block time
• Transactions per block
• Transaction finality
• API endpoint ping time
  (possibly more)...

Test Scenarios

TBD

Acceptance Criteria

• The aforementioned specification should be available to the user in a public location

Im getting and error response from the JSON RPC server but I cant find any info about in the documentation page. The error is the following:

{
  jsonrpc: '2.0',
  id: 1,
  error: { code: -32403, message: 'access denied' }
}

the call im sending is the following:

{"jsonrpc":"2.0","method":"icx_sendTransaction","id":649,"params":{"to":"cxa843db0a27750230559f997bafaeb7f8739afc81","from":"hx0169e03001a3fa4012092ad4a4ddf2d07681f063","nid":"0x2","version":"0x3","timestamp":"0x5ee010d3c2df8","stepLimit":"0x7a1200","value":"0xde0b6b3a7640000","nonce":"0xbd","dataType":"call","data":{"method":"transferNativeCoin","params":{"_to":"btp://0x61.bsc/0x4DeD312eB774B9828665448C55Faa8AE15353E56"}},"signature":"F56ZLXOcNJPJVXWRD8HEqq7TP6hf3IXZx3cMSw1iJtd++QVdlgIhl4HNlvOhpFIA4M5kMp67V721zSck/f3q3QA="}}

What needs to be done

following this recent conversation in the discord dev channel I think is a good idea to have a section in the dev portal for the IRC3 token standard for developers to be able to find it easily

https://discord.com/channels/880651922682560582/888476176237080687/1075965877041778758

Why it needs to be done

To make it easy for developers in the community to find this token standard

Additional Information

Resources:

• IIP standard for the IRC3 tokens: https://github.com/icon-project/IIPs/blob/master/IIPS/iip-3.md

What needs to be done

Add tracker.iconblockchain.xyz to docs for tracker

Why it needs to be done

This is an alternative domain for the ICON blockchain tracker so that services running into issues with the icon.community domain have an alternative way to access the tracker API

Add the following two pages to the docs:

• Projects -> Wallets

  • What is a wallet?
  • How to use a wallet?
  • Further resources

• Advanced Topics -> Wallets -> Using wallets programmatically

  • Example: Using a wallet in a third party application

This doc

https://github.com/icon-project/devportal/blob/master/icon-2.0/goloop/get-started/build.md#build-executables

Should be viewable from icondev.io

Suggestion from @goldworm-icon

https://docs.google.com/document/d/1fpGwTJUcu-SBfcgVAS9ZOx-JDrUdQjEpnuCrn1Dwdyc/edit?usp=sharing

What needs to be done

Fix broken links on the following tutorial:
https://github.com/icon-project/devportal/blob/master/getting-started/how-to-use-the-json-rpc-api.md

Why it needs to be done

Because the links are not pointing to the correct references.

Acceptance Criteria

Clicking on the links will point to the correct tutorials/documentation

Please add how to do custom object serialization in order to be set as value in DictDB.

Example:

import score.DictDB;

public class Example {

  class Custom {
      ...
  }

  private final DictDB<String, CustomObject> temp;
  
  ...
}

Some resources and example I got from the discord channel

https://github.com/balancednetwork/balanced-java-contracts/blob/release/bBaln-core/token-contracts/bBaln/src/main/java/network/balanced/score/tokens/db/LockedBalance.java

https://docs.google.com/presentation/d/1S24vCTcPJ5GOGfPu1sApJLwyOTTdgYEf/export/pdf

https://www.javadoc.io/doc/foundation.icon/javaee-api/latest/score/ObjectReader.html
https://www.javadoc.io/doc/foundation.icon/javaee-api/latest/score/ObjectWriter.html

After having a conversation with one of the project maintainers about how to improve the overall docs I was recommended to open an issue here with my recommendations to have a more proper way to implement and track the ideas.

My recommendation is to create a section with bite size examples of how to do specific things, im thinking of this like a page with a list of mini tutorials, things like for example:

• how to query the bnUSD/sICX price on Balanced?
• how to sign a transaction with ICONex on the client side of a web app?
• how to get the current goloop version of an API or validator node?

this React page for reference (https://reactjs.org/community/examples.html)

What needs to be done

Creating a test task as an example.

Why it needs to be done

For fidelve to learn how to open tasks in zenhub

Stories

As a developer I need to understand how to create task in zenhub so that I'm able to create them in the future.

Acceptance Criteria

This "test task" will be visible in the zenhub UI.

Overview

A continuous epic to improve the documentations for the ICON community. This includes IIPs, documentations, tutorials, and other applicable sources

Story

As a technical developer, I want to understand all common processes so that I can develop effectively in the ICON community

As a typical user, I want to know where I can go to learn about the ICON ecosystem and all of the systems that make it up

As a contributor, I want to create a set of documentations that follows logical, hierarchical documentation patterns so that this resource set remains organized and extensible

JSON Standard for PRep details information

as discussed in the discord channels, this document can be made more easily accessible by reference it in a section under "Advance Topics > Validator nodes"

it also needs to be fixed the 3 dead links in the JSON_RPC API V3 page that reference it.

#43

What needs to be done

Update info from Electric Capital Developer Report on Crypto Ecosystems

https://github.com/electric-capital/crypto-ecosystems/blob/master/data/ecosystems/i/icon.toml

Why it needs to be done

It is sort of important for the community and for other communities

Can someone with admin access update the link in the about section to docs.icon.community, as icondev.io has been deprecated.

Primary goal is to review this document and add it to docs.icon.community in their respective sections. Also worth noting is that some of this document didn't actually get implemented as originally planned, so it's important to look into the Goloop code / discuss with @goldworm to figure out what is live on main net and what is just plans/ideas.

For example, "Leader is selected randomly" is a goal/idea, but it's actually Round Robin on main net (a good example of something that needs to be in docs.icon.community so people know how our network functions).

https://docs.google.com/document/d/1WZzbiuMbT7XNKwuGXata20G6B0gnzW7qcGTfCXEpZ1w/edit?usp=sharing

https://icondev.io/getting-started/how-to-create-an-icon-account#using-goloop-cli

"Then get test ICX in Lisbon using the faucets."

faucets link should be changed to https://icondev.io/icon-stack/icon-networks/main-network#test-network-faucets

Document this: https://forum.icon.community/c/g/smart-contract-audit-request/46

Last step of 'concepts' -> 'governance' -> 'network proposal' -> 'registering and voting network proposals' should be applyProposal()

This step was not clear when submitting a recent network proposal. Please add it to the bottom of that page

https://forum.icon.community/t/icon2-full-disk-space-2tb/3049/2