Merge pull request #148 from status-im/change-repo-name

This commit is contained in:
Franck Royer 2021-05-13 11:35:38 +10:00 committed by GitHub
commit ddaacd8a48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 80 additions and 82 deletions

View File

@ -1,4 +1,4 @@
name: Add new issues to js-waku project board
name: Add new issues to waku-js project board
on:
issues:
@ -10,6 +10,6 @@ jobs:
steps:
- uses: alex-page/github-project-automation-plus@v0.6.0
with:
project: js-waku
project: waku-js
column: New
repo-token: ${{ secrets.GH_ACTION_PROJECT_MGMT }}

View File

@ -15,7 +15,7 @@ jobs:
- name: Set git author identity
run: |
git config user.name "GitHub Action On js-waku Repo"
git config user.name "GitHub Action On waku-js Repo"
git config user.email "franck+ghpages@status.im"
- name: Install NodeJS
@ -29,10 +29,10 @@ jobs:
path: ~/.npm
key: node-v1-${{ hashFiles('**/package-lock.json') }}
- name: "[js-waku] install using npm ci"
- name: "[waku-js] install using npm ci"
uses: bahmutov/npm-install@v1
- name: "[js-waku] build"
- name: "[waku-js] build"
run: npm run build
- name: install using npm i

View File

@ -30,10 +30,10 @@ jobs:
path: ~/.npm
key: examples-node-v1-${{ hashFiles('**/package-lock.json') }}
- name: "[js-waku] install using npm ci"
- name: "[waku-js] install using npm ci"
uses: bahmutov/npm-install@v1
- name: "[js-waku] build"
- name: "[waku-js] build"
run: npm run build
- name: ${{ matrix.example }} install using npm i

View File

