Page MenuHomePhabricator
Differential D15931

[ecash-lib] Add ecash-lib-wasm, a WebAssembly module for ecash-lib
ClosedPublic
Actions

Authored by tobias_ruck on Wed, Apr 10, 03:27.

Details

Reviewers
bytesofman
Group Reviewers
Restricted Project
Commits
rABC0642148926bc: [ecash-lib] Add ecash-lib-wasm, a WebAssembly module for ecash-lib
Summary

Builds a WebAssemby module using Rust for secp256k1 and hashing functions.

This currently uses https://github.com/raipay/secp256k1-abc to get libsecp256k1 to compile to WebAssembly using Rust, but in the future we could use the secp256k1 library within the monorepo to get rid of that external dependency.

ecash-lib in the repo now won't typecheck until the WebAssembly is built, but it seems better to not commit compiled binaries than users having to have to build the .wasm file.

In the future, we might want to check the hash of the built wasm file so we get a deterministic build, maybe even provide a signature like we do for the release of bitcoind.

The wasm can be built using either dockerbuild.sh or build-wasm.sh, the former just requires docker, the latter requires some wasm toolchains to be installed.

Test Plan
  1. cd ecash-lib-wasm && ./dockerbuild.sh
  2. cd ../ecash-lib && npm run test

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

tobias_ruck created this revision.Wed, Apr 10, 03:27
Herald added a reviewer: Restricted Project. · View Herald TranscriptWed, Apr 10, 03:27
Harbormaster completed remote builds in B28424: Diff 46970.Wed, Apr 10, 03:27
tobias_ruck edited the test plan for this revision. (Show Details)Wed, Apr 10, 03:30
bytesofman added inline comments.Wed, Apr 10, 04:18
modules/ecash-lib-wasm/.gitignore
2 ↗(On Diff #46970)

add newline at end of file

tobias_ruck updated this revision to Diff 46993.Wed, Apr 10, 15:27

add tests, rebase, simplify docker

Harbormaster completed remote builds in B28444: Diff 46993.Wed, Apr 10, 15:27
tobias_ruck updated this revision to Diff 46994.Wed, Apr 10, 15:31

remove .dockerignore, actually just makes things slower

Harbormaster completed remote builds in B28445: Diff 46994.Wed, Apr 10, 15:31
tobias_ruck updated this revision to Diff 46995.Wed, Apr 10, 15:34

add copyright to hash.ts

Harbormaster completed remote builds in B28446: Diff 46995.Wed, Apr 10, 15:34
tobias_ruck published this revision for review.Wed, Apr 10, 15:34
tobias_ruck retitled this revision from [ecash-lib] Add ecash-lib-wasm, a WASM compiled secp256k1 for ecash-lib to [ecash-lib] Add ecash-lib-wasm, a WebAssembly module for ecash-lib.Wed, Apr 10, 15:47
tobias_ruck edited the summary of this revision. (Show Details)
bytesofman added inline comments.Wed, Apr 10, 16:27
modules/ecash-lib-wasm/Cargo.toml
31 ↗(On Diff #46995)

do we have some way of checking that this repo has not changed since the last build, e.g. a sha256 hash of what we are getting from this?

It's ok to get this ready with the external dependency but we need some kind of check against a supply chain issue

bytesofman requested changes to this revision.Wed, Apr 10, 16:27

need to get ecash-lib-wasm to build in CI before building ecash-lib in CI

This revision now requires changes to proceed.Wed, Apr 10, 16:27
tobias_ruck updated this revision to Diff 46996.Wed, Apr 10, 16:35

add wasm build to CI before testing ecash-lib

Harbormaster completed remote builds in B28447: Diff 46996.Wed, Apr 10, 16:35
tobias_ruck updated this revision to Diff 46998.Wed, Apr 10, 16:40

pin secp256k1-abc revision commit

Harbormaster completed remote builds in B28449: Diff 46998.Wed, Apr 10, 16:40
bytesofman added inline comments.Wed, Apr 10, 17:55
modules/ecash-lib-wasm/.gitignore
1 ↗(On Diff #46995)

I get this dir after building ecash-lib locally -- assuming we do not want it in the repo?

1 ↗(On Diff #46995)

...never mind I get this in ecash-lib/

bytesofman accepted this revision.Wed, Apr 10, 18:43

./contrib/teamcity/build-configurations.py ecash-lib-tests passes locally

CI failures are ongoing across all diffs

Since this diff does not build and deploy anywhere, imo ok to land it so we can start on the next step while CI issue is resolved

modules/ecash-lib-wasm/src/ecc.rs
89 ↗(On Diff #46998)

🔥

This revision is now accepted and ready to land.Wed, Apr 10, 18:43
This revision was landed with ongoing or failed builds.Wed, Apr 10, 19:25
Closed by commit rABC0642148926bc: [ecash-lib] Add ecash-lib-wasm, a WebAssembly module for ecash-lib (authored by tobias_ruck). · Explain Why
This revision was automatically updated to reflect the committed changes.
tobias_ruck added a commit: rABC0642148926bc: [ecash-lib] Add ecash-lib-wasm, a WebAssembly module for ecash-lib.

Revision Contents
Changeset List

PathSize
6 lines
contrib/
teamcity/
12 lines
utils/
7 lines
modules/
ecash-lib-wasm/
1 line
34 lines
10 lines
19 lines
10 lines
src/
101 lines
26 lines
10 lines
ecash-lib/
3 lines
7 lines
3 lines
src/
40 lines
40 lines
40 lines
9 lines
2 lines
3 lines

Diff 47003

View Options

Cargo.lock

Loading...
View Options

Cargo.toml

Loading...
View Options

contrib/teamcity/build-configurations.yml

Loading...
View Options

contrib/utils/install-dependencies-bullseye.sh

Loading...
View Options

modules/ecash-lib-wasm/.gitignore

Loading...
View Options

modules/ecash-lib-wasm/Cargo.toml

Loading...
View Options

modules/ecash-lib-wasm/Dockerfile

Loading...
View Options

modules/ecash-lib-wasm/build-wasm.sh

Loading...
View Options

modules/ecash-lib-wasm/dockerbuild.sh

Loading...
View Options

modules/ecash-lib-wasm/src/ecc.rs

Loading...
View Options

modules/ecash-lib-wasm/src/hash.rs

Loading...
View Options

modules/ecash-lib-wasm/src/lib.rs

Loading...
View Options

modules/ecash-lib/.gitignore

Loading...
View Options

modules/ecash-lib/.npmignore

Loading...
View Options

modules/ecash-lib/package.json

Loading...
View Options

modules/ecash-lib/src/ecc.test.ts

Loading...
View Options

modules/ecash-lib/src/ecc.ts

Loading...
View Options

modules/ecash-lib/src/hash.test.ts

Loading...
View Options

modules/ecash-lib/src/hash.ts

Loading...
View Options

modules/ecash-lib/src/index.ts

Loading...
View Options

modules/ecash-lib/tsconfig.json

Loading...