From 38e1d0e075d1799291744f5fbdfc7bb0c7807559 Mon Sep 17 00:00:00 2001 From: Milan Steiner Date: Fri, 11 Mar 2022 10:31:54 +0100 Subject: [PATCH 1/5] Document webpack configs --- HACKING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/HACKING.md b/HACKING.md index a8f96965..1f094684 100644 --- a/HACKING.md +++ b/HACKING.md @@ -37,6 +37,37 @@ sha256sum -c checksums.sha256 1. Install dependencies: `yarn install` 2. Install SDKs (to make IDE integration work): `yarn dlx @yarnpkg/sdks` +## Webpack Configs +With WebPack 5, you have to be explicit about the usage of Node.js types and modules that were simply replaced with re-implementations for browsers in Webpack 4. + +Configs for 0.28 and later: +```ts +resolve: { + fallback: { + buffer: false, + crypto: false, + events: false, + path: false, + stream: false, + string_decoder: false, + }, + }, +``` + +Configs for CosmJS < 0.28 +```ts +resolve: { + fallback: { + buffer: false, + crypto: false, + events: false, + path: false, + stream: require.resolve("stream-browserify"), + string_decoder: false, + }, + }, +``` + ## Running tests For unit tests that don't connect to any blockchain, just do: From c0820b7597361c9805cfbef06abb7e9cf21bd06d Mon Sep 17 00:00:00 2001 From: Milan Steiner <69144826+msteiner96@users.noreply.github.com> Date: Mon, 14 Mar 2022 11:09:43 +0100 Subject: [PATCH 2/5] Update HACKING.md Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com> --- HACKING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HACKING.md b/HACKING.md index 1f094684..677b7531 100644 --- a/HACKING.md +++ b/HACKING.md @@ -56,7 +56,7 @@ resolve: { Configs for CosmJS < 0.28 ```ts -resolve: { + resolve: { fallback: { buffer: false, crypto: false, From 4ed6ee140d20a7442cfc10e5e710766093b37e25 Mon Sep 17 00:00:00 2001 From: Milan Steiner <69144826+msteiner96@users.noreply.github.com> Date: Mon, 14 Mar 2022 11:09:46 +0100 Subject: [PATCH 3/5] Update HACKING.md Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com> --- HACKING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HACKING.md b/HACKING.md index 677b7531..3448a0ef 100644 --- a/HACKING.md +++ b/HACKING.md @@ -42,7 +42,7 @@ With WebPack 5, you have to be explicit about the usage of Node.js types and mod Configs for 0.28 and later: ```ts -resolve: { + resolve: { fallback: { buffer: false, crypto: false, From b385e53e1691bb831a3f54151dede36a617d10c5 Mon Sep 17 00:00:00 2001 From: Milan Steiner <69144826+msteiner96@users.noreply.github.com> Date: Mon, 14 Mar 2022 15:12:41 +0100 Subject: [PATCH 4/5] Update HACKING.md --- HACKING.md | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/HACKING.md b/HACKING.md index 3448a0ef..c75e2b8c 100644 --- a/HACKING.md +++ b/HACKING.md @@ -38,10 +38,17 @@ sha256sum -c checksums.sha256 2. Install SDKs (to make IDE integration work): `yarn dlx @yarnpkg/sdks` ## Webpack Configs -With WebPack 5, you have to be explicit about the usage of Node.js types and modules that were simply replaced with re-implementations for browsers in Webpack 4. + +With WebPack 5, you have to be explicit about the usage of Node.js types and +modules that were simply replaced with re-implementations for browsers in +Webpack 4. Configs for 0.28 and later: -```ts + +```js +module.exports = [ + { + ..., resolve: { fallback: { buffer: false, @@ -52,10 +59,16 @@ Configs for 0.28 and later: string_decoder: false, }, }, + }, +]; ``` Configs for CosmJS < 0.28 -```ts + +```js +module.exports = [ + { + ..., resolve: { fallback: { buffer: false, @@ -66,6 +79,25 @@ Configs for CosmJS < 0.28 string_decoder: false, }, }, + }, +]; +``` + +Also, in both cases you need the Buffer plugin: + +```ts +module.exports = [ + { + ..., + plugins: [ + ..., + new webpack.ProvidePlugin({ + Buffer: ["buffer", "Buffer"], + }), + ], + ... + }, +]; ``` ## Running tests From 656e02374898afe755e980e93390591b4b65fd86 Mon Sep 17 00:00:00 2001 From: Milan Steiner Date: Mon, 14 Mar 2022 15:21:10 +0100 Subject: [PATCH 5/5] Moving Webpack confs from hacking to readme --- HACKING.md | 63 ----------------------------------------------------- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 63 deletions(-) diff --git a/HACKING.md b/HACKING.md index c75e2b8c..a8f96965 100644 --- a/HACKING.md +++ b/HACKING.md @@ -37,69 +37,6 @@ sha256sum -c checksums.sha256 1. Install dependencies: `yarn install` 2. Install SDKs (to make IDE integration work): `yarn dlx @yarnpkg/sdks` -## Webpack Configs - -With WebPack 5, you have to be explicit about the usage of Node.js types and -modules that were simply replaced with re-implementations for browsers in -Webpack 4. - -Configs for 0.28 and later: - -```js -module.exports = [ - { - ..., - resolve: { - fallback: { - buffer: false, - crypto: false, - events: false, - path: false, - stream: false, - string_decoder: false, - }, - }, - }, -]; -``` - -Configs for CosmJS < 0.28 - -```js -module.exports = [ - { - ..., - resolve: { - fallback: { - buffer: false, - crypto: false, - events: false, - path: false, - stream: require.resolve("stream-browserify"), - string_decoder: false, - }, - }, - }, -]; -``` - -Also, in both cases you need the Buffer plugin: - -```ts -module.exports = [ - { - ..., - plugins: [ - ..., - new webpack.ProvidePlugin({ - Buffer: ["buffer", "Buffer"], - }), - ], - ... - }, -]; -``` - ## Running tests For unit tests that don't connect to any blockchain, just do: diff --git a/README.md b/README.md index 686cb5ed..6c8b9316 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,70 @@ We're happy to adjust this list according to users' needs as long as you don't ask for Internet Explorer support. If your environment does not support Wasm, we can work on a solution with swappable implementations. + +## Webpack Configs + +With WebPack 5, you have to be explicit about the usage of Node.js types and +modules that were simply replaced with re-implementations for browsers in +Webpack 4. + +Configs for 0.28 and later: + +```js +module.exports = [ + { + ..., + resolve: { + fallback: { + buffer: false, + crypto: false, + events: false, + path: false, + stream: false, + string_decoder: false, + }, + }, + }, +]; +``` + +Configs for CosmJS < 0.28 + +```js +module.exports = [ + { + ..., + resolve: { + fallback: { + buffer: false, + crypto: false, + events: false, + path: false, + stream: require.resolve("stream-browserify"), + string_decoder: false, + }, + }, + }, +]; +``` + +Also, in both cases you need the Buffer plugin: + +```ts +module.exports = [ + { + ..., + plugins: [ + ..., + new webpack.ProvidePlugin({ + Buffer: ["buffer", "Buffer"], + }), + ], + ... + }, +]; +``` + ## Roadmap We maintain a [development board](https://github.com/orgs/cosmos/projects/6),