Skip to content

Commit

Permalink
chore: release 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
lrazovic committed Mar 5, 2025
1 parent fbeff8e commit 10286ad
Show file tree
Hide file tree
Showing 10 changed files with 86 additions and 93 deletions.
44 changes: 21 additions & 23 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ homepage = "https://www.polimec.org/"
license-file = "LICENSE"
readme = "README.md"
repository = "https://github.com/Polimec/polimec-node"
version = "0.9.0"
version = "1.0.0"

[profile.release]
# Substrate runtime requires unwinding.
Expand Down
76 changes: 35 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Polimec

> **Warning**: This project is under HEAVY development.
Polimec is a blockchain platform built on Substrate, designed for robustness and scalability. This README provides guidelines for setting up and running Polimec as a Parachain using Zombienet.

## Table of Contents
Expand All @@ -22,79 +20,75 @@ Polimec is a blockchain platform built on Substrate, designed for robustness and

### Setting up the Relay Chain

1. **Clone the Polkadot Repository**:
1. **Clone the Polkadot Repository**:
`git clone https://github.com/paritytech/polkadot`
2. **Checkout the specific branch**:
2. **Checkout the specific branch**:
`git checkout release-v1.0.0`
3. **Compile the source**:
3. **Compile the source**:
`cargo build --release --package polkadot`
4. **Add the Polkadot binary to your PATH**:
4. **Add the Polkadot binary to your PATH**:
`cp target/release/polkadot ~/.local/bin/polkadot`

### Setting up Polimec

1. **Clone the Polimec Repository**:
1. **Clone the Polimec Repository**:
`git clone <Polimec Repository URL>`
2. **Compile the source**:
2. **Compile the source**:
`cargo build --release --package polimec-node`
3. **Add the Polimec node binary to your PATH**:
3. **Add the Polimec node binary to your PATH**:
`cp target/release/polimec-node ~/.local/bin/polimec`

### Running the Network

1. **Launch the network with Zombienet**:
`zombienet spawn scripts/zombienet/native/local-testnet.toml`
2. A Polimec node is now reachable at https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:8080#/explorer
2. A Polimec node is now reachable at https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:8080#/explorer

## Additional Resources

