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

Update Porter README and diagrams #40

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

derekpierre
Copy link
Member

@derekpierre derekpierre commented Oct 10, 2023

Type of PR:

  • Bugfix
  • Feature
  • Documentation
  • Other

Required reviews:

  • 1
  • 2
  • 3

What this does:

  • Update Porter's README to include /cbd_decrypt endpoint.
  • Update digrams for TACo

Questions for reviewers:

  1. Should we rename /cbd_decrypt endpoint (Change /cbd_decrypt endpoint name to something TACo related #42 )
  2. I moved /retrieve_cfrags to a PRE specific section in the README (this was PRE reencrypt). /get_ursulas remains at a high-level. Any concerns/thoughts about that?
  3. Should we bump Porter's version? It is already 1.0.0 on mainnet. If semver, then we aren't introducing breaking API changes so technically it would be a 1.1.0, although using 2.0.0 would be refreshing for the nucypher 7.0.0 release (Bump Porter version #41 ).

Issues fixed/closed:

  • Fixes #...

Why it's needed:

Explain how this PR fits in the greater context of the NuCypher Network.
E.g., if this PR addresses a nucypher/productdev issue, let reviewers know!

Notes for reviewers:

What should reviewers focus on?
Is there a particular commit/function/section of your PR that requires more attention from reviewers?

@codecov-commenter
Copy link

Codecov Report

Merging #40 (c7d626c) into development (ed902ac) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff              @@
##           development      #40   +/-   ##
============================================
  Coverage        87.72%   87.72%           
============================================
  Files               18       18           
  Lines              709      709           
============================================
  Hits               622      622           
  Misses              87       87           
Files Coverage Δ
porter/main.py 87.21% <ø> (ø)

README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
derekpierre added a commit to derekpierre/nucypher-porter that referenced this pull request Oct 12, 2023
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
porter/main.py Outdated Show resolved Hide resolved
Copy link
Member

@manumonti manumonti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🤘

@derekpierre derekpierre merged commit f387124 into nucypher:development Oct 16, 2023
3 checks passed
derekpierre added a commit that referenced this pull request Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Completed
Development

Successfully merging this pull request may close these issues.

5 participants