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

[Tracking] Upgrade structs, remove duplication, refactor codebase, improve ergonomics #185

Merged
merged 69 commits into from May 31, 2021

Conversation

howardwu
Copy link
Collaborator

@howardwu howardwu commented May 29, 2021

Motivation

Upgrade struct conventions, remove duplication, improve ergonomics.

Merged changes:

General changes:

  • Renames dpc/src/base_dpc to dpc/src/testnet1
  • Removes duplicate Assignment trait in dpc/src/lib.rs
  • Renames to snarkos-integration to .snarkos-integration and include in workspace for testing
  • Adds CI for each crate in the workspace

Trait changes:

  • Renames trait Program to ProgramScheme
  • Renames trait Record to RecordScheme
  • Renames trait Transaction to TransactionScheme
  • Renames trait RecordSerializerScheme to RecordEncodingScheme
  • Update trait SNARK internal types from AssignedCircuit to AllocatedCircuit, PreparedVerifcationParameters to PreparedVerifyingKey, Parameters to ProvingKey, and VerificationParameters to VerifyingKey

Struct changes:

  • Renames struct DPCRecord to Record
  • Renames struct DPCTransaction to Transaction
  • Renames struct DPCTransactions to Transactions
  • Renames struct RecordSerializer to RecordEncoding, and renames internal methods serialize to encode and deserialize to decode
  • Renames struct DeserializedRecord to DecodedRecord
  • Renames struct Parameters to ProvingKey for snarkos-algorithms/snark
  • Renames struct RecordPayload to Payload
  • Moves AleoAmount from snarkvm-objects to snarkvm-dpc
  • Removes unused AmountError

Parameter changes:

  • Modularizes parameters into global/ and testnet1/ directories
  • Update all references of InnerSNARKID to InnerCircuitID, InnerSNARKVerificationKeyCRH to InnerCircuitIDCRH, inner_snark_verification_key_crh to inner_circuit_id_crh, and inner_snark_vk_crh to inner_circuit_id_crh

@codecov
Copy link

codecov bot commented May 29, 2021

Codecov Report

Merging #185 (c884868) into master (de6b3d7) will increase coverage by 0.20%.
The diff coverage is 85.71%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #185      +/-   ##
==========================================
+ Coverage   92.70%   92.91%   +0.20%     
==========================================
  Files          72       63       -9     
  Lines        2770     2696      -74     
==========================================
- Hits         2568     2505      -63     
+ Misses        202      191      -11     
Impacted Files Coverage Δ
parameters/src/errors/parameter.rs 0.00% <ø> (ø)
parameters/src/lib.rs 100.00% <ø> (ø)
parameters/src/macros.rs 75.00% <0.00%> (ø)
.integration/src/lib.rs 100.00% <100.00%> (ø)
parameters/src/testnet1/genesis/block.rs 85.71% <100.00%> (ø)
utilities/src/bytes.rs 89.65% <0.00%> (-0.97%) ⬇️
fields/src/fp2.rs 94.31% <0.00%> (+0.06%) ⬆️
curves/src/bls12_377/fq6.rs 100.00% <0.00%> (+10.00%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update de6b3d7...c884868. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
staging Staging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants