From e2e21a3cbbf8abf6f36c2f94ecb614c3c5f2f2f0 Mon Sep 17 00:00:00 2001 From: Franck R Date: Thu, 17 Mar 2022 14:27:11 +1100 Subject: [PATCH] Fix test script (#47) --- .cspell.json | 23 +++++++++++++++++-- README.md | 8 +++++-- content/docs/guides/angular_relay.md | 2 +- content/docs/guides/discovery_bootstrap.md | 6 ++--- .../dapp_creation/02_connect_wallet.md | 6 ++--- ...seDapp.md => 03_connect_wallet_useDapp.md} | 0 package.json | 8 +++---- 7 files changed, 38 insertions(+), 15 deletions(-) rename content/docs/guides/vote_poll_sdk/dapp_creation/{03_connect_walle_useDapp.md => 03_connect_wallet_useDapp.md} (100%) diff --git a/.cspell.json b/.cspell.json index 0717e53..d5af174 100644 --- a/.cspell.json +++ b/.cspell.json @@ -5,10 +5,12 @@ "words": [ "backoff", "backoffs", + "barebones", "bitjson", "bitauth", "Bojda", "bufbuild", + "browserslist", "chainsafe", "cimg", "ciphertext", @@ -17,6 +19,7 @@ "commitlint", "dependabot", "dingpu", + "discv5", "Dlazy", "dnsaddr", "Dout", @@ -49,6 +52,7 @@ "jdev", "jswaku", "keccak", + "keypair", "lastpub", "libauth", "libp", @@ -61,11 +65,14 @@ "multiaddrs", "multicodecs", "mplex", + "multicall", "multihashes", "muxed", "muxer", "mvps", "nodekey", + "nwaku", + "onbeforeunload", "opendns", "peerhave", "portfinder", @@ -74,7 +81,9 @@ "protobuf", "protoc", "reactjs", + "readline", "recid", + "relref", "rlnrelay", "roadmap", "sandboxed", @@ -90,12 +99,14 @@ "submodules", "supercrypto", "transpiled", + "transpiles", "typedoc", "unencrypted", "unmount", "unmounts", "untracked", "upgrader", + "usedapp", "vacp", "varint", "waku", @@ -105,6 +116,7 @@ "wakuv", "webfonts", "websockets", + "websockify", "wifi", "xsalsa20" ], @@ -114,7 +126,14 @@ "package-lock.json", "yarn.lock", "tsconfig.json", - "presentations.md", // contains youtube links "node_modules/**" - ] + ], + "patterns": [ + { "name": "multiaddr", "pattern": "/p2p.*/" }, + { + "name": "youtube-link", + "pattern": "/< youtube.*/" + } + ], + "ignoreRegExpList": ["multiaddr", "youtube-link"] } diff --git a/README.md b/README.md index 0a67eba..c9acbc7 100644 --- a/README.md +++ b/README.md @@ -7,20 +7,24 @@ It is built using [Hugo](https://gohugo.io/) static site generator. # Development You will need to [install Hugo](https://gohugo.io/getting-started/installing) and pull submodules: + ```sh git submodule update --init ``` + To start a server that also builds the page use: + ```sh hugo server ``` + Will expose the built page under http://localhost:1313/. # Continuous Integration Two branches are built by [our Jenkins instance](https://ci.status.im/): -* `master` is deployed to https://docs.wakuconnect.dev/ by [CI](https://ci.status.im/job/website/job/docs.wakuconnect.dev/) -* `develop` is deployed to https://dev-docs.wakuconnect.dev/ by [CI](https://ci.status.im/job/website/job/dev-docs.wakuconnect.dev/) +- `master` is deployed to https://docs.wakuconnect.dev/ by [CI](https://ci.status.im/job/website/job/docs.wakuconnect.dev/) +- `develop` is deployed to https://dev-docs.wakuconnect.dev/ by [CI](https://ci.status.im/job/website/job/dev-docs.wakuconnect.dev/) PRs should be made for `develop` branch and `master` should be [rebased](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) on `develop` once changes are verified. diff --git a/content/docs/guides/angular_relay.md b/content/docs/guides/angular_relay.md index e873dd5..581022b 100644 --- a/content/docs/guides/angular_relay.md +++ b/content/docs/guides/angular_relay.md @@ -238,7 +238,7 @@ export class WakuService { When using the `bootstrap` option, it may take some time to connect to other peers. That's why we use the `waku.waitForRemotePeer` function to ensure that there are relay peers available to send and receive messages. -Now we can inject the `WakuService` in to the `AppComponent` class to initialise the node and +Now we can inject the `WakuService` in to the `AppComponent` class to initialize the node and subscribe to any status changes. Firstly, import the `WakuService`: diff --git a/content/docs/guides/discovery_bootstrap.md b/content/docs/guides/discovery_bootstrap.md index fbf22f7..315162e 100644 --- a/content/docs/guides/discovery_bootstrap.md +++ b/content/docs/guides/discovery_bootstrap.md @@ -46,7 +46,7 @@ As the current strategy is to connect to nodes operated by Status, we want to ensure that developers consciously opt-in while providing a friendly developer experience. -We intend to change this in the future and enable boostrap by default +We intend to change this in the future and enable bootstrap by default once we have implemented more decentralized strategies. {{< /hint >}} @@ -129,9 +129,9 @@ import { Waku } from "js-waku"; const waku = await Waku.create({ bootstrap: { getPeers: async () => { - const addrs = []; + const addresses = []; // Fetch the multiaddrs from somewhere... - return addrs; + return addresses; }, }, }); diff --git a/content/docs/guides/vote_poll_sdk/dapp_creation/02_connect_wallet.md b/content/docs/guides/vote_poll_sdk/dapp_creation/02_connect_wallet.md index 796b007..8385654 100644 --- a/content/docs/guides/vote_poll_sdk/dapp_creation/02_connect_wallet.md +++ b/content/docs/guides/vote_poll_sdk/dapp_creation/02_connect_wallet.md @@ -20,7 +20,7 @@ yarn add ethers@5.4.6 ``` {{< hint warning >}} -The SDK use `ethers` version 5.4.6 due to incompatibility between minor versions it is recomended to use this version. +The SDK use `ethers` version 5.4.6 due to incompatibility between minor versions it is recommended to use this version. {{< /hint >}} Delete the template `App` component: @@ -41,7 +41,7 @@ Use `TopBar` component to display wallet information. For that, create a `PollPage` component that includes the top bar and will include the poll elements. The component uses `ethers` to connect to the user's wallet: -`MULTICALL_ADDRESS` is an address to mutical smart contract that allows aggregating multiple contract calls into one, thus reducing number of calls to blockchain needed. +`MULTICALL_ADDRESS` is an address to multicall smart contract that allows aggregating multiple contract calls into one, thus reducing number of calls to blockchain needed. Example multicall addresses: - Mainnet: `0xeefba1e63905ef1d7acba5a8513c70307c1ce441`, - Ropsten: `0x53c43764255c17bd724f74c4ef150724ac50a3ed` @@ -170,4 +170,4 @@ ReactDOM.render( ``` {{< button relref="./01_create_dapp" >}}Back{{< /button >}} -{{< button relref="./03_connect_walle_useDapp" >}}Next: Connect using useDapp{{< /button >}} +{{< button relref="./03_connect_wallet_useDapp" >}}Next: Connect using useDapp{{< /button >}} diff --git a/content/docs/guides/vote_poll_sdk/dapp_creation/03_connect_walle_useDapp.md b/content/docs/guides/vote_poll_sdk/dapp_creation/03_connect_wallet_useDapp.md similarity index 100% rename from content/docs/guides/vote_poll_sdk/dapp_creation/03_connect_walle_useDapp.md rename to content/docs/guides/vote_poll_sdk/dapp_creation/03_connect_wallet_useDapp.md diff --git a/package.json b/package.json index 17900b0..634e389 100644 --- a/package.json +++ b/package.json @@ -7,10 +7,10 @@ "license": "MIT", "private": true, "scripts": { - "fix": "prettier \"content*/**/*.md\" \"./*.json\" --write", - "test": "run-p test:*", - "test:format": "prettier \"content*/**/*.md\" \"./*.json\" --list-different", - "test:spelling": "cspell content/**/*.md", + "fix": "prettier \"*.md\" \"./*.json\" --write", + "test": "run-p 'test:*'", + "test:format": "prettier \"*.md\" \"./*.json\" --list-different", + "test:spelling": "cspell \"content/**/*.md\" \"content/*.md\"", "serve": "hugo server" }, "dependencies": {