Add an xdr.scvMapSorted constructor to automagically sort map ScVals.
#787
Conversation
|
Size Change: +1.84 kB (+0.06%) Total Size: 3.27 MB
|
| // Both a and b are `ScMapEntry`s, so we need to sort by underlying key. | ||
| // | ||
| // We couldn't possibly handle every combination of keys since Soroban | ||
| // maps don't enforce consistent types, so we do a best-effort and try | ||
| // sorting by "number-like" or "string-like." | ||
| const nativeA = scValToNative(a.key()); | ||
| const nativeB = scValToNative(b.key()); | ||
|
|
||
| switch (typeof nativeA) { | ||
| case 'number': | ||
| case 'bigint': | ||
| return nativeA < nativeB ? -1 : 1; | ||
|
|
||
| default: | ||
| return nativeA.toString().localeCompare(nativeB.toString()); |
There was a problem hiding this comment.
It is intriguing how... imperfect this is. Why does this use a different approach to nativeToScVal? nativeToScVal sorting logic appears to look like this:
return xdr.ScVal.scvMap(
Object.entries(val)
// The Soroban runtime expects maps to have their keys in sorted
// order, so let's do that here as part of the conversion to prevent
// confusing error messages on execution.
.sort(([key1], [key2]) => key1.localeCompare(key2))
.map(([k, v]) => {
// the type can be specified with an entry for the key and the value,
// e.g. val = { 'hello': 1 } and opts.type = { hello: [ 'symbol',
// 'u128' ]} or you can use `null` for the default interpretation
const [keyType, valType] = (opts?.type ?? {})[k] ?? [null, null];
const keyOpts = keyType ? { type: keyType } : {};
const valOpts = valType ? { type: valType } : {};
return new xdr.ScMapEntry({
key: nativeToScVal(k, keyOpts),
val: nativeToScVal(v, valOpts)
});
})
);There was a problem hiding this comment.
I think this actually reveals an issue with the way nativeToScVal sorts, instead. It made the assumption that map keys are strings (because in JS all {}s use strings for keys), but if those are being encoded differently (via type), then this might 💥.
Of course this convenience method isn't supposed to be a catch-all for all possible ScVals, but it could be improved there for the easy cases (number-like). Both will work reliably for the common case, which is structs, and that's the primary goal here.
Injects an
scvMapSortedconstructor into thexdrmodule so that people can created maps with sorted entries from rawScMapEntryinstances.Closes stellar/js-stellar-sdk#1131.