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

Feat/client docs #97

Merged
merged 6 commits into from
Dec 22, 2020
Merged

Feat/client docs #97

merged 6 commits into from
Dec 22, 2020

Conversation

tensor-programming
Copy link
Contributor

Description of change

Please write a summary of your changes and why you made them.

Links to any relevant issues

Be sure to reference any related issues by adding fixes issue #.

Type of change

Choose a type of change, and delete any options that are not relevant.

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Describe the tests that you ran to verify your changes.

Make sure to provide instructions for the maintainer as well as any relevant configurations.

Change checklist

Add an x to the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@nothingismagick nothingismagick merged commit fdff9f2 into dev Dec 22, 2020
@nothingismagick nothingismagick deleted the feat/client-docs branch December 22, 2020 19:47
@tensor-programming tensor-programming restored the feat/client-docs branch December 22, 2020 20:41
@tensor-programming tensor-programming deleted the feat/client-docs branch December 22, 2020 20:42
nothingismagick added a commit that referenced this pull request Dec 24, 2020
* use btree and serialize client.

* clean up cosmetics.

* move and expose location.

* fix bench and add read.

* add init and create benches.

* fix cli.

* fix(tests): don't run them all all the time (#76)

* fix(tests): don't run them all all the time

* fix(workflow): test, not build and test

* Unify API and harden client.  (#78)

* use btree and serialize client.

* clean up cosmetics.

* move and expose location.

* fix bench and add read.

* add init and create benches.

* fix cli.

* fix(covector) (#79)

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* fix covector (#81)

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* fix(covector) (#82)

* fix(covector) (#83)

* fix(covector): cargo.toml styles (#85)

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* fix counter logic.

* add reference changes.

* add multi-actor example.

* test reading snapshot into a new actor.

* allow new actor to read old snapshot.

* cleanup.

* fix errors.

* fix return error.

* remove lifetimes.

* fix benchmark.

* fix switch.

* remove runtime.

* fix location api.

* clippity clip clip.

* chore(communication): bump libp2p version (#88)

* chore(communication): bump libp2p version

* chore(communication): bump libp2p version

* add write_all_snapshot and rework read_snapshot.

* cleanup.

* clippy clippy clippy clippy clippy clippy clippy clippy clippy clippy

* fix(clippy): complexity & clone

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* fix(commandline): update to new signature

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* fix cli

* add counter test.

* add new test.

* fix snapshot logic.

* add todo.

* The droid was excited by the meal I cooked him, until he took a byte.

* clippy clip clipped

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* fix fmt

Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>

* add forth actor and fix test.

* feat(target): arm-unknown-linux-gnueabihf target for usbarmory (#90)

* feat(target): arm-unknown-linux-gnueabihf target for usbarmory

* add changelog

* feat(client): introduce SignUnlockBlock proc (#92)

* feat(client): introduce SignUnlockBlock proc
* changelog
* fix(fmt)
* feat(client): do a proper slip10 proc
* add test and fix length error.

Co-authored-by: tensor-programming <tensordeveloper@gmail.com>

* fix snapshot.

* move tests to external folder.

* move cli to examples folder.

* Every year they read, "All about Robots," by Cy Borg

* remove cli release workflow.

* restore cli.

* remove examples/commandline.

* add license

* add basic tests and benchmarks.

* add basic test docs.

* add snapshot hack.

* feat(communication): refactor comms actor

* fix(communication): add changelog

* Refactor zone API and add documentation (#95)

* Unify zone interface around a common abstract ZoneSpec type

* Add some basic tests for the common zone API

* Add the license_template to the runtime crate

* Rewrite the runtime's README.md

* typo

* typo

* Bump crypto.rs version (#96)

iotaledger/crypto.rs@9259a06

* Snapshot docs (#84)

* Remove unused code and make room for the new format documentation

* Add some words about the snapshot format

* Document the snapshot::files::* functions

* Clearer separation of concerns regarding the snapshot paths

* Add some words for the snapshot's read/write read_from/write_to functions

* Expose the MAGIC and VERSION bytes (as they may be used for file type detection)

* Apply suggestions from code review

* Re-export the kdf:s from snapshot in the client crate

* Feat/client docs (#97)

* add constant locations.

* add engine bench.

* slip10 derive return key.

* add external documentation.

* add liscence.

* Sy Borg, gimme dat give me the chromium leg

* feat(communication): Update examples and docs

* feat(communication): Adjust actor-example and docs

* fix(communication): typos

* Attempted fix of the SignBlockUnlock message (#103)

* Correct naming in the SignUnlockBlock message

* Use all available seed material when performing the SignUnlockBlock procedure

* fmt :|

* Fix Slip10Derive internal methods: hand back the keys

* Refactor Crypto and UnlockBlock (#104)

* add basic unlock block test.

* fix slip10 derive.

* cleanup zone warnings

* fix basic test.

* fix crypto logic.

* add bee test.

* reinsert keys.

* add bee logic.

* add bee-p logic and path.

* remove slip10 from test case.

* Sy Borg, gimme dat, gimme dat

* It looks just like a TeleFunken you-47

* chore(release) (#105)

* chore(release)
* fix(cli): release on push to main
* fix typo
* fix(runtime): allow dead code
* release title "Saint Malo"

* fix(changelog): Alpha Release (#106)

LGTM

* apply version updates (#86)

Co-authored-by: Daniel Thompson-Yvetot

* fix(cargo) (#107)

Signed-off-by: Daniel Thompson-Yvetot

Co-authored-by: tensor-programming <tensordeveloper@gmail.com>
Co-authored-by: elenaf9 <57632201+elenaf9@users.noreply.github.com>
Co-authored-by: elenaf9 <elena.frank@protonmail.com>
Co-authored-by: Gustav Behm <rootmos@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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