- **Compilation of the Runtime**: Use [srtool](https://github.com/paritytech/srtool) for compiling the runtime and generating the WASM blob.

```
== Compact
Version : polimec-mainnet-2 (polimec-mainnet-0.tx1.au1)
Version : polimec-mainnet-1000000 (polimec-mainnet-0.tx7.au1)
Metadata : V14
Size : 5.95 MB (6238415 bytes)
setCode : 0x0582b7c4d42bb46593ac2788d17c3d083eedfbc9d8ef3fb0c912378189d44f94
authorizeUpgrade : 0xe8d26589c2c5257c3f52e21ba420eb0c6fd25fa5cee0878bc183ca0256dee9bc
IPFS : Qmbi9ymmCdJVJCLsBAmYKWGYgYjGuHJLRdCPj9fvXQ3X9U
BLAKE2_256 : 0x7ac6016ddf9179bb2d6d0284df4d60323519f20016647ba887057756d131b51e
Wasm : runtimes/testnet/target/srtool/release/wbuild/polimec-runtime/polimec_runtime.compact.wasm
Size : 6.09 MB (6388233 bytes)
setCode : 0x51c78d58adc2b79d41ec2bcca074a17685bedadaf9c4e5a8d6c2426055262192
authorizeUpgrade : 0x6bb01a720ef423759bc6541243cccffd0ec35dee69116e540906c23e2d61593f
IPFS : QmRvqT7DfSFNYszTC9dH99Fdqta5XNEfnd4tXxM9vaW69y
BLAKE2_256 : 0x78d8e5ac7bcaf6ad2f38701928f2c387a32dbc453ab58c000f88e48fa2dadd4c
Wasm : runtimes/polimec/target/srtool/production/wbuild/polimec-runtime/polimec_runtime.compact.wasm
== Compressed
Version : polimec-mainnet-2 (polimec-mainnet-0.tx1.au1)
Version : polimec-mainnet-1000000 (polimec-mainnet-0.tx7.au1)
Metadata : V14
Size : 1.20 MB (1255405 bytes)
Compression : 79.88%
setCode : 0x84730f2715acaba69361390edf28cc788e0ebdf491380d02764f78f0c702ecb9
authorizeUpgrade : 0x8dcd2827b4c86be23da13a93a8d63a38ad4952c1450738ed8471982bcb4fc714
IPFS : QmPFr7QRFKM5jSuYfBNAg21dfiKEpvMxXMydLDZuW9yLFH
BLAKE2_256 : 0x7341cc921de52eaea99af5865c3e36562cf49158dcb961daef3c2e06f531ae00
Wasm : runtimes/testnet/target/srtool/release/wbuild/polimec-runtime/polimec_runtime.compact.compressed.wasm
Size : 1.52 MB (1592474 bytes)
Compression : 75.08%
setCode : 0x7c0c21c12ca5722f9f0a916a9ef96be22d56452149b69c8a51344f5ecf651075
authorizeUpgrade : 0x31a4614dcda36f15a84899147df88f31d128b4d6204b32b7510d7a5cf0e8bf84
IPFS : Qme6jU3X5nWWpsgFFLFnhabCuFEphwvzJ5g91s8bQ3Ab3b
BLAKE2_256 : 0x084190d81d4d8e2a17842ce8caebab8fc6051069ab0c06ca94bd8b4984d52dd7
Wasm : runtimes/polimec/target/srtool/production/wbuild/polimec-runtime/polimec_runtime.compact.compressed.wasm
```
- **Utility Scripts**: Check the `scripts` directory for useful scripts. Use [just](https://github.com/casey/just) for executing scripts, e.g., `$ just build-parachain-node`.

```
Available recipes:
benchmark-pallet-funding # Benchmark the "Testnet" Runtime
benchmark-runtime-funding # Benchmark the "Testnet" Runtime
benchmarks-test
build-all # Build everything
build-base-runtime # Build the "Base" Runtime
build-base-srtool # Build the "Base" Runtime using srtool
build-parachain-node # Build the "Parachain" Node
build-parachain-runtime # Build the "Testnet" Runtime
build-parachain-srtool # Build the "Testnet" Runtime using srtool
create-chainspec-base # Create the "Base" Runtime Chainspec
default # Help information
docker-build tag="latest" package="polimec-node" # Build the Node Docker Image
run-node # Run the "Standalone" node in --dev mode
test-runtime-features # Test the runtimes features
zombienet path_to_file="scripts/zombienet/native/base-rococo-local.toml" # Use zombienet to spawn rococo + polimec testnet
benchmark-extrinsics pallet="pallet-funding" extrinsics="*"
benchmark-pallet chain="polimec-paseo-local" pallet="pallet-dispenser" # Run the Runtime benchmarks for a specific pallet
benchmark-runtime
build-polimec-paseo-srtool
build-polimec-polkadot-srtool # Build the "Base" Runtime using srtool
create-chainspec-base # Create the "Base" Runtime Chainspec
default # Help information
dev path_to_file="scripts/zombienet/polimec-paseo-local.toml" # Use zombienet to spawn rococo + polimec testnet
docker-build tag="latest" package="polimec-node" # Build the Node Docker Image
dry-run-benchmarks mode="fast-mode" pallet="*" extrinsic="*"
test-integration # Run the integration tests
test-runtime-features runtime="polimec-runtime" # Test the runtimes features
```


## Contributing

We welcome contributions! Feel free to raise issues or submit pull requests. Your feedback and contributions are valued as we develop Polimec into a robust and versatile software.

9 changes: 5 additions & 4 deletions integration-tests/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ polimec-runtime.workspace = true
default = [ "development-settings", "instant-mode", "std" ]
instant-mode = [ "polimec-runtime/instant-mode" ]
std = [
"assets-common/std",
"cumulus-pallet-xcm/std",
"cumulus-primitives-core/std",
"frame-metadata-hash-extension/std",
Expand Down Expand Up @@ -132,6 +133,8 @@ std = [
"polkadot-parachain-primitives/std",
"polkadot-primitives/std",
"polkadot-runtime-parachains/std",
"rococo-runtime-constants/std",
"rococo-runtime/std",
"scale-info/std",
"serde/std",
"sp-arithmetic/std",
Expand All @@ -143,16 +146,14 @@ std = [
"sp-io/std",
"sp-runtime/std",
"sp-std/std",
"rococo-runtime-constants/std",
"rococo-runtime/std",
"xcm-builder/std",
"xcm-executor/std",
"xcm-fee-payment-runtime-api/std",
"xcm/std",
"assets-common/std"
]
development-settings = [ "polimec-runtime/development-settings" ]
runtime-benchmarks = [
"assets-common/runtime-benchmarks",
"cumulus-primitives-core/runtime-benchmarks",
"frame-support/runtime-benchmarks",
"frame-system/runtime-benchmarks",
Expand Down Expand Up @@ -185,8 +186,8 @@ runtime-benchmarks = [
"polkadot-primitives/runtime-benchmarks",
"polkadot-runtime-parachains/runtime-benchmarks",
"polkadot-service/runtime-benchmarks",
"sp-runtime/runtime-benchmarks",
"rococo-runtime/runtime-benchmarks",
"sp-runtime/runtime-benchmarks",
"xcm-builder/runtime-benchmarks",
"xcm-executor/runtime-benchmarks",
"xcm-fee-payment-runtime-api/runtime-benchmarks",
Expand Down
4 changes: 3 additions & 1 deletion nodes/parachain/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ runtime-benchmarks = [
"frame-benchmarking-cli/runtime-benchmarks",
"frame-benchmarking/runtime-benchmarks",
"pallet-funding/runtime-benchmarks",
"polimec-common/runtime-benchmarks",
"polimec-runtime/runtime-benchmarks",
"polkadot-cli/runtime-benchmarks",
"polkadot-primitives/runtime-benchmarks",
Expand All @@ -97,6 +98,7 @@ runtime-benchmarks = [
]
try-runtime = [
"pallet-funding/try-runtime",
"polimec-common/try-runtime",
"polimec-runtime/try-runtime",
"polkadot-cli/try-runtime",
"sp-runtime/try-runtime",
Expand All @@ -116,5 +118,5 @@ std = [
"sp-consensus-aura/std",
"sp-core/std",
"sp-runtime/std",
"xcm/std"
"xcm/std",
]
Loading

0 comments on commit 10286ad

Please sign in to comment.