Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small QoL improvements for wallet developers #2651

Merged
merged 7 commits into from
Mar 19, 2019

Conversation

jaspervdm
Copy link
Contributor

@jaspervdm jaspervdm commented Mar 5, 2019

Some small changes to make the lives of wallet developers (including me) a bit easier. If preferred, I could create separate PRs for each but since they are pretty small changes I thought I'd bundle them up.

Changes:

  • Add pub to the keychain in the builder Context. This is useful since I have a bunch of custom build functions that need to use the keychain
  • Move create_nonce into the Keychain trait, this makes it easier to provide custom nonce derivation schemes. Edit: as yeastplume correctly points out below, this should not be used by wallet developers to change the nonce for regular transactions
  • Flag to turn off the fee check in slate signing/finalization. This is useful if the intermediate tx has a too low fee but the final tx has a high enough fee (due to added kernels). Simply adding the kernels to the slate tx won't work since there is an assertion that there is only a single kernel in the tx Will be re-done in a separate PR on grin-wallet
  • Add to_bytes function to WalletSeed, easier than having to call from_hex(seed.to_hex())

@yeastplume
Copy link
Member

I have some concerns about facilitating a wide array of nonce creation schemes as it will affect expected behavior of restoring from seed. But refactoring it into a trait for now I think is fine.

Slate format changes need to go into a new slate version in the grin-wallet repo (slate versioning isn't contained in master,). Can I suggest aiming this PR at 1.1.0 and splitting it between here and the wallet?

@jaspervdm
Copy link
Contributor Author

Thanks for reviewing!

I have some concerns about facilitating a wide array of nonce creation schemes as it will affect expected behavior of restoring from seed. But refactoring it into a trait for now I think is fine.

I agree, we should be careful with that. However for example in a multisignature wallet, restoring from a single seed is not expected to work in the same way. For this specific instance (and possibly a few others) it would be much easier to have the function inside the trait, rather than having to specify custom build functions.

Slate format changes need to go into a new slate version in the grin-wallet repo (slate versioning isn't contained in master,). Can I suggest aiming this PR at 1.1.0 and splitting it between here and the wallet?

This PR doesn't actually change the (de)serialisation format, it is merely an internal flag to skip the fee check on finalisation. This is very useful for me in a specific application, but it might not be the best way to implement it. I could try and refactor it a bit to separate out functionality, so in my specific situation I can only call the functions that I actually need (which is basically finalize without a fee check). Would this be preferred?

@yeastplume
Copy link
Member

Agreed first point. On second, I think your suggestion is preferable to having fields in the slate that aren't serialized, mostly for readability's sake. Definitely needs to be done in grin-wallet though (grin\wallet files will all be removed when 1.1.0 is merged)

@jaspervdm
Copy link
Contributor Author

I removed the changes I made in the Slate, will refactor it and re-open on grin-wallet

@yeastplume yeastplume merged commit f4d3b2e into mimblewimble:master Mar 19, 2019
@jaspervdm jaspervdm deleted the patch branch March 20, 2019 19:41
yeastplume added a commit that referenced this pull request Apr 1, 2019
* 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 ca8447f
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants