Skip to content
This repository was archived by the owner on Aug 23, 2020. It is now read-only.

Document Bundle Validator #1125

Merged
merged 14 commits into from
Nov 13, 2018
Merged

Conversation

GalRogozinski
Copy link
Contributor

@GalRogozinski GalRogozinski commented Nov 7, 2018

Description

Adding documentation to bundle validator
Fixes #1107

Type of change

  • Documentation Fix

@GalRogozinski GalRogozinski requested a review from alon-e November 8, 2018 15:55
@alon-e
Copy link
Contributor

alon-e commented Nov 8, 2018

we should add some kind of descriptor for "consensus critical" code in the docs.

@GalRogozinski
Copy link
Contributor Author

GalRogozinski commented Nov 8, 2018

We will create a custom annotation (@ConsensusCritical) to put over classes and methods

@GalRogozinski GalRogozinski changed the title document bundle validator Document Bundle Validator Nov 11, 2018
alon-e and others added 3 commits November 11, 2018 15:29
Co-Authored-By: GalRogozinski <[email protected]>
Co-Authored-By: GalRogozinski <[email protected]>
@alon-e alon-e added C-Consensus E-Documentation Epic - Documentation of IRI labels Nov 11, 2018
@@ -87,12 +136,13 @@
digestTrits);
addressInstance.absorb(digestTrits,0, Curl.HASH_LENGTH);
offset = offsetNext;
} while (++j < instanceTransactionViewModels.size()
} //loop to traverse signature fragments divided between txs
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
} //loop to traverse signature fragments divided between txs
} //loop to traverse signature fragments divided between transactions


//verify bundle hash is correct
if (Arrays.equals(instanceTransactionViewModels.get(0).getBundleHash().trits(), bundleHashTrits)) {
//normalizing bundle in preparation for sig verification
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//normalizing bundle in preparation for sig verification
//normalizing bundle in preparation for signature verification

@@ -101,23 +151,33 @@
j++;
}
}

//should only be reached after for loop is done
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//should only be reached after for loop is done
//should only be reached after the above for loop is done

@@ -51,13 +95,15 @@
instanceTransactionViewModels.get(0).setValidity(tangle, -1);
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth adding a comment above that this is where we do the semantic checks?

@jakubcech jakubcech merged commit 704b025 into iotaledger:dev Nov 13, 2018
DyrellC pushed a commit to DyrellC/iri that referenced this pull request Nov 17, 2018
* document bundle validator

* bundle validator documentation fixes

* Fix grammar

Co-Authored-By: GalRogozinski <[email protected]>

* Fix sentence

Co-Authored-By: GalRogozinski <[email protected]>

* Fix Comments

* Bundle Validator docs fixes

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* Update src/main/java/com/iota/iri/BundleValidator.java

Co-Authored-By: GalRogozinski <[email protected]>

* update bundle validator docs
@GalRogozinski GalRogozinski mentioned this pull request Dec 22, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
C-Consensus E-Documentation Epic - Documentation of IRI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants