nanocurrency / nano-docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for the Nano protocol
Home Page: https://docs.nano.org/
Documentation for the Nano protocol
Home Page: https://docs.nano.org/
WebSockets: From https://docs.nano.org/running-a-node/configuration/#nodewebsocket to https://docs.nano.org/integration-guides/websockets/
Voting: From https://docs.nano.org/running-a-node/configuration/#nodeenable_voting and https://docs.nano.org/running-a-node/configuration/#nodevote_minimum to representative setup guide
Documentation for nanocurrency/nano-node#2361
Relate to #248 - look into updates to the Pre-caching section of the Work Generation page to potentially add better guidance or specific examples to better help external integration manage pre-caching optimally.
For:
Also the new beta threshold, 2x higher for sends, 2x lower for receives.
Move IPC Integration section of the Advanced Integration Guides page to it's own page and update with IPC 2.0 content from:
https://github.com/cryptocode/notes/wiki/IPC-Flatbuffers-API
https://github.com/cryptocode/notes/wiki/IPC-2.0---RPC-gateway
https://github.com/cryptocode/notes/wiki/IPC-Authorization
Related PRs
nanocurrency/nano-node#2487
Relate to #248 - look into updates to the Difficulty thresholds section of the Work Generation page to potentially add better guidance or specific examples to better help external integration manage work levels properly.
https://docs.nano.org/integration-guides/key-management/#external-management
There are details on send
and receive
blocks, but not the first receive
(also known as open
).
Docs needed for nanocurrency/nano-node#2588
RPC command additions and other details to help make telemetry useful (response definitions?)
Related to: nanocurrency/nano-node#2446 and nanocurrency/nano-node#2521
By default it will return blocks not in active but unconfirmed (e.g., block was received but node restarted, election was dropped, new ledger with reset conf height)
Some stats were added with nanocurrency/nano-node#2485
Add documentation for nanocurrency/nano-node#2221
Do not include a full example anymore, but explain how to generate documented TOML files.
RPC - account_info
RPC now includes confirmation_height_frontier
block hash of the most cemented block.
Based on nanocurrency/nano-node#2455 new CLI command to automate most things.
The documentation should be updated at some point regarding the key derivation. I think it's correct info, just missing a few points.
I think it should be written by someone who really knows this, I just found out by trial and error.
For example from here: https://docs.nano.org/integration-guides/the-basics/#seed
PrivK[i] = blake2b(outLen = 32, input = seed || i)
That's true but should be noted that seed is not the same as the BIP39 seed which is 128 in length.
From here: https://docs.nano.org/integration-guides/key-management/
Derived Private Key for 44'/165'/0'
Yes, that's also true but should be noted that type of derivation is not the same as the one mentioned above using blake2b. It results in different private keys!
Should also be mentioned that the 24-word mnemonic can be derived from a Nano 64 length seed using either
BIP39:
mnemonic = bip39.entropyToMnemonic('seed')
or using nanocurrency-web-js like so:
mnemonic = wallet.generate('seed').mnemonic
Furthermore, the 64 nano seed can also be derived from a 24-word mnemonic by:
seed = bip39.mnemonicToEntropy(mnemonic)
Maybe also mention how to get the private key using both derivation methods (from either nanocurrency-web-js or nanocurrency-js
Default Nano (nanocurrency-js, index 0):
privKey = nano.deriveSecretKey(seed, 0)
Should be the same as blake2b(outLen = 32, input = seed || 0) but haven't tested
Ledger key (nanocurrency-web-js, index 0, seed is 64 char (also called entropy), nanowallet.seed is the 128 char BIP39 seed):
nanowallet = wallet.generate(seed)
accounts = nanowallet.accounts(nanowallet.seed, 0, 0)
privKey = accounts[0].privateKey
This should be the same as BIP39 derivation from 44'/165'/0'
In the tables on https://docs.nano.org/releases/node-releases/ to call out legacy vs. state v1, etc.
https://docs.nano.org/running-a-node/troubleshooting/#statistics-from-rpc
...and update the configuration since it's no longer json
Following nanocurrency/nano-node#2349
To accommodate integrations preparing for epoch upgrade transition post-V21 release.
After nanocurrency/nano-node#2204 RC/DB tags are not automatic, to have them in --version
must do:
TRAVIS_TAG="TAG you want for version string e.g. v20RC1" cmake --build . -DCI_BUILD=TRUE <other CMAKE variables>
https://docs.nano.org/integration-guides/advanced/#websocket-support
Needs a small callout when used in a docker node. The default websocket address in that situation is "::ffff:0.0.0.0"
. In the docker run command, -p 127.0.0.1:7078:7078
must be added (57000 for a beta node).
Related to #248 - update the benchmarks to include new CPU/GPU targets with epoch v1 and new epoch v2 difficulties
Related to nanocurrency/nano-node#2535
To cover changes in nanocurrency/nano-node#2175
Auto mode (default): If not Principal Representative, start frontier confirmation process every 15 minutes; if Principal Representative, start frontier confirmation process every 3 minutes
Always: Start frontier confirmation process every 3 minutes
Disabled: Do not start frontier confirmation process
The node prints this message when "::ffff:0.0.0.0"
is set as address an control is enabled: WARNING: control-level RPCs are enabled on non-local address ::ffff:0.0.0.0, potentially allowing wallet access outside local computer
We should add more information on this in the documentation and include the link in the printed message.
If not using docker:
If using docker:
run
command is createdufw
to only allow certain IPs through the RPC port, docker overrides this unless a special configuration is used.Related to #248
Hello,
I asked quite a while ago about the eventuality of translating the documentation. I was answered to wait for the release of the new version of the official website, which is now online.
Any plans on the way to let people translate the doc, now ? I'm quite eager to.
The current setup for RPC commands needs some cleanup including:
Suggestions for how best to do the formatting of request/response details are welcome. A possible approach was included for the account_balance
, account_block_count
and account_info
calls using tables for keys, version, format, etc.
Once we get the suggested formatting down additional cleanup efforts on the remaining calls can be done more consistently and this ticket will be used to help track that work.
Page here: https://docs.nano.org/running-a-node/beta-network/
At least add in details from this: nanocurrency/nano-node#1847 (reverted) nanocurrency/nano-node#2186
The section Validating blocks and voting weights mentions --compare_rep_weights
CLI command option, which can not be recognized in recent nano_node
. It should be denoted as V21+ specific command option.
nanocurrency/nano-node#2283 is modifying all accounts to use the representative account instead of the representative block. This has been found to take a few minutes on some systems.
The account_info
RPC should mark rep_block
as deprecated and the representative shown by default when it eventually gets removed, RPC 2.0?
Add documentation for nanocurrency/nano-node#2298
@zhyatt
This is available since v19, can we start recommending it now by using it in the documentation examples? The formatted output is much easier to read.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.