Commit graph

292 commits

Author SHA1 Message Date
Alesio Kanani
4155555f80
Spelling Improvements (#3642)
* Spelling Improvement
2021-05-13 14:07:14 -04:00
John Tromp
f86102b2a6
fixDAA; implement wtema (#3477)
* implement wtema

* reduce FTL from 12 to 5 mins; fix inaccuracies in cuckoo doc

* rename difficulty window for DampedMovingAverage DAA

* fix FTL error msg

* secondary_scale becomes extended nonce past HF4

* secondary_scale change actually belongs in hardfork4 PR

* make future time limit configurable

* define constant global::DEFAULT_FUTURE_TIME_LIMIT and refactor a bit

* fix typos

* as_ref() feels safer than as_mut() :-)

* remove obsolete mut

* make future_time_limit non-mandatory in grin-server.toml
2020-11-25 10:58:39 +00:00
Quentin Le Sceller
cf2a65242d
Rename Floonet to Testnet (#3431)
* Rename Floonet to Testnet

* Fix test

* Rename test and docker
2020-10-07 09:36:02 -04:00
Paouky
dfd0a649c7
Organize doc files (#3436)
* create and occupy translations dir

* update translation links

* add mimblewimble whitepaper

* add p2p_protocol from docs

* add validation_logic from docs

Co-authored-by: Paouky <Paouky@users.noreply.github.com>
2020-09-10 09:45:14 -04:00
draz3nv
110deff702
[Docs] Revision to intro page (#3281)
* Update intro.md

Co-authored-by: Quentin Le Sceller <q.lesceller@gmail.com>
2020-08-11 17:43:06 -04:00
goyle
34ff103bb0
Update link to podcast featuring tromp (#3283) 2020-03-30 11:10:42 -05:00
jaspervdm
7385e8ce7f
Update API docs (#3277) 2020-03-28 12:53:20 +01:00
Jakob Abfalter
bcf3e4e4e4
[Docs] Rangeproof output documentation (#3234)
* [Docs] Added output byte documentation of the rangeproofs

* [Doc] Adjusted wording on bulletproof byte documentation
2020-02-25 18:20:55 +01:00
Ramin Soltanzadeh
a41965e024
Update intro.md (#2975)
* Update intro.md

Significant clarifications, especially in the paragraph where excess value is introduced and the section about kernel offsets.

* fix and clarify section about kernel offsets

"Splitting" the blinding factor into *k1* and *k2* is unnecessarily confusing I think. The excess and the offset are really two arbitrary numbers without any mathematical relation to each other. I think I rephrased the section as well as I could without sacrificing any correctness for the sake of simplicity (which I think would be more confusing than helpful).

* do the same fixes for the Swedish version

* small fix regarding aggregation

Transactions are not aggregated by non-mining nodes as well. Removed the part about miners.

Co-authored-by: Quentin Le Sceller <q.lesceller@gmail.com>
2020-02-04 15:50:06 -05:00
lehnberg
6c528654df
Update build.md to remove min version of Rust (#3219)
As per https://github.com/mimblewimble/grin-pm/blob/master/notes/20200121-meeting-development.md#decision-no-min-rust-version
2020-02-04 15:46:16 -05:00
Leo Young
a73a54a10e [Done][doc] Chinese Translation (#3122)
* Create grin4bitcoiners_ZH-CN

* Rename grin4bitcoiners_ZH-CN to grin4bitcoiners_ZH-CN.md

* Create contract_ideas_ZH-CN.md

Chinese translation

* Create coinbase_maturity_ZH-CN.md

* Create contracts_ZH-CN.md

* Create stratum_ZH-CN.md

* Create switch_commitment_ZH-CN.md

* Create table_of_contents_ZH-CN.md

* Update contracts_ZH-CN.md

* Update contracts.md

* Chinese Translation added

* Update coinbase_maturity_ZH-CN.md

* Update coinbase_maturity.md

* Update switch_commitment_ZH-CN.md

* Update switch_commitment.md

* Update switch_commitment_ZH-CN.md

* Update switch_commitment_ZH-CN.md

* Update contracts_ZH-CN.md

* Update coinbase_maturity_ZH-CN.md

* Update table_of_contents_ZH-CN.md

* Create table_of_contents.md

* Delete table_of_contents_.md

* Update switch_commitment_ZH-CN.md

* Update stratum_ZH-CN.md

* Update stratum.md

* Update coinbase_maturity_ZH-CN.md

* Update coinbase_maturity_ZH-CN.md

* Update contracts_ZH-CN.md

* Update switch_commitment_ZH-CN.md
2020-01-08 10:53:47 -05:00
Xavier Lau
0c6c464e94 Chinese translation (#3098)
* add: simplified Chinese translation
2019-11-26 14:57:01 +01:00
Lars-Magnus Skog
f07a897e33 docs: grin wallet was lifted out in v1.1.0 (#3123) 2019-11-26 14:51:47 +01:00
Quentin Le Sceller
04e7d307ce Replace MimbleWimble by Mimblewimble (#3118)
* Replace MimbleWimble by Mimblewimble

* MimbleWimble->Mimblewimble
2019-11-19 10:49:32 +00:00
Leo Young
a1061f09a8 [doc]Chinese Translation: grin4bitcoiners_ZH-CN.md (#3116)
* Create grin4bitcoiners_ZH-CN

* Rename grin4bitcoiners_ZH-CN to grin4bitcoiners_ZH-CN.md
2019-11-14 10:34:44 -05:00
Shannon
eadf66339d fix a spelling mistake (#3106) 2019-10-31 19:04:54 +01:00
Xavier Lau
b4e42bef8d mmr simplified Chinese translation (#3095) 2019-10-17 09:17:32 -04:00
hirogasa
9bb14b4864 [DOC] Update japanese translation (#3020)
* Fix typo

* Fix markdown

* Update translation

* "MimbleWimble" -> "Mimblewimble"
2019-10-16 11:04:42 -04:00
Quentin Le Sceller
2ee8d06d48 Remove deprecated v1 wallet owner api documentation (#3071)
* Remove deprecated v1 wallet owner api documentation

* Fix typo
2019-10-02 09:40:56 +01:00
Quentin Le Sceller
213daf72ca
Add missing doc and route for Node API (#3059)
* Add missing doc and route for Node API
2019-09-26 11:44:44 -04:00
Nikolay Volf
108b640c22 Update mmr.md (#3024) 2019-09-10 16:50:10 +01:00
jaspervdm
0e62b7e43e Optionally add rangeproofs to block api (#2999) 2019-09-03 15:52:33 +01:00
jackiszhp
2cebdc5868 it was miscounted (#3013) 2019-09-02 10:13:46 +01:00
Mattia Rossi
ea023387bf Fix doc grin <subcommand> help syntax. (#2991) 2019-08-20 18:05:26 +01:00
antiochp
c6cea4744c
Merge branch 'master' into milestone/2.x.x 2019-07-24 15:10:26 +01:00
Chengcheng Zhang
9040b5b774 Update intro_ZH-CN.md (#2965) 2019-07-24 13:18:10 +02:00
Ramin Soltanzadeh
eff24723d0 Update Swedish intro.md (#2968)
* Update Swedish intro.md

Significant improvements, including a less excessive translation of the English terminology.
2019-07-24 12:02:10 +01:00
Quentin Le Sceller
121e6c8c46
[DOC] Translate documents & fix some typo (#2952)
*  add files for translation

*  WIP translation

* finish to translate coinbase_maturity.md && fix some typo to understand easily

*  add doc link in coinbase_maturity.md

*  remove wrong file

* Fix typo and unecessary word
2019-07-18 11:42:34 +02:00
lehnberg
7434eca5d0
update Dandelion documentation (2.x.x) (#2942)
* update dandelion documentation as per PR#2723
* remove dandelion simulation docs as per PR#2723
2019-07-08 15:18:21 +01:00
Quentin Le Sceller
ee9b9fe763
Update minimum required rust version and dockerfile (#2858) 2019-05-28 11:02:10 -04:00
hashmap
9c32321c57
Fix the curve name in one section of intro (#2823) 2019-05-17 22:03:17 +02:00
Max Levy
136a4ba207 a tiny clarification about the point H (#2774)
IMHO, introducing the point _H_ explicitly makes the explanation arguably a bit more clear
2019-05-14 14:05:54 -07:00
Daogang Tang
15b56a97f5 docs: fix typo. (#2816)
Signed-off-by: Mike Tang <daogangtang@gmail.com>
2019-05-13 14:47:09 -07:00
fresheneesz
7f12b45a34 Updating the (dead) link to the transaction UML (#2798) 2019-05-02 15:16:04 -04:00
Yeastplume
12fe928112
merge master into 1.1.0 2019-04-16 11:24:43 +01:00
Aidan_MegaSolar
dbbad7be03 [DOC] Translation some files in doc dir. (#2750)
*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

* remove some useless md files for translation. this is rearrange set up translation order.

*  add dot end of sentence & translate build.md in korean

*  remove fast-sync_KR.md

*  finish build_KR.md translation

*  finish build_KR.md translation

*  finish translation state_KR.md & add phrase in state.md to move other language md file

* translate blocks_and_headers.md && chain_sync.md in Korean

*  add . in chain_sync.md , translation finished in doc/chain dir.

* fix some miss typos

*  start to translate dandelion.md & simulation.md in Korean.

*  [WIP] translation

* [WIP] files add.

* [WIP] dandelion simulation

*  finish pruning translation

*  doc/dandelion translation in Korean finish

*  start to translation mmr, merkle, switch commitment in Korean

*  [WIP] merkle_KR.md

*  finish translation mmr.md & merkle.md

*  delete [WIP]switch_commitment_KR.md

*  add pow_KR.md for translation

*  finish translation grin4bitcoiners

*  fix for merge

*  fix for merge

*  fix for merge

* ,

* POW & grin4bitcoiner.md translated in Korean.

* fix some typo and cargo.lock
2019-04-12 15:32:11 -07:00
Yeastplume
5cb8025ddd
[1.1.0] Merge master into 1.1.0 (#2720)
* cleanup legacy "3 dot" check (#2625)

* Allow to peers behind NAT to get up to preferred_max connections (#2543)

Allow to peers behind NAT to get up to preffered_max connections

If peer has only outbound connections it's mot likely behind NAT and we should not stop it from getting more outbound connections

* Reduce usage of unwrap in p2p crate (#2627)

Also change store crate a bit

* Simplify (and fix) output_pos cleanup during chain compaction (#2609)

* expose leaf pos iterator
use it for various things in txhashset when iterating over outputs

* fix

* cleanup

* rebuild output_pos index (and clear it out first) when compacting the chain

* fixup tests

* refactor to match on (output, proof) tuple

* add comments to compact() to explain what is going on.

* get rid of some boxing around the leaf_set iterator

* cleanup

* [docs] Add switch commitment documentation (#2526)

* remove references to no-longer existing switch commitment hash

(as switch commitments were removed in ca8447f3bd
and moved into the blinding factor of the Pedersen Commitment)

* some rewording (points vs curves) and fix of small formatting issues

* Add switch commitment documentation

* [docs] Documents in grin repo had translated in Korean.  (#2604)

*  Start to M/W intro translate in Korean
*  translate in Korean
*  add korean translation  on intro
* table_of_content.md translate in Korean.
*  table_of_content_KR.md finish translate in Korean, start to translate State_KR.md
*  add state_KR.md & commit some translation in State_KR.md
*  WIP stat_KR.md translation
*  add build_KR.md && stratum_KR.md
*  finish translate stratum_KR.md & table_of_content_KR.md
*  rename intro.KR.md to intro_KR.md
*  add intro_KR.md file path each language's  intro.md
*  add Korean translation file path to stratum.md & table_of_contents.md
*  fix difference with grin/master

* Fix TxHashSet file filter for Windows. (#2641)

* Fix TxHashSet file filter for Windows.

* rustfmt

* Updating regexp

* Adding in test case

* Display the current download rate rather than the average when syncing the chain (#2633)

* When syncing the chain, calculate the displayed download speed using the current rate from the most recent iteration, rather than the average download speed from the entire syncing process.

* Replace the explicitly ignored variables in the pattern with an implicit ignore

* remove root = true from editorconfig (#2655)

* Add Medium post to intro (#2654)

Spoke to @yeastplume who agreed it makes sense to add the "Grin Transactions Explained, Step-by-Step" Medium post to intro.md

Open for suggestions on a better location.

* add a new configure item for log_max_files (#2601)

* add a new configure item for log_max_files

* rustfmt

* use a constant instead of multiple 32

* rustfmt

* Fix the build warning of deprecated trim_right_matches (#2662)

* [DOC] state.md, build.md and chain directory documents translate in Korean.  (#2649)

*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

* remove some useless md files for translation. this is rearrange set up translation order.

*  add dot end of sentence & translate build.md in korean

*  remove fast-sync_KR.md

*  finish build_KR.md translation

*  finish build_KR.md translation

*  finish translation state_KR.md & add phrase in state.md to move other language md file

* translate blocks_and_headers.md && chain_sync.md in Korean

*  add . in chain_sync.md , translation finished in doc/chain dir.

* fix some miss typos

* Api documentation fixes (#2646)

* Fix the API documentation for Chain Validate (v1/chain/validate).  It was documented as a POST, but it is actually a GET request, which can be seen in its handler ChainValidationHandler
* Update the API V1 route list response to include the headers and merkleproof routes.  Also clarify that for the chain/outputs route you must specify either byids or byheight to select outputs.

* refactor(ci): reorganize CI related code (#2658)

Break-down the CI related code into smaller more maintainable pieces.

* Specify grin or nanogrins in API docs where applicable (#2642)

* Set Content-Type in API client (#2680)

* Reduce number of unwraps in chain crate (#2679)

* fix: the restart of state sync doesn't work sometimes (#2687)

* let check_txhashset_needed return true on abnormal case (#2684)

*  Reduce number of unwwaps in api crate  (#2681)

* Reduce number of unwwaps in api crate

* Format use section

* Small QoL improvements for wallet developers (#2651)

* Small changes for wallet devs

* Move create_nonce into Keychain trait

* Replace match by map_err

* Add flag to Slate to skip fee check

* Fix secp dependency

* Remove check_fee flag in Slate

* Add Japanese edition of build.md (#2697)

* catch the panic to avoid peer thread quit early (#2686)

* catch the panic to avoid peer thread quit before taking the chance to ban
* move catch wrapper logic down into the util crate
* log the panic info
* keep txhashset.rs untouched
* remove a warning

* [DOC] dandelion.md, simulation.md ,fast-sync.md and pruning.md documents translate in Korean. (#2678)

* Show response code in API client error message (#2683)

It's hard to investigate what happens when an API client error is
printed out

* Add some better logging for get_outputs_by_id failure states (#2705)

* Switch commitment doc fixes (#2645)

Fix some typos and remove the use of parentheses in a
couple of places to make the reading flow a bit better.

* docs: update/add new README.md badges (#2708)

Replace existing badges with SVG counterparts and add a bunch of new ones.

* Update intro.md (#2702)

Add mention of censoring attack prevented by range proofs

* use sandbox folder for txhashset validation on state sync (#2685)

* use sandbox folder for txhashset validation on state sync

* rustfmt

* use temp directory as the sandbox instead actual db_root txhashset dir

* rustfmt

* move txhashset overwrite to the end of full validation

* fix travis-ci test

* rustfmt

* fix: hashset have 2 folders including txhashset and header

* rustfmt

* 
(1)switch to rebuild_header_mmr instead of copy the sandbox header mmr 
(2)lock txhashset when overwriting and opening and rebuild

* minor improve on sandbox_dir

* add Japanese edition of state.md (#2703)

* Attempt to fix broken TUI locale (#2713)

Can confirm that on the same machine 1.0.2 TUI looks great and is broken on
the current master. Bump of `cursive` version fixed it for me.
Fixes #2676

* clean the header folder in sandbox (#2716)

* forgot to clean the header folder in sandbox in #2685

* Reduce number of unwraps in servers crate (#2707)

It doesn't include stratum server which is sufficiently changed in 1.1
branch and adapters, which is big enough for a separate PR.

* rustfmt

* change version to beta
2019-04-01 11:47:48 +01:00
34ro
82b1cf85d6 add Japanese edition of state.md (#2703) 2019-03-29 15:25:41 -07:00
GandalfThePink
ba6f12c70b Update intro.md (#2702)
Add mention of censoring attack prevented by range proofs
2019-03-26 11:40:35 -07:00
Michalis Kargakis
994ed85d90 Switch commitment doc fixes (#2645)
Fix some typos and remove the use of parentheses in a
couple of places to make the reading flow a bit better.
2019-03-26 13:45:57 +01:00
Aidan_MegaSolar
73a46c6190 [DOC] dandelion.md, simulation.md ,fast-sync.md and pruning.md documents translate in Korean. (#2678) 2019-03-23 13:50:26 -07:00
34ro
148256de6e Add Japanese edition of build.md (#2697) 2019-03-23 13:37:11 -07:00
Mark Renten
7678aceddf Specify grin or nanogrins in API docs where applicable (#2642) 2019-03-11 15:58:08 -07:00
Peter Mrekaj
c0880443c0 refactor(ci): reorganize CI related code (#2658)
Break-down the CI related code into smaller more maintainable pieces.
2019-03-11 23:23:16 +08:00
Agreene
a7a160a5d4 Api documentation fixes (#2646)
* Fix the API documentation for Chain Validate (v1/chain/validate).  It was documented as a POST, but it is actually a GET request, which can be seen in its handler ChainValidationHandler
* Update the API V1 route list response to include the headers and merkleproof routes.  Also clarify that for the chain/outputs route you must specify either byids or byheight to select outputs.
2019-03-10 20:18:21 -07:00
Aidan_YOUNGJUN
42fee8d1a5 [DOC] state.md, build.md and chain directory documents translate in Korean. (#2649)
*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

*  add md files for translation.

*  start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md

* add dandelion_KR.md && simulation_KR.md for Korean translation.

* remove some useless md files for translation. this is rearrange set up translation order.

*  add dot end of sentence & translate build.md in korean

*  remove fast-sync_KR.md

*  finish build_KR.md translation

*  finish build_KR.md translation

*  finish translation state_KR.md & add phrase in state.md to move other language md file

* translate blocks_and_headers.md && chain_sync.md in Korean

*  add . in chain_sync.md , translation finished in doc/chain dir.

* fix some miss typos
2019-03-10 20:17:12 -07:00
Brandon Arvanaghi
7fd2970971 Add Medium post to intro (#2654)
Spoke to @yeastplume who agreed it makes sense to add the "Grin Transactions Explained, Step-by-Step" Medium post to intro.md

Open for suggestions on a better location.
2019-03-06 09:21:34 +00:00
Aidan_YOUNGJUN
d73124c469 [docs] Documents in grin repo had translated in Korean. (#2604)
*  Start to M/W intro translate in Korean
*  translate in Korean
*  add korean translation  on intro
* table_of_content.md translate in Korean.
*  table_of_content_KR.md finish translate in Korean, start to translate State_KR.md
*  add state_KR.md & commit some translation in State_KR.md
*  WIP stat_KR.md translation
*  add build_KR.md && stratum_KR.md
*  finish translate stratum_KR.md & table_of_content_KR.md
*  rename intro.KR.md to intro_KR.md
*  add intro_KR.md file path each language's  intro.md
*  add Korean translation file path to stratum.md & table_of_contents.md
*  fix difference with grin/master
2019-02-28 10:11:04 -08:00
Johannes Zweng
204288295d [docs] Add switch commitment documentation (#2526)
* remove references to no-longer existing switch commitment hash

(as switch commitments were removed in ca8447f3bd
and moved into the blinding factor of the Pedersen Commitment)

* some rewording (points vs curves) and fix of small formatting issues

* Add switch commitment documentation
2019-02-27 14:20:20 -08:00
Yeastplume
ea4b4fc389
Remove wallet code [1.1.0] (#2593)
* Bump version to 1.1.0

* remove wallet crate

* wallet extracted + mine_block structs

* remove wallet doc

* remove unnecessary cargo deps

* rustfmt

* remove wallet from travis matrix

* move integration tests into separate crate

* rustfmt

* move integration crate to wallet
2019-02-21 11:57:45 +00:00