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.

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

Feature wasm upgrade #73

Merged
merged 3 commits into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/lazy-cooks-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@zcloak/wasm": minor
"@zcloak/wasm-bridge": minor
"@zcloak/wasm-asm": minor
"@zcloak/crypto": minor
---

update rust deps, and add rescuePrimeOptimizedHash function
5 changes: 5 additions & 0 deletions .changeset/silly-geese-tan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@zcloak/miden": major
---

import miden vm wasm, see more: https://github.com/zCloak-Network/miden
4 changes: 2 additions & 2 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ module.exports = {
ignorePatterns: [
...base.ignorePatterns,
'scripts/**/*',
'packages/wasm-asm/src/index.js',
'packages/wasm/src/index.js'
'utility/wasm-asm/src/index.js',
'utility/wasm/src/index.js'
],
parserOptions: {
...base.parserOptions,
Expand Down
1 change: 1 addition & 0 deletions jest.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module.exports = Object.assign({}, config, {
'@zcloak/cross(.*)$': '<rootDir>/utility/cross/src/node',
'@zcloak/crypto(.*)$': '<rootDir>/utility/crypto/src/$1',
'@zcloak/keyring(.*)$': '<rootDir>/utility/keyring/src/$1',
'@zcloak/miden(.*)$': '<rootDir>/utility/miden/src/$1',
'@zcloak/wasm-asm(.*)$': '<rootDir>/utility/wasm-asm/src/$1',
'@zcloak/wasm-bridge(.*)$': '<rootDir>/utility/wasm-bridge/src/$1',
'@zcloak/wasm(.*)$': '<rootDir>/utility/wasm/src/$1',
Expand Down
33 changes: 33 additions & 0 deletions scripts/build-wasm.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,39 @@ ${fs.readFileSync('build-asm/asm.js', 'utf-8').toString()}
`
);

process.chdir('../miden');

// miden wasm
console.log('### Build Rust miden wasm sources');
execSync('cargo build --target wasm32-unknown-unknown --release', { stdio: 'inherit' });

console.log('### Converting to WASM');
execSync(
'../../bindgen/wasm-bindgen target/wasm32-unknown-unknown/release/wasm_miden.wasm --out-dir build-wasm --target web',
{ stdio: 'inherit' }
);

// optimise
console.log('Optimising WASM output');
execSync('../../binaryen/bin/wasm-opt build-wasm/wasm_miden_bg.wasm -Oz -o build-wasm/wasm_opt.wasm', {
stdio: 'inherit'
});

const midenWasm = fs.readFileSync('build-wasm/wasm_opt.wasm');

const midenBytes = Uint8Array.from(midenWasm);

const midenHex = u8aToHex(midenBytes);

console.log('Write wasm bytes');
fs.writeFileSync(
'src/bytes.js',
`${COPYRIGHT}
export const bytes =
'${midenHex}';
`
);

process.chdir('../..');

execSync('yarn zcloak-dev-run-lint', { stdio: 'inherit' });
4 changes: 2 additions & 2 deletions scripts/install-build-deps.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import { execSync } from 'child_process';
import fs from 'fs-extra';

const BINDGEN_REPO = 'https://github.com/rustwasm/wasm-bindgen';
const BINDGEN_VER = '0.2.83';
const BINDGEN_VER = '0.2.84';

const BINARYEN_REPO = 'https://github.com/WebAssembly/binaryen';
const BINARYEN_VER = 'version_111';
const BINARYEN_VER = 'version_112';

let bindgen_zip;
let binaryen_zip;
Expand Down
2 changes: 2 additions & 0 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
"@zcloak/crypto/*": ["utility/crypto/src/*"],
"@zcloak/keyring": ["utility/keyring/src"],
"@zcloak/keyring/*": ["utility/keyring/src/*"],
"@zcloak/miden": ["utility/miden/src"],
"@zcloak/miden/*": ["utility/miden/src/*"],
"@zcloak/wasm": ["utility/wasm/src"],
"@zcloak/wasm/*": ["utility/wasm/src/*"],
"@zcloak/wasm-asm": ["utility/wasm-asm/src"],
Expand Down
1 change: 1 addition & 0 deletions tsconfig.build.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
{ "path": "./utility/cross/tsconfig.build.json" },
{ "path": "./utility/crypto/tsconfig.build.json" },
{ "path": "./utility/keyring/tsconfig.build.json" },
{ "path": "./utility/miden/tsconfig.build.json" },
{ "path": "./utility/wasm/tsconfig.build.json" },
{ "path": "./utility/wasm-asm/tsconfig.build.json" },
{ "path": "./utility/wasm-bridge/tsconfig.build.json" },
Expand Down
2 changes: 2 additions & 0 deletions utility/crypto/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
"@polkadot/util": "^11.1.3",
"@scure/base": "^1.1.1",
"@zcloak/cross": "workspace:^",
"@zcloak/wasm": "workspace:^",
"@zcloak/wasm-asm": "workspace:^",
"@zcloak/wasm-bridge": "workspace:^",
"bip39": "^3.1.0",
"canonicalize": "^2.0.0",
Expand Down
3 changes: 1 addition & 2 deletions utility/crypto/src/initCrypto.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
import { utils as utilsNobleSecp256k1 } from '@noble/secp256k1';
import { u8aConcat } from '@polkadot/util';

import { initWasm } from '@zcloak/wasm-bridge';

import { hmacSha256AsU8a } from './hmac';
import { initWasm } from './wasm';

export function initCrypto(onlyAsm?: boolean) {
// Set overrides on the secp256k1 utils
Expand Down
2 changes: 1 addition & 1 deletion utility/crypto/src/rescue/asU8a.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type { HexString } from '../types';

import { assert, u8aToHex, u8aToU8a } from '@polkadot/util';

import { rescuePrimeHash } from '@zcloak/wasm-bridge';
import { rescuePrimeHash } from '../wasm';

/**
* @name rescuePrimeAsU8a
Expand Down
22 changes: 22 additions & 0 deletions utility/crypto/src/wasm/index.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Copyright 2021-2023 zcloak authors & contributors
// SPDX-License-Identifier: Apache-2.0

import { initWasm, rescuePrimeHash, rescuePrimeOptimizedHash } from '.';

describe('wasm', (): void => {
beforeAll(async () => {
await initWasm();
});

it('rescuePrimeHash', (): void => {
expect(rescuePrimeHash(new BigUint64Array([1n, 1n, 1n, 1n, 1n, 1n, 1n, 1n]))).toEqual(
new BigUint64Array([15629187566796044164n, 14492985933268926539n, 10247637497263796444n, 5502356898483464194n])
);
});

it('rescuePrimeOptimizedHash', (): void => {
expect(rescuePrimeOptimizedHash(new BigUint64Array([1n, 2n, 3n, 4n, 5n, 6n, 7n, 8n]))).toEqual(
new BigUint64Array([15975159621759139720n, 15720844923951376941n, 16013969809933496273n, 13608701685256682132n])
);
});
});
44 changes: 44 additions & 0 deletions utility/crypto/src/wasm/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright 2021-2023 zcloak authors & contributors
// SPDX-License-Identifier: Apache-2.0

import { bytes } from '@zcloak/wasm';
import * as asmBundle from '@zcloak/wasm-asm';
import { WasmBridge, withWasm } from '@zcloak/wasm-bridge';

declare module '@zcloak/wasm-bridge/types' {
interface WasmInstance {
ext_rescue_prime_hash(a: number, b: number, c: number): void;
ext_rescue_prime_optimized_hash(a: number, b: number, c: number): void;
}
}

const wasmBridge: WasmBridge = new WasmBridge();

export const rescuePrimeHash = withWasm(wasmBridge, ([wasm, retptr], values: BigUint64Array): BigUint64Array => {
wasm.ext_rescue_prime_hash(retptr, ...wasmBridge.allocU64a(values));

return wasmBridge.resultU64a(retptr);
});

export const rescuePrimeOptimizedHash = withWasm(
wasmBridge,
([wasm, retptr], values: BigUint64Array): BigUint64Array => {
wasm.ext_rescue_prime_optimized_hash(retptr, ...wasmBridge.allocU64a(values));

return wasmBridge.resultU64a(retptr);
}
);

export async function initWasm(onlyAsm?: boolean) {
if (onlyAsm) {
wasmBridge.initAsm(asmBundle);
} else {
try {
await wasmBridge.initWasm(bytes);
} catch (error) {
console.error('Can not to init wasm, try to use asm');

wasmBridge.initAsm(asmBundle);
}
}
}
1 change: 1 addition & 0 deletions utility/miden/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @zcloak/miden
Loading