Giter VIP home page Giter VIP logo

guide's Introduction

Aergo Guide

Readthedocs

This is the official guide and documentation for the AERGO blockchain platform.

Contribute

Feel free to edit any of the articles directly. Any contribution, including simple typo fixes, is more than welcome. We are looking forward to your pull request.

For anything that involves more than simple text changes, please test the build locally to see that everything looks right.

Pre-requisites:

  1. Install Sphinx globally: pip install -U sphinx
  2. Install local requirements: pip install -r requirements.txt

Build locally:

make html

Re-generate GRPC reference:

make protoc

guide's People

Contributors

acktsap avatar ashen1dev avatar chris2nd avatar dayoungkim avatar eve2adam avatar everjs78 avatar graup avatar hanlsin avatar hannah-shin avatar hayarobi avatar kjunu avatar kroggen avatar kslee8282 avatar mlogue76 avatar nepho8 avatar qcollapse avatar sg31park avatar sunpuyo avatar ultrafellen avatar xiaomingloveqinger avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

guide's Issues

Using testnet

Need to copy over the relevant sections from the release announcement and add some details.

Missing information:

  • public hostname for RPC
  • public IP for peering

Missing section on configuring BP / full nodes

https://docs.aergo.io/en/latest/running-node/configuration.html says:

There are three common modes of operation for aergo server:

  • BP Node - Block provider node, which mines and propagates blocks
  • Full Node - Node to get and validate all blocks
  • Single Node - BP Node without peer, which uses to something like test.

We describe only single node configuration in this. More will updated for the BP Node and full node.

So currently it is not clear how to join e.g. the testnet. I see that #4 was closed but not sure what the resolution was.

Document iteration over state.map()

It's not clear from the guide whether it's possible to iterate over a state.map(). Based on my reading of contract/state_module.c, I see that state_array_iter is implemented, but there is no corresponding state_map_iter. So it seems that this is not possible. If I'm right then this limitation should be documented, and it should be made clear that it doesn't behave like a normal table.

I have found a workaround, which is to use a state.value() and then set it to a table, but this makes reading/writing quite awkward.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.