leapdao/docs

LeapDAO documentation for developers and validators

docs's Issues

Validator page: what is coinbase transactions?

Block Reward - Is a set of newly minted tokens that the validator includes as a coinbase transactions in the block that it proposes.

This sentence is confusing. We don't have coinbase transactions in Leap Network

Update JSON RPC docs

Add plasma_* methods

Plasma dApps for Beginners - blog post / docs copy

Scope

• Describe all the steps necessary to create your first speding condition and run it on the network
• Base it on the content of the video: https://www.youtube.com/watch?v=cB5T0buF8GI

Deliverables

• blog post copy
• docs page updated https://docs.leapdao.org/spending-conditions/

Gains for the project

• education of the developer ecosystem

Roles
gardener @kohola71 / 10%
worker name @DistributedDoge / 75%
reviewer @johannbarbie / 15%

bounty Size - S (5hrs)

Validator page: define Period

Glossary is missing definition for a Period.

RPC: update docs for getUnspent

Requires: leapdao/leap-core#137, leapdao/leap-core#139, leapdao/leap-node#325

Raw data:

all the utxos: getUnspent()
all the utxos for address: getUnspent(address)
all the utxos of a given color: getUnspent(null, color)
all the utxos of a given token: getUnspent(null, tokenAddress)
all the utxos of a given color for address: getUnspent(address, color)
all the utxos of a given token for address: getUnspent(address, tokenAddress)

Create a properly formatted docs for the info above

Self-hosted docs

Readthedocs just using mkdocs under the hood, but showing ad on our pages.

We can use travis to build docs with mkdocs and deploy it into s3 bucket

Pros:

• No ad
• https
• Flexible

Cons:

• Need to setup

Add leap-core docs

• Structures
• How to build inputs, outputs and transactions
• How to send transactions
• helpers
• ...

Consider adding odcs directly in leap-core code using document.js syntax. So that we can latter autogenerate the docs

Link for spending conditions example is broken

The link for the example of a spending condition mentioned here is broken. I think it should point to https://github.com/leapdao/spending-conditions/blob/master/contracts/SpendingCondition.sol . We can also remove the link from the text as well as the text says "You can find an example for a spending condition in our repositories" and just leave the link for "our repositories"

Update "Setting up local dev env" page

The guide was written quite a long time ago (in Parsec era to be precise) and only quickly updated since then, so may be incorrect/incomplete

https://github.com/leapdao/leap-contracts/wiki/Setting-up-local-development-environment

• recheck steps
• add PoA slot activation step
• update screenshots maybe if they dated

Improve "Become a validator" page

• instructions for the firewall setup (which ports to open)
• example of the systemd setup and how to use

RPC: add consolidateUTXO helper

Use https for self-hosted docs

Validator page: LEAP token and fees

LEAP is needed to pay fees for contract executions only.

Write a docs article about "How to build a Plasma dApp"

Bounty

Write a docs article about "How to build a Plasma dApp".

Scope

• contain simple code examples.
• describe dApp creation in simple reproducible steps.
• contain links to github repository with the working code used as an example.

Deliverables

• Page in the docs linked from the landing page.

Gain for the project

Encouraging ecosystem developers to use our platform and make it more simple by providing concrete example of creating a plasma dApp - thus bring mass adoption closer.

Publicly visible delivery

Page in the docs available for all ecosystem developers.

Some existing examples

http://leap.dungeonriches.com
https://testnet.leapdao.org
https://cannes.motion.ooo

Roles

bounty gardener: @articobandurini / 15%
bounty worker: @MaxStalker / 70%
bounty reviewer: @articobandurini / 15%

Add missing JSON RPC endpoints

• eth_call
• eth_getCode
• eth_sendRawTransactionBatch
• validator_getAddress
• checkSpendingCondition

Validator page: fee is charged of the stake?

Tax - A fee which is charged on the stake for each EPOCH.

Tax is charged on a block reward. Proof

The tax depends on the collective performance of the validators.

Tax depends on a governance. Proof

Add some branding and social tweaks

Some of the things to change:

• logo
• title
• snippet which is shown when link is shared
• color scheme

Recipes. Use-web3. Fix.

web3.version 1.2.5-rc.0
Get token balance
web3.getBalance is not a function
web3.eth.getBalance works.

Update docs for 'plasma_getColors' with NST support

It is now possible to call plasma_getColors with [false, true] to get registered NSTs

How to start leap in local ?

Actually, I am a newbie in plasma-leap.

I understand the concept of plasma-leap, But I don't know how to run it in local.

You know, There are so many repos...

How can I run Testnet, contracts (bridge, operator, exitHandler), nodes, plasma EVM and web ?

I need this project and I want to start whole thing in local for test. Please help me.

Validator page wording: "Epoch is a period of x blocks.. "

using a word "period" may be confusing here as we have a notion of Period.

Typo on a "Validators » Leap Network Introduction"

How to become a validator on LeapDAO testnet

