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

docs: update documentation and remove old benchmarks #37

Merged
merged 1 commit into from
Jul 5, 2023

Conversation

AaronFeickert
Copy link
Contributor

@AaronFeickert AaronFeickert commented Jun 20, 2023

The benchmarks used in the documentation are out of date. This PR updates the documentation to remove them and provide a better overview of the features of the implementation.

Closes #36.

Copy link
Contributor

@CjS77 CjS77 left a comment

Choose a reason for hiding this comment

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

If someone ever wants to regenerate the benchmarks, we can add them in again.

@CjS77 CjS77 merged commit 699f0ea into tari-project:main Jul 5, 2023
@AaronFeickert AaronFeickert deleted the update-readme branch July 5, 2023 16:25
CjS77 pushed a commit to tari-project/rfcs that referenced this pull request Jul 28, 2023
Description
---
Adds details of a Bulletproofs+ optimization to RFC-0181. Removes old
benchmark data.

Motivation and Context
---
The [Bulletproofs+
implementation](https://github.com/tari-project/bulletproofs-plus)
contains a particular optimization used when
[computing](https://github.com/tari-project/bulletproofs-plus/blob/d495fb24f9c7c34e0bfb0a38598b67e216fc56bf/src/range_proof.rs#L616-L625)
a vector sum. This optimization is not particularly obvious, as it uses
some fun arithmetic and a fact about [geometric series partial
sums](https://mathworld.wolfram.com/GeometricSeries.html).

This PR adds details about the math behind the optimization to
[RFC-0181](https://rfc.tari.com/RFC-0181_BulletproofsPlus.html). It also
removes outdated benchmark data, similarly to earlier
[removal](tari-project/bulletproofs-plus#37) in
the Bulletproofs+ repository.

How Has This Been Tested?
---
The changes build and render properly. The underlying mathematics should
be manually checked for correctness.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Benchmark data is out of date
3 participants