forked from w3f/Grant-Milestone-Delivery
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request w3f#436 from cruikshankss/three-evals
Accept three evals
- Loading branch information
Showing
3 changed files
with
150 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Evaluation | ||
|
||
- **Status:** Accepted | ||
- **Application Document:** https://github.com/w3f/Grants-Program/pull/774 | ||
- **Milestone:** 2 | ||
|
||
**Deliverables** | ||
|
||
| Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| ------ | ----------- | -------- | ---- |----------------- | | ||
| 0a. | License | [x] | [LICENSE](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/LICENSE) | MIT License | | ||
| 0b. | Documentation | [x] | 1. [Examples](https://github.com/Blackprint/nodes-polkadot.js/tree/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/example) <br> 2. [Guide for importing the module and load examples](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/README.md) | Exceptionally high quality docs. | | ||
| 0c. | Testing Guide | [x] | 1. [Guide](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/README.md#development) for the node module <br> 2. [Guide](https://github.com/Blackprint/Blackprint/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/README.md#build-and-run-the-unit-test) for main [Blackprint](https://github.com/Blackprint/Blackprint)'s repository | Very clear, thank you! | | ||
| 0d. | Docker | [x] | [Test files](https://github.com/Blackprint/nodes-polkadot.js/tree/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/tests), [GitHub Action](https://github.com/Blackprint/nodes-polkadot.js/runs/5645423590?check_suite_focus=true#step:7:67) | Tested examples manually in browser and ran tests locally from source as well. | | ||
| 1. | Event node | [x] | 1. [Events/Account/Balance](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/src/Events/Account/Balance.js) <br> 2. [Unit Test](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/tests/nodes/transfer-balance.js#L86-L172) | Great job progressing to visually programming events with accounts and balance! | | ||
| 2. | Browser Extension | [x] | 1. [Example - Send Balance](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/example/send-balance-extension.json) <br> 2. [Example - Sign data](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/example/sign-verify-extension.json) <br> 2. [Connection/Extension](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/src/Connection/Extension.js) <br> 3. [Unit Test](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/tests/nodes/browser-extension.js) | Looks great. | | ||
| 3. | Balance transfer node | [x] | 1. [Example- Send Balance](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/example/send-balance-mnemonic.json) <br> 2. [Account/Transfer/Balance](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/src/Account/Transfer/Balance.js) <br> 3. [Unit Test](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/tests/nodes/transfer-balance.js) | Looks great. | ||
| 4. | Payment info node | [x] | 1. [Example](https://github.com/Blackprint/nodes-polkadot.js/blob/11a27d89879a4f15e8c745f607ac31fdb9048c49/example/payment-info.json) <br> 2. [Transaction/PaymentInfo](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/src/Transaction/PaymentInfo.js) <br> 4. [Unit Test](https://github.com/Blackprint/nodes-polkadot.js/blob/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/tests/nodes/transfer-balance.js#L68-L84) | Slightly different testing process, see below. | | ||
| 5. | Package v0.3 | [x] | [NPM Registry](https://www.npmjs.com/package/@blackprint/nodes-polkadot.js) | Thank you for publishing an updated version on the registry! Great open-source community contribution! | | ||
|
||
|
||
|
||
|
||
# Additional Information | ||
|
||
See the [Conversation tab of M2 Delivery](https://github.com/w3f/Grant-Milestone-Delivery/pull/405) for more in-depth testing guide. | ||
|
||
1. I downloaded [this repo](https://github.com/Blackprint/nodes-polkadot.js) and followed its `README` testing guide. | ||
|
||
2. I created an `.env` file based on `.env.example` with two WND addresses that were funded with WND. | ||
|
||
3. I ran these commands to run the tests locally from source: | ||
|
||
``` | ||
npm install | ||
npm run build-prod | ||
npm test | ||
``` | ||
|
||
|
||
4. Then I went to [this website](https://blackprint.github.io/) and tested these [examples](https://github.com/Blackprint/nodes-polkadot.js/tree/72aad794cf647d2ea403b1c3d44eb40bec1c6af3/example). | ||
|
||
5. For deliverables 1, 2 & 3, I loaded the examples from the [browser sandbox](https://blackprint.github.io/) and imported the `nodes-polkadot` example list. | ||
|
||
6. For deliverable 4, I tested in incognito mode to prevent caching issues & copied in the [json example](https://github.com/Blackprint/nodes-polkadot.js/blob/11a27d89879a4f15e8c745f607ac31fdb9048c49/example/payment-info.json). | ||
|
||
|
||
#### All Github repos: | ||
1. https://github.com/Blackprint/Blackprint | ||
2. https://github.com/Blackprint/nodes-polkadot.js | ||
|
||
#### Additional important links: | ||
1. [project roadmap on GitHub](https://github.com/Blackprint/Blackprint#blackprint-roadmap) | ||
2. [highly detailed M1 eval](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/evaluations/blackprint_1_cruikshankss.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Evaluation | ||
|
||
- **Status:** Accepted | ||
- **Application Document:** https://github.com/w3f/Grants-Program/pull/657 | ||
- **Milestone:** 3 | ||
|
||
**Deliverables** | ||
|
||
| Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| ------ | ----------- | -------- | ---- |----------------- | | ||
| 0a. | License | [x] | [Apache 2](https://github.com/iridium-labs/substrate/blob/iris-milestone-2/LICENSE-APACHE2) | No change to licenses used in Substrate | | ||
| 0b. | Documentation | [x] | [docs](https://iridium-labs.github.io/), [mdbook](https://github.com/iridium-labs/iris-docs) | Exemplary M3 demo video!! Great docs site. | | ||
| 0c. | Testing Guide | [x] | https://docs.google.com/document/d/1EUf8YUi3Gnr05weutoH-TTLpOClHHgKOTlLVhX61Frg/edit?usp=sharing | Exemplary Google Doc and Google Sheets!! | | ||
| 0d. | Docker | [x] | [iris](https://hub.docker.com/repository/docker/iridiumlabs/iris), [UI](https://hub.docker.com/repository/docker/iridiumlabs/iris-ui) | Works great! | | ||
| 0e. | Article | [x] | https://medium.com/iridium/iris-a-next-gen-decentralized-storage-layer-part-3-aa6e8492cc09 | Thank you for the entire M1, M2, M3 series. | | ||
| 1. | Substrate module: iris-assets Runtime Module Enhancements | [x] | https://github.com/iridium-labs/substrate/blob/iris_milestone_3/bin/node-template/pallets/iris-assets/src/lib.rs | Simplified runtime storage, security, moved some RPC functions into here. | | ||
| 2. | Custom RPC Endpoint | [x] | https://github.com/iridium-labs/substrate/tree/iris_milestone_3/bin/node-template/pallets/iris-assets/rpc | Moved some functions into iris-assets; security. | | ||
| 3a. | Iris Runtime: Contracts Pallet | [x] | https://github.com/iridium-labs/substrate/blob/ff629c867b523a18526359360d1fb55f23a4aa90/bin/node-template/runtime/src/lib.rs#L252 | Enables running the Iris Asset Exchange smart contract via the explorer. | | ||
| 3b. | Iris Runtime: Chain Extension | [x] | https://github.com/iridium-labs/substrate/blob/ff629c867b523a18526359360d1fb55f23a4aa90/bin/node-template/runtime/src/lib.rs#L813 | Links Iris nodes and Iris Asset Exchange smart contracts. | | ||
| 3c. | Contracts: The Iris Asset Exchange | [x] | https://github.com/iridium-labs/contracts/tree/iris_milestone_3/iris_asset_exchange | Buy/sell access to data. | | ||
| 4 | Iris Runtime: Iris-Ledger pallet | [x] | https://github.com/iridium-labs/substrate/tree/iris_milestone_3/bin/node-template/pallets/iris-ledger | Discovered the need for locking mechanisms for currency/payments. | | ||
| 5. | User Interface | [x] | https://github.com/iridium-labs/ui/tree/iris_milestone_3 | CONGRATULATIONS!! LOOKS AMAZING! | | ||
|
||
|
||
# Additional Notes | ||
|
||
|
||
I watched the demo vid, then checked out the testing guides in the google sheet and google doc. Main docs here (to run docker): https://iridium-labs.github.io/. | ||
|
||
|
||
I got the blockchain running by doing these commands: | ||
|
||
``` | ||
git clone git@github.com:iridium-labs/substrate.git | ||
cd substrate | ||
git checkout iris_milestone_3s | ||
cargo +nightly build --release | ||
touch testfile.txt | ||
nano testfile.txt // then put in some text and closed nano with ctrl+X, then "Y" to save | ||
ipfs add testfile.txt | ||
docker pull iridiumlabs/iris | ||
docker run -p 9944:9944 \ | ||
-p 9933:9933 \ | ||
-p 30333:30333 \ | ||
-p 9615:9615 \ | ||
-it \ | ||
--rm \ | ||
--name iris-alice \ | ||
iridiumlabs/iris \ | ||
--dev --ws-external --rpc-external \ | ||
--node-key 0000000000000000000000000000000000000000000000000000000000000001 | ||
docker run -p 9945:9944 -p 9934:9933 -p 30334:30333 -p 9616:9615 -it --rm --name iris-node1 iridiumlabs/iris --bob --dev --ws-external --rpc-external --rpc-methods=unsafe --bootnodes /ip4/172.17.0.1/tcp/30333/p2p/12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp | ||
docker pull iridiumlabs/iris-ui | ||
// found my ipv4 and replaced w.x.y.z (below) with it | ||
docker run -it --rm -p 3000:3000 -e REACT_APP_IPV4="w.x.y.z" iridiumlabs/iris-ui:latest | ||
ipfs daemon | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Evaluation | ||
|
||
- **Status:** Accepted | ||
- **Application Document:** https://github.com/w3f/Grants-Program/pull/778 | ||
- **Milestone:** 2 | ||
|
||
| Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| ------ | ----------- | -------- | ---- |----------------- | | ||
| 0a. | License Apache 2.0 | [x] | https://github.com/Nick-1979/polkadot-Js-Plus-extension/blob/master/packages/extension-plus/LICENSE | | | ||
| 0b. | Documentation | [x] | https://github.com/Nick-1979/polkadot-Js-Plus-extension/wiki/How-To's | Excellent, thank you! | | ||
| 0c. | Testing Guide | [x] | https://github.com/Nick-1979/polkadot-Js-Plus-extension/wiki/Installation | Unit tests and testing on westend blockchain are available | | ||
| 0d. | Article | [x] | https://medium.com/@ekbatanifard/polkadot-js-plus-extension-123ef8ebcd59 | Includes introduction, motivation, howTos, installation| | ||
| 1. | Referendums and Proposals | [x] | https://github.com/Nick-1979/polkadot-Js-Plus-extension/tree/master/packages/extension-plus/src/Popup/Governance/Democracy | To view and vote for referendums and second proposals | | ||
| 2. | Council and Motions | [x] | https://github.com/Nick-1979/polkadot-Js-Plus-extension/tree/master/packages/extension-plus/src/Popup/Governance/Council | To view council information, vote/unvote them, also to view active motions | | ||
| 3. | Treasury and Tips | [x] | https://github.com/Nick-1979/polkadot-Js-Plus-extension/tree/master/packages/extension-plus/src/Popup/Governance/Treasury | To view/submit treasury proposals and tips | | ||
|
||
|
||
|
||
# Additional Notes | ||
|
||
I got all 19 test suites to pass locally by running: | ||
|
||
``` | ||
git clone git@github.com:Nick-1979/polkadot-Js-Plus-extension.git | ||
cd polkadot-Js-Plus-extension // master branch | ||
yarn install | ||
yarn build | ||
yarn test:plus | ||
``` | ||
|
||
I downloaded Mozilla and installed Plus from the [Firefox Add-Ons extension link](https://addons.mozilla.org/en-US/firefox/addon/polkadot-js-plus-extension/). Congratulations on publishing the add-on with Firefox! :celebrate: |