Scope

• Explain the steps a validator candidate needs to take.
• Update this: https://docs.leapdao.org/connect/

Deliverables

• blog post copy / docs updated

Gain for the project

• Validator community education

Roles:

bounty gardener: @kohola71 / 10%
bounty worker: name / share
bounty reviewer: name / share

Update/Clarify Validator Document

Scope

• Gather info from bugs / error messages / dead ends
• Add and update new info
• Rewrite passages that are unclear
• check github descriptions and update or simple redirect them to docs.leapdao.org

Deliverables

Adding and rewriting text on "How to set up a node" in the existing document

Gain for the project

Set foundation for testing environment to decentralize the Leap Network.

Roles

bounty gardener: @MaxKuck / 10%
bounty worker: @MaxKuck / 40%
worker @troggy / 25%
bounty reviewer: @johannbarbie / 25%

Research on community best-practices

Resources

README

https://github.com/RichardLitt/standard-readme — spec, linter and generator
https://github.com/noffle/art-of-readme

Contribution

http://scottchacon.com/2011/08/31/github-flow.html

Ethics

https://www.w3.org/Consortium/cepc/

Everything

https://github.com/davidbgk/open-source-template/

Add docs for plasma_getTransactionByPrevOut API

"Beginners guide" page for ecosystem-developers on our website

Bounty

Scope

Create a "Beginners guide" page for ecosystem-developers on our website - it will be linked from the landing page and should contain basic information for ecosystem beginners in order to bootstrap them quickly and answer most of the questions they may have when onboarding.

It's for ecosystem developers, not internal, so it should be focused on usage of our system for creating dApps - leveraging plasma, writing spending conditions, etc.

Deliverables

Pull request with a page called "beginners-guide.html" linked from the landing page.

Gain for the project

Encouraging ecosystem developers to use our platform and make it more simple - thus bring mass adoption closer.

Publicly visible delivery

Page on the website available for all ecosystem developers.

Roles

bounty gardener: @articobandurini / 15%
bounty worker: name / 70%
bounty reviewer: name / 15%

"Migrate existing dApp to Plasma Leap" page on our website

Bounty

Scope

Create a "Migrate existing dApp to Plasma Leap" page for ecosystem developers on our website - it will be linked from the landing page and should contain information needed to migrate an existing dApp based to our platform. It should contain simple code examples of this kind of dApp described in steps enough to reproduce and migrate the dApp at home.

Deliverables

Pull request with a page called "migrate-dapp.html" linked from the landing page.

Gain for the project

Encouraging ecosystem developers to use our platform and make it more simple by providing concrete example of migrating a plasma dApp - thus bring mass adoption closer.

Publicly visible delivery

Page on the website available for all ecosystem developers.

Roles

bounty gardener: @articobandurini / 15%
bounty worker: @MaxStalker / 70%
bounty reviewer: @articobandurini / 15%

Add instructions: How to become Leap Network validator

Scope

• Explain the steps a validator candidate needs to take.
• Update this: https://docs.leapdao.org/connect/

Deliverables

• docs updated
• running validator on Leap Testnet

Gain for the project

• Validator community education

Roles:

bounty gardener: @MaxKuck / 10%
bounty worker: @MaxKuck @johannbarbie / 80%
bounty reviewer: eswarasai / 10%

Validator page: "Explanation - How to set up a Node" link is missing

Create a "Contribution reward disclaimer" page

Quick summary of:

• what LeapDAO can offer to contributors and on what terms. Linking to relevant policies.
• what LeapDAO is NOT offering

Document `fastSellUTXO` and `fastSellAmount` helpers of leap-core

See leapdao/leap-core#85

"Get started" page for developers on our website

Bounty

Scope

Create a "Get started" page for developers on our website - it will be linked from the landing page and should contain basic information for beginners in order to bootstrap them quickly and answer most of the questions they may have when onboarding.

It's for internal developers, not ecosystem, so it should be focused on our implementation of Plasma, Spending Conditions, SolEVM, wallet and other parts of our system.

Deliverables

Pull request with a page called "getting-started.html" linked from the landing page.

Gain for the project

Reduce time needed to start developing on our platform and questions asked in "new developers" channel, etc. Also make learning curve as less steep as possible.

Publicly visible delivery

Page on the website available for all new developers.

Roles

bounty gardener: @articobandurini / 15%
bounty worker: name / 70%
bounty reviewer: name / 15%

How to migrate a dApp to Plasma - blog post / doc

Scope

• describe the steps necessary to migrate a dApp from layer 1 to layer 2
• explain how to modify the storage of the contract / how to deploy the contract
• how to use the same tools that devs know from the mainnet to talk to the contract (send transactions)

Deliverables

• blog post copy / updated docs

Gain for the project

• ecosystem developer education

Roles:

bounty gardener: @kohola71 / 10%
bounty worker: name / share
bounty reviewer: @johannbarbie / share

Size - M (8 hrs)