Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patractlabs/jupiter
Wasm smart contract networks powered by Substrate FRAME Contracts pallet in Polkadot ecosystem.
https://github.com/patractlabs/jupiter
frame-contracts-pallet ink pallet-contracts patract polkadot smart-contracts substrate wasm
Last synced: about 1 month ago
JSON representation
Wasm smart contract networks powered by Substrate FRAME Contracts pallet in Polkadot ecosystem.
- Host: GitHub
- URL: https://github.com/patractlabs/jupiter
- Owner: patractlabs
- Created: 2020-08-20T09:08:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-01T03:42:50.000Z (over 2 years ago)
- Last Synced: 2024-01-24T04:15:25.865Z (11 months ago)
- Topics: frame-contracts-pallet, ink, pallet-contracts, patract, polkadot, smart-contracts, substrate, wasm
- Language: Rust
- Homepage:
- Size: 23.3 MB
- Stars: 55
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-substrate - Jupiter - Testnet for smart contracts written for the FRAME Contracts pallet and ink!. (Tools)
- awesome-substrate - Jupiter - Testnet for smart contracts written for the FRAME Contracts pallet and ink!. (Tools)
README
# Jupiter
Wasm smart contract networks powered by Substrate `FRAME Contracts pallet` in Polkadot ecosystem.
Jupiter aims to be an open blockchain network, which supports contract developers to use [ink!](https://github.com/paritytech/ink), [Ask!](https://github.com/patractlabs/ask) and other language frameworks which can run on `FRAME Contracts pallet` contract model. We will directly use DOT(test coin)/ROC(rococo coin) as native token for gas fee and governance.
For different requirements, this repo contains different runtime for different situations (The content in following parentheses is the name of the executable file):
* Jupiter Testnets (already running):
* Jupiter (jupiter): A parachain collator with Wasm contract feature. Due to currently public relaychain(like Rococo and Westend) do not support Sandbox HostFunction, we are running a private modified Westend testnet relaychain to run jupiter. And Jupiter parachain is running on this test Westend relaychain.
* Jupiter PoA (jupiter-prep): The independent blockchain maintained by PoA validators is only for deploying test contracts and issuing test assets with no value. This blockchain network contains newest features.
* Development Node:
* Jupiter Dev Node (jupiter-dev): Local development node with pure `FRAME contracts pallet`. Contract developers could test contracts quickly **without waiting block interval**.
> In post, we use rococo-v1 branch for parachain. And now the rococo-v1 branch do not need anymore.
*In following, we name `FRAME contracts pallet` as `pallet-contracts`*
## Patract's `FRAME contracts pallet` (We will name it as `pallet-patracts` in future)
Patract `FRAME contracts pallet` contains our `ChainExtension` to provide many particular features for contracts, and contains some compatible modifications.
* ChainExtension
- [ ] Contract Logger support, refer to this project link [ink-log](https://github.com/patractlabs/ink-log)
- [x] Zero-Knowledge support, refer to this link [PIP-101](https://github.com/patractlabs/PIPs/blob/main/PIPs/pip-101.md)
*Currently we use a simple static way to charge weight for ZKP, we would change this part with benchmarks result in future.*
* Patract modifications (`pallet-patracts`)
* // No features for now.
Thus we call "`src pallet-contract`" for the `pallet-contract` module which comes from substrate directly, and call "`modified pallet-contracts`" for
the `pallet-contract` which comes from our forked substrate repo in `vendor` directory.
Inside:
* `src pallet-contract`: support Patract `ChainExtension`
* `modified pallet-contract`: support Patract `ChainExtension` and Patract modifications
## Jupiter living network
When using [Substrate Portal](https://polkadot.js.org/apps), [@polkadot/api](https://github.com/polkadot-js/api) and [Redspot](https://github.com/patractlabs/redspot)
or other 3rd parties client to connect Jupiter node, please remember to add ["extending types"](https://polkadot.js.org/docs/api/start/types.extend/) for Jupiter requirements.
Notice different network may have different Extending types.
Now, Jupiter has launched following network:
* Jupiter PoA V1 (Jupiter A1):
This network uses `src pallet-contract` now.
It's an independent blockchain network which contains contracts feature. Anyone could submit
contract to this network for test. The token decimals and time interval for producing block are
same with Polkadot network. This testnet blockchain uses Babe as consensus algorithm,
and **provide Babe VRF random number for contract module.**
**Jupiter PoA's SS58 Address Prefix changes from 42 (address: `5xxxx`) to 26 (address: `3xxxx`) in 1.0.1 version.**
For this network, the Extending types is:
```json
{
"LookupSource": "MultiAddress",
"Address": "MultiAddress",
"AccountInfo": "AccountInfoWithTripleRefCount",
"AliveContractInfo": {
"trieId": "TrieId",
"storageSize": "u32",
"pairCount": "u32",
"codeHash": "CodeHash",
"rentAllowance": "Balance",
"rentPayed": "Balance",
"deductBlock": "BlockNumber",
"lastWrite": "Option",
"_reserved": "Option"
},
"FullIdentification": "AccountId",
"AuthorityState": {
"_enum": [
"Working",
"Waiting"
]
},
"EraIndex": "u32",
"ActiveEraInfo": {
"index": "EraIndex",
"start": "Option"
},
"UnappliedSlash": {
"validator": "AccountId",
"reporters": "Vec"
}
}
```
**Jupiter PoA open provider links are:**
- `wss://jupiter-poa.elara.patract.io/`
- `wss://ws.jupiter-poa.patract.cn/`
Jupiter open telemetry link is [https://telemetry.patract.io/](https://telemetry.patract.io/#list/Jupiter%20A1)
* Jupiter:
It's a parachain blockchain network which would be deployed to any Polkadot Relaychain network. This parachain is running our private Westend network.
And in this parachain, we try to use the random number which relayed from relay chain.
This network uses `src pallet-contract` now.
For this network, the Extending types is:
```json
{
"LookupSource": "MultiAddress",
"Address": "MultiAddress",
"AccountInfo": "AccountInfoWithTripleRefCount",
"AliveContractInfo": {
"trieId": "TrieId",
"storageSize": "u32",
"pairCount": "u32",
"codeHash": "CodeHash",
"rentAllowance": "Balance",
"rentPayed": "Balance",
"deductBlock": "BlockNumber",
"lastWrite": "Option",
"_reserved": "Option"
},
"BabeRandomness": {
"epoch": "u64",
"start_slot": "u64",
"duration": "u64",
"randomness": "schnorrkel::Randomness"
}
}
```
**Jupiter open provider links are:**
- `wss://ws.jupiter.patract-westend.patract.cn`
**Westend-Patract(Relaychain) open provider links are:**
- `wss://ws.patract-westend.patract.cn`
Jupiter Parachain open telemetry link is [https://telemetry.patract.io/#list/Jupiter%20PC1](https://telemetry.patract.io/#list/Jupiter%20PC1)
Westend-Patract(Relaychain) open telemetry link is [https://telemetry.patract.io/#list/Westend-Patract](https://telemetry.patract.io/#list/Westend-Patract)
* Jupiter Dev node:
It's a local develop node for testing contract easily. This node could run in single, and **do not have time interval
for producing block**, which would produce block only when receiving an extrinsic. This feature let developers do not
need to waste time for waiting producing blocks in develop and test.
This node uses `src pallet-contract` now.
For this network, the Extending types is:
```json
{
"LookupSource": "MultiAddress",
"Address": "MultiAddress"
}
```
## compile and run
### 1. clone this repo
```bash
> git clone --recurse-submodules https://github.com/patractlabs/jupiter.git
## or do following commands
> git clone https://github.com/patractlabs/jupiter.git
> cd jupiter/vendor
> git submodule update --init --recursive
```
### 2. init building environment
*Note: if you have build substrate successfully, you do not need to do this any more*
You should prepare rust environment before, lookup [this link for rust](https://www.rust-lang.org/learn/get-started) to
downland rust and install it.
then:
```bash
> cd jupiter/scripts
> bash init.sh
```
### 3. compile this repo
Compile this repo follow this step:
```bash
> WASM_BUILD_TYPE=release cargo build --release
```
or we advice you to add `WASM_BUILD_TYPE=release` in your global environment variables, so that you could just execute:
```bash
cargo build --release
```
If you just need debug execution file, just do
```bash
cargo build
```
### 4. run
When running node, following parameters means:
* `--dev`: means start with dev mode, would provide default private key to start the chain, and running a independent node.
* `-d `: means blockchain database stored in the ``, if you what to clear all data, just stop the
node and delete this directory. If you do not use this parameter, the node would use default directory to store data.
* `--execution=`: substrate provide `Native` and `WASM` and other execution strategy. for test and develop,
we suggest to use `Native`
More parameters please lookup from `--help` or Substrate Developer Hub [https://substrate.dev/](https://substrate.dev/)
#### 4.1 Jupiter PoA
The blockchain produces blocks in `babe` algorithm for every **6 second**, and do finality by `grandpa` algorithm.
All people could join this testnet as a sync node.
**Welcome use this link [https://app.element.io/#/room/#jupiter-faucet-room:matrix.org
](https://app.element.io/#/room/#jupiter-faucet-room:matrix.org
) to claim some DOT from our faucet**
##### 4.1.1 join Jupiter PoA testnet
Moving the execution file `jupiter-prep` to other place and launch the node by following steps:
```bash
./jupiter-prep --chain=jupiter-poa --name= --pruning=archive --execution=NativeElseWasm
```
Those steps is same to any other substrate node, just should notice this parameter `--chain` should use `jupiter`.
You could lookup your node in [https://telemetry.patract.io/](https://telemetry.patract.io/).
##### 4.1.2 start dev mode Jupiter PoA blockchain
Notice this dev mode just means Jupiter PoA start with `--dev`, which is using dev config to start Jupiter PoA, not the
`jupiter-dev` node.
```bash
./jupiter-prep --dev --execution=NativeElseWasm -d
```
##### 4.1.2 start local test mode Jupiter PoA blockchain
Local test is a mode which is used to start a private blockchain network.
```bash
# start first node
./jupiter-prep --chain=jupiter-poa-local --alice --execution=NativeElseWasm -d
# start second node
./jupiter-prep --chain=jupiter-poa-local --bob --execution=NativeElseWasm -d
```
Note if you start those two nodes in a machine, there could connect to each other directly. If you start in different
but in same network, you should add `--bootnodes` parameter when start second node. More details please lookup [https://substrate.dev/](https://substrate.dev/)
#### 4.2 Jupiter
currently, we add [Sandbox HostFunction](https://github.com/patractlabs/polkadot/blob/patract-sandbox-098/node/core/pvf/src/executor_intf.rs#L95) in relaychain(westend) to support parachain contract,
so if you want to running on test environment, you should add Sandbox HostFunction to relaychain.
##### 4.2.1 start local test mode Jupiter Parachain
Export relaychain json:
```bash
./target/release/polkadot build-spec --chain westend-local --disable-default-bootnode --raw > westend-local.json
```
Custom parachain specification:
```bash
./target/release/jupiter build-spec --chain jupiter-dev --disable-default-bootnode > westend-local-parachain-plain.json
```
Default para ID is 1000 from Cumulus, so you must correctly set it for your parachain based on the reserved para ID from above. Assuming your reserved para ID is 2000, you will open rococo-local-parachain-plain.json and modify two fields:
```json
// --snip--
"para_id": 2000, // <--- your already registered ID
// --snip--
"parachainInfo": {
"parachainId": 2000 // <--- your already registered ID
},
// --snip--
```
Then generate a raw chain spec derived from your modified plain chain spec:
```bash
./target/release/jupiter build-spec --chain westend-local-parachain-plain.json --raw --disable-default-bootnode > westend-local-parachain-2000-raw.json
```
Obtain Wasm runtime validation function:
```bash
./target/release/jupiter export-genesis-wasm --chain westend-local-parachain-2000-raw.json > para-wasm
```
Generate a parachain genesis state:
```bash
./target/release/jupiter export-genesis-state --chain westend-local-parachain-2000-raw.json > para-genesis
```
Run parachain:
```bash
./target/release/jupiter \
--alice \
--collator \
--force-authoring \
--chain westend-local-parachain-2000-raw.json \
--tmp \
--port 40333 \
--ws-port 8844 \
-- \
--execution wasm \
--chain westend-local.json \
--port 30343 \
--ws-port 9977
```
After running relaychain and parachain, upload parachain genenis file to relaychain. refere [this link](https://substrate.dev/cumulus-workshop/#/en/3-parachains/2-register).
##### 4.2.2 join Jupiter Parachain testnet
For now, we only running our own private parachain(collator) node use aura algorithm, outside node should running in sync mode.
```bash
./jupiter --chain ./jupiter-westend-patract.json --execution wasm --wasm-execution=compiled --force-authoring --parachain-id=2000 --tmp \
--chain ./westend-patract.json --no-beefy --execution wasm --wasm-execution=compiled --tmp \
--bootnodes /dns/ws.patract-westend.patract.cn/tcp/30333/p2p/12D3KooWFBrd6SrevJ4vLi3SY7KRYQEVbRSeoENmdDouAW7wGCvZ
```
> Notice, currently we didn't make seed node into westend-patract.json, so you have to specify our private westend bootnode.
#### 4.3 Jupiter Dev Node
`jupiter-dev` just use for local development, it providers a nice and quick experience for contract developing for developers
do not need wait for producing block time, which is very wasting time in testing.
running jupiter-dev node in your machine:
```bash
./jupiter-dev --dev -d .sub --execution=Native
```
### 5. https://polkadot.js.org/apps/ or https://github.com/polkadot-js/apps or using for `polkadot-js` sdk
Now, Jupiter has provided in `apps`. And we would provide Jupiter Rococo in `TEST RELAYS & PARACHAINS` soon.