Skip to content

Commit

Permalink
added more information
Browse files Browse the repository at this point in the history
  • Loading branch information
Purva-Chaudhari committed Jan 29, 2024
1 parent cb34db0 commit c17c466
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions deliveries/pocs-milestone_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,29 @@ Code base set-up for developing contract staking consensus. Accomplished adding
|-------------|-------------|------------- |------------- |
|0a.|License| [Apache 2.0](https://github.com/auguth/pocs/blob/master/LICENSE) |-|
|0b.|Documentation| [Inline Documentation](https://auguth.github.io/pocs/target/doc/pallet_contracts/) |Crate Documentation for pallet_contracts (PoCS version)|
|0c.|Testing Guide| [Testing guide](https://github.com/auguth/pocs/blob/master/README.md#testing) |`cargo test pocs`|
|0d.|Docker | [Dockerfile](https://github.com/auguth/pocs/blob/master/Dockerfile) | DockerFile is added (The image is very large to upload with requirement of all core folders required. Any suggestions Let us know)|
|0c.|Testing Guide| [Testing guide](https://github.com/auguth/pocs/blob/master/README.md#testing) , [Node Setup & Run](https://github.com/auguth/pocs/blob/master/README.md#run-pocs-node) | `nightly-2023-12-21` required and overriden|
|0d.|Docker | [DockerImage 2.46GB compressed](https://hub.docker.com/r/jobyreuben/pocs-w3f-m1/tags) , [Dockerfile](https://github.com/auguth/pocs/blob/master/Dockerfile)| Linux Hosts are recommended to interact with [Polkadot JS](https://polkadot.js.org/apps/) and [Contracts UI](https://contracts-ui.substrate.io/) . Mac & Windows Host Docker Engines cannot publish ports to localhost and only runs Node |
|0e.|Article (Repo Readme) / External Documentation| [PoCS article](https://github.com/auguth/pocs/blob/master/README.md) |Sections for Milestone 1 Completed. Remaining sections upon Milestone 2 & 3 completion|
|1.|Delivery| [PoCS Node](https://github.com/auguth/pocs/tree/master) |PoCS Node Repository|

## Additional Information
To check out the changes one can also run the contract node https://github.com/paritytech/substrate-contracts-node. Upload any sample contract, instantiate and deploy.
Check ContractStakeInfo and AccountStakeInfo events emitted.

1. Nightly specific version should be overidden `rustup override set nightly-2023-12-21` and wasm targets added `rustup target add wasm32-unknown-unknown --toolchain nightly-2023-12-21`

Recommended `rustup toolchain list`

```
stable-x86_64-unknown-linux-gnu (default)
nightly-2023-12-21-x86_64-unknown-linux-gnu (override)
```
3. PoCS Tests : `cargo test pocs`
4. To check out the changes one can run [Contracts UI](https://contracts-ui.substrate.io/). Upload any sample contract (or [use pocs-test-ink-contracts](https://github.com/auguth/ink-contracts-for-testing)), instantiate and deploy.
5. Check `ContractStakeInfo` and `AccountStakeInfo` events emitted.
6. Next Milestone Includes modifying pallet-staking and delivering a pocs-npos-babe-grandpa node.
**Sections to refer in External Documentation**
- [Setting Up Node](https://github.com/auguth/pocs/blob/master/README.md#run-pocs-node)
- [Docker Pull/Build/Run](https://github.com/auguth/pocs/blob/master/README.md#pullbuild-docker--run)
- [Running Tests](https://github.com/auguth/pocs/blob/master/README.md#run-tests)
- [Pallet Contracts Modification Details](https://github.com/auguth/pocs/blob/master/README.md#contract-staking-pallet_contracts)
- [Testing Details](https://github.com/auguth/pocs/blob/master/README.md#testing)

0 comments on commit c17c466

Please sign in to comment.