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.

Sign up for GitHub

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

Jump to bottom

feat: vat-safe denomHash using noble sha256 #9576

Merged
merged 2 commits into from
Jul 12, 2024
Merged

feat: vat-safe denomHash using noble sha256 #9576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dedde44
feat: vat-safe denomHash using noble sha256
dckc Jun 12, 2024
58ff687
build: source prerelease @noble/hashes
turadg Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/orchestration/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,16 @@
"@endo/errors": "^1.2.2",
"@endo/far": "^1.1.2",
"@endo/marshal": "^1.5.0",
"@endo/patterns": "^1.4.0"
"@endo/patterns": "^1.4.0",
"@noble/hashes": "github:paulmillr/noble-hashes#ae060da"
},
"devDependencies": {
"@agoric/swingset-liveslots": "^0.10.2",
"@chain-registry/client": "^1.47.4",
"@cosmjs/amino": "^0.32.3",
"@cosmjs/proto-signing": "^0.32.3",
"@endo/bundle-source": "^3.2.3",
"@endo/import-bundle": "^1.1.2",
"@endo/ses-ava": "^1.2.2",
"ava": "^5.3.1",
"c8": "^9.1.0",
Expand Down
22 changes: 22 additions & 0 deletions packages/orchestration/src/utils/denomHash.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// @ts-check
import { sha256 } from '@noble/hashes/sha256';
Copy link
Member

Choose a reason for hiding this comment

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

Watch out for bundler support for "exports" since this pattern will only work when the tools account for package exports.

Copy link
Member Author

Choose a reason for hiding this comment

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

is there an alternative?

Copy link
Member

@kriskowal kriskowal Jun 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Not with this package. It’s pretty narrowly prescribed:

https://github.com/paulmillr/noble-hashes/blob/main/package.json#L141-L145

That is, this package cannot be used with bundlers that have not caught up with package exports. There are very few such tools, but node -r esm (loadgen) is among them. Hopefully, there is no risk that this package will get caught up in that, but if you see integration errors to the tune of “I can’t import this”, this is why.

Copy link
Member Author

Choose a reason for hiding this comment

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

felgercarb!

loadgen ci failed. :-/

now what do I do? sigh.

Copy link
Member

Choose a reason for hiding this comment

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

We could fork or PR upstream to package export package relative paths to files with .js extensions. I’m not against forking this into Endo. We do that for Base64. We could harden the library. We would have recourse to fall through to native on XS if that becomes available.

Copy link
Member Author

Choose a reason for hiding this comment

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

I’m not against forking this into Endo. We do that for Base64.

I like that idea enough to reify it as an issue:

I'll pursue other options in parallel, so it's not necessarily critical path.

Copy link
Member

Choose a reason for hiding this comment

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

loadgen fixed with 58ff687

Downstream imports won't get the patch but they don't need it.

import { bytesToHex } from '@noble/hashes/utils';

/**
* cf. https://tutorials.cosmos.network/tutorials/6-ibc-dev/
*
* @param {object} opts
* @param {string} [opts.portId]
* @param {string} [opts.channelId] required unless `path` is supplied
* @param {string} [opts.path] alternative to portId, channelId
* @param {string} opts.denom base denom
*/
export const denomHash = ({
portId = 'transfer',
channelId = /** @type {string | undefined} */ (undefined),
path = `${portId}/${channelId}`,
denom,
}) => {
const h = sha256.create().update(`${path}/${denom}`).digest();
Copy link
Member

Choose a reason for hiding this comment

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

Could avoid an allocation with digestInto, using the same Uint8Array view for both this and toHex.

return bytesToHex(h).toUpperCase();
};
18 changes: 18 additions & 0 deletions packages/orchestration/test/utils/denomHash.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import test from '@endo/ses-ava/prepare-endo.js';

import bundleSource from '@endo/bundle-source';
import { importBundle } from '@endo/import-bundle';
import { createRequire } from 'node:module';
import { denomHash } from '../../src/utils/denomHash.js';

const nodeRequire = createRequire(import.meta.url);

test('compartment use of denomHash', async t => {
const bundle = await bundleSource(nodeRequire.resolve('./denomHashEx.js'));
const { length } = JSON.stringify(bundle);
t.log('bundle length', length);
const expected = denomHash({ channelId: 'channel-0', denom: 'uatom' });

const { denomHashExample } = await importBundle(bundle);
t.deepEqual(denomHashExample(), expected);
});
6 changes: 6 additions & 0 deletions packages/orchestration/test/utils/denomHashEx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { denomHash } from '../../src/utils/denomHash.js';

export const denomHashExample = () => {
const h = denomHash({ channelId: 'channel-0', denom: 'uatom' });
return h;
};
9,910 changes: 9,910 additions & 0 deletions patches/@agoric+orchestration++@noble+hashes+1.4.0.patch
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2780,6 +2780,10 @@
resolved "https://registry.yarnpkg.com/@noble/hashes/-/hashes-1.1.2.tgz#e9e035b9b166ca0af657a7848eb2718f0f22f183"
integrity sha512-KYRCASVTv6aeUi1tsF8/vpyR7zpfs3FUzy2Jqm+MU+LmUKhQ0y2FpfwqkCcxSg2ua4GALJd8k2R76WxwZGbQpA==

"@noble/hashes@github:paulmillr/noble-hashes#ae060da":
version "1.4.0"
resolved "https://codeload.github.com/paulmillr/noble-hashes/tar.gz/ae060daa6252f3ff2aa2f84e887de0aab491281d"

"@nodelib/fs.scandir@2.1.5":
version "2.1.5"
resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5"
Expand Down
Loading