@ -7,17 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.1.0] - 2021-05-13
### Added
- Add usage section to the README.
## [1.0.0] - 2021-05-11
### Added
- Support of [Waku v2 Relay](https://rfc.vac.dev/spec/11/).
- Support of [Waku v2 Store](https://rfc.vac.dev/spec/13/).
- [Node Chat App example](./examples/cli-chat).
- [ReactJS Chat App example](./examples/web-chat).
- [Typedoc Documentation](https://status-im.github.io/js-waku/docs).
[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/f46ce77f57c08866873b5c80acd052e0ddba8bc9..v1.0.0
[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/f46ce77f57c08866873b5c80acd052e0ddba8bc9..v0.1.0

View File

@ -2,10 +2,10 @@
Contributors are welcomed!
We try to keep a number of [`good first issue`](https://github.com/status-im/js-waku/labels/good%20first%20issue) for new contributors.
If you feel confident, you can also check out the [`help wanted`](https://github.com/status-im/js-waku/labels/help%20wanted) issues.
We try to keep a number of [`good first issue`](https://github.com/status-im/waku-js/labels/good%20first%20issue) for new contributors.
If you feel confident, you can also check out the [`help wanted`](https://github.com/status-im/waku-js/labels/help%20wanted) issues.
To have an idea of the work in the pipeline, feel free to view the [js-waku project board](https://github.com/status-im/js-waku/projects/1).
To have an idea of the work in the pipeline, feel free to view the [waku-js project board](https://github.com/status-im/waku-js/projects/1).
This project board is to prioritize the work of core contributors so do not be deterred by issues in the `Icebox` or bottom of the `Backlog`.
Do note that we have a [CI](./.github/workflows/ci.yml) powered by GitHub Action.
@ -25,7 +25,7 @@ To build and test this repository, you need:
To ensure interoperability with [nim-waku](https://github.com/status-im/nim-waku/), some tests are run against a nim-waku node.
This is why `nim-waku` is present as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), which itself contain several submodules.
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/js-waku/blob/main/package.json)).
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/waku-js/blob/main/package.json)).
To build nim-waku, you also need [Rust](https://www.rust-lang.org/tools/install).

View File

@ -4,16 +4,16 @@ A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/1
## Usage
Install `web3-waku` package:
Install `waku-js` package:
```shell
npm install web3-waku
npm install waku-js
```
Start a waku node:
```javascript
import { Waku } from 'web3-waku';
import { Waku } from 'waku-js';
const waku = await Waku.create();
```
@ -47,7 +47,7 @@ waku.relay.addObserver((msg) => {
Send a message on the waku relay network:
```javascript
import { WakuMessage } from 'web3-waku';
import { WakuMessage } from 'waku-js';
const msg = WakuMessage.fromUtf8String("Here is a message!", "waku/2/my-cool-app/proto")
await waku.relay.send(msg);
@ -76,7 +76,7 @@ waku.store.queryHistory(storePeerId, ["waku/2/my-cool-app/proto"],
```
Find more [examples](#examples) below
or checkout the latest `main` branch documentation at [https://status-im.github.io/js-waku/docs/](https://status-im.github.io/js-waku/docs/).
or checkout the latest `main` branch documentation at [https://status-im.github.io/waku-js/docs/](https://status-im.github.io/waku-js/docs/).
Docs can also be generated locally using:
@ -87,7 +87,7 @@ npm run doc
## Waku Protocol Support
You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).
You can track progress on the [project board](https://github.com/status-im/waku-js/projects/1).
- ✔: Supported
- 🚧: Implementation in progress
@ -111,28 +111,28 @@ You can track progress on the [project board](https://github.com/status-im/js-wa
## Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/js-waku/issues/new/).
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/waku-js/issues/new/).
For support, questions & more general topics, please join the discussion on the [Vac forum](https://forum.vac.dev/tag/js-waku) (use _\#js-waku_ tag).
For support, questions & more general topics, please join the discussion on the [Vac forum](https://forum.vac.dev/tag/waku-js) (use _\#js-waku_ tag).
## Examples
## Web Chat App (ReactJS)
A ReactJS chat app is provided as a showcase of the library used in the browser.
A deployed version is available at https://status-im.github.io/js-waku/
A deployed version is available at https://status-im.github.io/waku-js/
Find the code in the [examples folder](https://github.com/status-im/js-waku/tree/main/examples/web-chat).
Find the code in the [examples folder](https://github.com/status-im/waku-js/tree/main/examples/web-chat).
To run a development version locally, do:
```shell
git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install # Install dependencies for js-waku
npm run build # Build js-waku
git clone https://github.com/status-im/waku-js/ ; cd waku-js
npm install # Install dependencies for waku-js
npm run build # Build waku-js
cd examples/web-chat
npm install # Install dependencies for the web app
npm run start # Start development server to serve the web app on http://localhost:3000/js-waku
npm run start # Start development server to serve the web app on http://localhost:3000/waku-js
```
Use `/help` to see the available commands.
@ -142,7 +142,7 @@ Use `/help` to see the available commands.
A node chat app is provided as a working example of the library.
It is interoperable with the [nim-waku chat app example](https://github.com/status-im/nim-waku/blob/master/examples/v2/chat2.nim).
Find the code in the [examples folder](https://github.com/status-im/js-waku/tree/main/examples/cli-chat).
Find the code in the [examples folder](https://github.com/status-im/waku-js/tree/main/examples/cli-chat).
To run the chat app, first ensure you have [Node.js](https://nodejs.org/en/) v14 or above:
@ -153,9 +153,9 @@ node --version
Then, install and run:
```shell
git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install # Install dependencies for js-waku
npm run build # Build js-waku
git clone https://github.com/status-im/waku-js/ ; cd waku-js
npm install # Install dependencies for waku-js
npm run build # Build waku-js
cd examples/cli-chat
npm install # Install dependencies for the cli app
npm run start -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ

View File

@ -1,3 +1,3 @@
# A NodeJS CLI Chat App powered by js-waku
# A NodeJS CLI Chat App powered by waku-js
See js-waku [README](../../README.md#cli-chat-app-nodejs) for details.
See waku-js [README](../../README.md#cli-chat-app-nodejs) for details.

View File

@ -1,17 +1,17 @@
{
"name": "js-waku-cli-chat",
"version": "1.0.0",
"name": "waku-js-cli-chat",
"version": "0.1.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "js-waku-cli-chat",
"version": "1.0.0",
"name": "waku-js-cli-chat",
"version": "0.1.0",
"license": "MIT OR Apache-2.0",
"dependencies": {
"libp2p-tcp": "^0.15.4",
"prompt-sync": "^4.2.0",
"web3-waku": "../../build/main"
"waku-js": "../../build/main"
},
"devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1",
@ -7509,7 +7509,7 @@
"integrity": "sha512-jkjy6pjU1fxUvI51P+gCsxg1u2n8LSt0W6KrCNQceaziKzff74GoWmjVG46KieVzybO1sttPQmYfrwSHey7GUA==",
"dev": true
},
"node_modules/web3-waku": {
"node_modules/waku-js": {
"resolved": "../../build/main",
"link": true
},
@ -13563,7 +13563,7 @@
"integrity": "sha512-jkjy6pjU1fxUvI51P+gCsxg1u2n8LSt0W6KrCNQceaziKzff74GoWmjVG46KieVzybO1sttPQmYfrwSHey7GUA==",
"dev": true
},
"web3-waku": {
"waku-js": {
"version": "file:../../build/main"
},
"which": {

View File

@ -1,9 +1,9 @@
{
"name": "js-waku-cli-chat",
"version": "1.0.0",
"description": "A NodeJS CLI Chat App powered by js-waku",
"name": "waku-js-cli-chat",
"version": "0.1.0",
"description": "A NodeJS CLI Chat App powered by waku-js",
"main": "./index.ts",
"repository": "https://github.com/status-im/js-waku",
"repository": "https://github.com/status-im/waku-js",
"license": "MIT OR Apache-2.0",
"keywords": [
"waku",
@ -33,7 +33,7 @@
"dependencies": {
"libp2p-tcp": "^0.15.4",
"prompt-sync": "^4.2.0",
"web3-waku": "../../build/main"
"waku-js": "../../build/main"
},
"devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1",

View File

@ -1,5 +1,5 @@
import { expect } from 'chai';
import { ChatMessage } from 'web3-waku';
import { ChatMessage } from 'waku-js';
import { formatMessage } from './chat';

View File

@ -3,7 +3,7 @@ import util from 'util';
import TCP from 'libp2p-tcp';
import { multiaddr, Multiaddr } from 'multiaddr';
import { ChatMessage, StoreCodec, Waku, WakuMessage } from 'web3-waku';
import { ChatMessage, StoreCodec, Waku, WakuMessage } from 'waku-js';
const ChatContentTopic = 'dingpu';
@ -25,7 +25,7 @@ export default async function startChat(): Promise<void> {
output: process.stdout,
});
let nick = 'js-waku';
let nick = 'waku-js';
try {
const question = util.promisify(rl.question).bind(rl);
// Looks like wrong type definition of promisify is picked.

View File

@ -1,3 +1,3 @@
# A React Web Chat App powered by js-waku
# A React Web Chat App powered by waku-js
See js-waku [README](../../README.md#web-chat-app-reactjs) for details.
See waku-js [README](../../README.md#web-chat-app-reactjs) for details.

View File

@ -11,8 +11,8 @@
"react": "^16.14.0",
"react-dom": "^16.14.0",
"server-name-generator": "^1.0.5",
"web-vitals": "^1.1.1",
"web3-waku": "../../build/main"
"waku-js": "../../build/main",
"web-vitals": "^1.1.1"
},
"devDependencies": {
"@testing-library/jest-dom": "^5.11.10",
@ -22885,6 +22885,10 @@
"node": ">=10"
}
},
"node_modules/waku-js": {
"resolved": "../../build/main",
"link": true
},
"node_modules/walker": {
"version": "1.0.7",
"resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz",
@ -23226,10 +23230,6 @@
"resolved": "https://registry.npmjs.org/web-vitals/-/web-vitals-1.1.1.tgz",
"integrity": "sha512-jYOaqu01Ny1NvMwJ3dBJDUOJ2PGWknZWH4AUnvFOscvbdHMERIKT2TlgiAey5rVyfOePG7so2JcXXZdSnBvioQ=="
},
"node_modules/web3-waku": {
"resolved": "../../build/main",
"link": true
},
"node_modules/webidl-conversions": {
"version": "6.1.0",
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-6.1.0.tgz",
@ -43270,6 +43270,9 @@
"xml-name-validator": "^3.0.0"
}
},
"waku-js": {
"version": "file:../../build/main"
},
"walker": {
"version": "1.0.7",
"resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz",
@ -43568,9 +43571,6 @@
"resolved": "https://registry.npmjs.org/web-vitals/-/web-vitals-1.1.1.tgz",
"integrity": "sha512-jYOaqu01Ny1NvMwJ3dBJDUOJ2PGWknZWH4AUnvFOscvbdHMERIKT2TlgiAey5rVyfOePG7so2JcXXZdSnBvioQ=="
},
"web3-waku": {
"version": "file:../../build/main"
},
"webidl-conversions": {
"version": "6.1.0",
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-6.1.0.tgz",

View File

@ -2,14 +2,14 @@
"name": "web-chat",
"version": "0.1.0",
"private": true,
"homepage": "/js-waku",
"homepage": "/waku-js",
"dependencies": {
"@livechat/ui-kit": "*",
"react": "^16.14.0",
"react-dom": "^16.14.0",
"server-name-generator": "^1.0.5",
"web-vitals": "^1.1.1",
"web3-waku": "../../build/main"
"waku-js": "../../build/main",
"web-vitals": "^1.1.1"
},
"devDependencies": {
"@testing-library/jest-dom": "^5.11.10",
@ -38,8 +38,8 @@
"test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.{ts,tsx},public/**/*.html}\" -c ../../.cspell.json",
"fix:prettier": "prettier \"src/**/*.{ts,tsx}\" \"./*.json\" --write",
"fix:lint": "eslint src --ext .ts --ext .tsx --fix",
"js-waku:build": "cd ../; npm run build",
"predeploy": "run-s js-waku:build build",
"waku-js:build": "cd ../; npm run build",
"predeploy": "run-s waku-js:build build",
"deploy": "gh-pages -d build"
},
"eslintConfig": {

View File

@ -7,7 +7,7 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />
<meta
name="description"
content="Chat app powered by js-waku"
content="Chat app powered by waku-js"
/>
<!--
manifest.json provides metadata used when your web app is installed on a

View File

@ -1,6 +1,6 @@
{
"short_name": "Waku v2 chat app",
"name": "Chat app powered by js-waku",
"name": "Chat app powered by waku-js",
"icons": [
{
"src": "favicon.ico",

View File

@ -2,7 +2,7 @@ import { multiaddr } from 'multiaddr';
import PeerId from 'peer-id';
import { useEffect, useState } from 'react';
import './App.css';
import { ChatMessage, WakuMessage, StoreCodec, Waku } from 'web3-waku';
import { ChatMessage, WakuMessage, StoreCodec, Waku } from 'waku-js';
import handleCommand from './command';
import Room from './Room';
import { WakuContext } from './WakuContext';

View File

@ -1,5 +1,5 @@
import { useEffect, useRef, useState } from 'react';
import { ChatMessage } from 'web3-waku';
import { ChatMessage } from 'waku-js';
import {
Message,
MessageText,

View File

@ -1,4 +1,4 @@
import { ChatMessage, WakuMessage } from 'web3-waku';
import { ChatMessage, WakuMessage } from 'waku-js';
import { ChatContentTopic } from './App';
import ChatList from './ChatList';
import MessageInput from './MessageInput';

View File

@ -1,5 +1,5 @@
import { createContext, useContext } from 'react';
import { Waku } from 'web3-waku';
import { Waku } from 'waku-js';
export type WakuContextType = {
waku?: Waku;

View File

@ -1,6 +1,6 @@
import { multiaddr } from 'multiaddr';
import PeerId from 'peer-id';
import { Waku } from 'web3-waku';
import { Waku } from 'waku-js';
function help(): string[] {
return [

8
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "web3-waku",
"version": "1.0.0",
"name": "waku-js",
"version": "0.1.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "web3-waku",
"version": "1.0.0",
"name": "waku-js",
"version": "0.1.0",
"license": "MIT OR Apache-2.0",
"dependencies": {
"@bitauth/libauth": "^1.17.1",

View File

@ -1,11 +1,11 @@
{
"name": "web3-waku",
"version": "1.0.0",
"name": "waku-js",
"version": "0.1.0",
"description": "TypeScript implementation of the Waku v2 protocol",
"main": "build/main/index.js",
"typings": "build/main/index.d.ts",
"module": "build/module/index.js",
"repository": "https://github.com/status-im/js-waku",
"repository": "https://github.com/status-im/waku-js",
"license": "MIT OR Apache-2.0",
"keywords": [
"waku",