ABI Support for JS library #454
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
algochoi
commented
Oct 12, 2021
ahangsu
reviewed
Oct 19, 2021
ahangsu
reviewed
Oct 19, 2021
ahangsu
reviewed
Oct 19, 2021
ahangsu
reviewed
Oct 19, 2021
ahangsu
reviewed
Oct 19, 2021
ahangsu
reviewed
Oct 19, 2021
ahangsu
reviewed
Oct 19, 2021
jasonpaulos
reviewed
Oct 21, 2021
Contributor
jasonpaulos
left a comment
jasonpaulos
left a comment
There was a problem hiding this comment.
I'm not sure why the build is failing. If you rebase/merge with develop, that might help
ahangsu
reviewed
Oct 26, 2021
ahangsu
reviewed
Oct 26, 2021
jasonpaulos
reviewed
Nov 3, 2021
jasonpaulos
suggested changes
Nov 4, 2021
Contributor
There was a problem hiding this comment.
I have the following file organization suggestions, what do you think?
- Move the functions
bigIntToBytesandbytesToBigIntto a new filesrc/encoding/bigint.ts, since they are useful in general Right now all ABI code is in a folder by itself. Since we can't split up the file easily without introducing circular imports, I think moving the file toEDIT: actually having thesrc/encoding/abi.tswould make more sense.abifolder makes sense, since ABI JSON description handling code can live there too.
Also, some exporting suggestions:
- I just realized if we export the code as is, users would do
import { Type } from 'algosdk', which is not great becauseTypeis pretty general. Probably renaming toABITypemakes more sense. src/main.tsneeds to be updated to actually export the new class. If you adopt the above changes,export { ABIType } from './encoding/abi';should do it
(somehow half my review got submitted early, that was not intentional)
Contributor
|
Weirdly it looks like the latest commit is failing on travis because of new cucumber tests from algorand/algorand-sdk-testing#145, but that shouldn't be happening because they're hidden behind the edit: will be fixed by algorand/algorand-sdk-testing#147 |
jasonpaulos
approved these changes
Nov 4, 2021
Contributor
jasonpaulos
left a comment
jasonpaulos
left a comment
There was a problem hiding this comment.
Looks good, except there are still some bigint literals 😄
After fixing, this looks good to merge to me!
aldur
pushed a commit
that referenced
this pull request
Jan 20, 2022
* added abi files * Temporarily disable linter for require() warning * Update tests for ABI types * Minor import change * Remove separate encode file * Add basic encoding tests * Enforce Bigint args in uint/ufixed types * Fix linter errors * Fix more linting errors * Address PR comments * Add decoding functions and tests * Fix chrome test errors by disabling crypto * Address PR comments and try to see if we can resolve Travis errors * Resolve circular dependencies in tests * Change exports, naming and file structure * Change bigint literals to BigInt() * Remove more bigint literals Co-authored-by: shiqi.zheng@algorand.com <shiqi.zheng@algorand.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds ABI type encoding support for the JS SDK library.
Closes #425