Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pocs milestone1 #1111

Merged
merged 5 commits into from
Jan 30, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions deliveries/pocs-milestone_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Milestone Delivery :mailbox:

**The delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).**

## Application & Milestone Details

- **Application Document:** [Proof of Contract Stake](https://github.com/w3f/Grants-Program/tree/master/applications/PoCS.md).
- **Milestone** : [1. Pallet Contract Update](https://github.com/w3f/Grants-Program/blob/master/applications/PoCS.md#milestone-1---pallet-contract-update)

## Purpose

Code base set-up for developing contract staking consensus. Accomplished adding new storage variables for the same, tight coupled required pallets and tested end-to-end working of them.

## Deliverables

|Number|Deliverable|Link|Notes|
|-------------|-------------|------------- |------------- |
|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) , [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

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)
Loading