-
Notifications
You must be signed in to change notification settings - Fork 138
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
Add support to convert strings to large integer and address ScVal
s
#690
Conversation
Size Change: +7.17 kB (0%) Total Size: 3.13 MB
|
* @param {string} scvType the `xdr.ScValType` as a string | ||
* @returns {string} a suitable equivalent type to construct this object | ||
*/ | ||
static getType(scvType) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this is unchanged, but would it make sense to call isType(scvType)
here and jsdoc that it throws if scvType
invalid?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought this was a good idea so I gave it a shot, but then I realized two things:
- this shouldn't ever be called by clients, honestly, so I made it private in 7de0557 (it was only exported for tests)
- the non-int cases are already covered by
scValToBigInt
, here: https://github.com/stellar/js-stellar-base/blob/scval-better-ints/src/numbers/index.js#L57
So this check would just add unnecessary internal overhead. If we ever need to make this public, we should definitely do the check!
it('lets strings be large integer ScVals', function () { | ||
['i64', 'i128', 'i256', 'u64', 'u128', 'u256'].forEach((type) => { | ||
const scv = nativeToScVal('12345', { type }); | ||
expect(XdrLargeInt.getType(scv.switch().name)).to.equal(type); |
There was a problem hiding this comment.
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 line or separate test case, to demonstrate expectation when invalid
XdrLargeInt.getType('ab');
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good call! but this is implicitly already handled by an existing test case, here:
js-stellar-base/test/unit/scint_test.js
Lines 247 to 251 in 25a2b68
it('throws for non-integers', function () { | |
expect(() => | |
StellarBase.scValToBigInt(new xdr.ScVal.scvString('hello')) | |
).to.throw(/integer/i); | |
}); |
* Correctly set `minAccountSequence` in `TransactionBuilder` for large values (#539) * Add support of CAP40 ed25519SignedPayload signer for SetOptionOp (#542) * Add TypeScript interfaces for Ed25519SignedPayload signers * Coalesce all xLM, Xlm, etc. => 'XLM' native asset code (#546) * make sure sodium is not an empty object in service workers (#567) * Add futurenet passphrase for soroban. (#550) * Include standalone network passphrase (#555) * Soroban auth next updates (#570) * Add strkey parsing for contracts, and Address helper for building ScAddresses (#572) * Update xdr to include HashIdPreimageContractAuth.nonce (#577) * Add Address.toBuffer method (#578) * Soroban value overhaul (#582) * Update generated XDR to latest version. (#587) * Update XDR and contract invocations to conform to the latest version (Preview 9). (#601) * added soroban transaction data as tx builder param (#604) * Add Contract support for strkey-style contract IDs (#612) * Add Contract.address() method (#614) * Add wrappers to easily deal with the myriad of `ScVal` integer types. (#620) * Upgrade `js-xdr` to v3.0.0 to support `bigint` encoding. * Add wrappers to easily convert between `ScVal` and native types. (#630) * Update XDR to support Preview 10 (#633) * Fix TypeScript definition for `invokeHostFunction` options (#635) * Add fully-qualified `Operation` type to XDR type definitions. (#591) * Adds Operation.isValidAmount jsdoc (#609) * Removes the dependency on `crc` by calculating checksum in strkey (#621) * Improve type flexibility when building `ScVal`s from native types (#638) * Fix Preview 10 contract invoke & release `v10.0.0-soroban.3` (#642) * Add GitHub Action that compares before-and-after bundle sizes. (#644) * Make opinionated judgements about string/symbol decoding (#645) * Make Node 16 the minimum version. (#651) * Add standalone/futurenet passphrases to jsdoc (#654) * Clean up unnecessary dependency entries (#652) * Add `SorobanDataBuilder` builder pattern to prepare transactions easier (#660) * Adds a way to create a `TransactionBuilder` from an existing transaction. (#656) * Add basic contract event parsing into a human-readable structure (#659) * Drop support for deprecated hex contract IDs (#658) * Add helpers method to build authorization entries. (#663) * Fix TypeScript definition for new static `TransactionBuilder` constructor (#665) * Add ability to clear out operations from the transaction builder (#670) * Add an existing method to XdrLargeInt, jsdoc/types fixup (#668) * Expand contract footprint with contract code ledger key. (#662) * Decode base64-encoded strings in new SorobanDataBuilder (#673) * Add ability to modify and retrieve the resource footprint (#680) * Fixes error messages for required amount parameters (#679) * Add `Asset.contractId()` helper to predict contract IDs (#684) * Upgrade dependencies to their latest minor/patch version (#685) * Improves `SorobanDataBuilder` construction and adds a getter (#686) * Add JSON-ification of Soroban invocation trees. (#669) * Add utilities for formatting token amounts (`formatTokenAmount` & `parseTokenAmount`) (#667) * Merges the final Protocol 20 XDR (i.e. for testnet) into `soroban` (#688) * Add support to convert strings to large integer and address `ScVal`s (#690) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Paul Bellamy <paul@stellar.org> Co-authored-by: George <Shaptic@users.noreply.github.com> Co-authored-by: Jun Luo <4catcode@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: OrbitLens <33724849+orbitlens@users.noreply.github.com> Co-authored-by: Piyal Basu <pbasu235@gmail.com> Co-authored-by: George Kudrayvtsev <george@stellar.org> Co-authored-by: shawn <sreuland@users.noreply.github.com> Co-authored-by: Silence <35656692+silence48@users.noreply.github.com> Co-authored-by: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Co-authored-by: jeesun 지선 <jeesunikim@users.noreply.github.com>
In summary, this adds the following conversions:
ScVal
with anScAddress
ScVal
with large integers such asInt128Parts
(accomplished viaXdrLargeInt
)For details, you can refer to the changes in test/unit/scval_test.js for new usage examples.
Closes #683.
An unrelated change is to tests.yml which actually does
prettier
formatting before checking the diff 🤦. This is the cause of a handful of formatting changes (yarn fmt
wasn't run in a previous PR).