Skip to content

Commit

Permalink
v0.1-rc2 release (#50)
Browse files Browse the repository at this point in the history
* Update README.md (#35)

typo

* fix assets config (#38)

* Rename to openzeppelin-pallet-abstractions (#43)

* Tanssi Abstractions (#37)

* tanssi abstractions

* fix configs

* Update src/lib.rs

Co-authored-by: Amar Singh <asinghchrony@protonmail.com>

* Update src/tanssi.rs

Co-authored-by: Amar Singh <asinghchrony@protonmail.com>

---------

Co-authored-by: Amar Singh <asinghchrony@protonmail.com>

* fix pallet name (#46)

* remove abstractions (#48)

* remove abstractions

* fix fmt

* remove `abstraction` atribute from runtime api

* Update procedural/src/lib.rs

Co-authored-by: Amar Singh <asinghchrony@protonmail.com>

---------

Co-authored-by: Amar Singh <asinghchrony@protonmail.com>

---------

Co-authored-by: Özgün Özerk <ozgunozerk.elo@gmail.com>
Co-authored-by: Amar Singh <asinghchrony@protonmail.com>
  • Loading branch information
3 people authored Nov 26, 2024
1 parent 92a8d33 commit cff4284
Show file tree
Hide file tree
Showing 18 changed files with 3,565 additions and 88 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ There are many ways to contribute to this project.

## Opening an issue

You can [open an issue](https://github.com/OpenZeppelin/polkadot-runtime-wrappers/issues/new/choose) to suggest a feature or report a bug.
You can [open an issue](https://github.com/OpenZeppelin/openzeppelin-pallet-abstractions/issues/new/choose) to suggest a feature or report a bug.

Before opening an issue, be sure to search through the existing open and closed
issues, and consider posting a comment in one of those instead.
Expand All @@ -27,4 +27,4 @@ Make sure to run linter and tests to make sure your pull request is good before
If you're looking for a good place to start, look for issues labelled
["good first issue"].

["good first issue"]: https://github.com/OpenZeppelin/polkadot-runtime-wrappers/labels/good%20first%20issue!
["good first issue"]: https://github.com/OpenZeppelin/openzeppelin-pallet-abstractions/labels/good%20first%20issue!
2 changes: 1 addition & 1 deletion Cargo.lock

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

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "openzeppelin-polkadot-wrappers"
name = "openzeppelin-pallet-abstractions"
authors = [ "OpenZeppelin" ]
description = "Wrappers with sensible defaults for constructing Polkadot Parachain Runtimes"
description = "Abstractions that provide sensible defaults for constructing Polkadot parachain runtimes"
edition = "2021"
license = "GPL-3.0-only"
repository = "https://github.com/OpenZeppelin/polkadot-runtime-wrappers"
repository = "https://github.com/OpenZeppelin/openzeppelin-pallet-abstractions"
readme = "README.md"
version = "0.1.0"

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# polkadot-runtime-wrappers
# OpenZeppelin Pallet Abstractions

`polkadot-runtime-wrappers` is a set of Rust macros designed to streamline the configuration of Polkadot Parachain Runtimes. These macros reduce the lines of code (LOC) necessary for configuring a secure and optimized runtime, providing a balance between customizability and ease of use.
This repository contains a set of Rust macros designed to streamline the configuration of Polkadot Parachain Runtimes. These macros reduce the lines of code (LOC) necessary for configuring a secure and optimized runtime, providing a balance between customizability and ease of use.

> [!WARNING]
> This project has not been audited yet.
Expand All @@ -15,24 +15,24 @@ Features:

## Installation

To use `polkadot-runtime-wrappers`, add it to your Cargo.toml file:
To use `openzeppelin-pallet-abstractions`, add it to your Cargo.toml file:

```toml
[dependencies]
openzeppelin-polkadot-wrappers = { git = "https://github.com/OpenZeppelin/polkadot-runtime-wrappers", tag = "v0.1.0" }
openzeppelin-pallet-abstractions = { git = "https://github.com/OpenZeppelin/openzeppelin-pallet-abstractions", tag = "v0.1.0" }
```

Then, import the necessary macros in your runtime configuration file.

## Usage

> [!NOTE]
> For examples of how to use the wrappers, see the polkadot-runtime-templates [repository](https://github.com/OpenZeppelin/polkadot-runtime-templates).
> For examples of how to use the abstractions, see the [Polkadot runtime templates](https://github.com/OpenZeppelin/polkadot-runtime-templates).
The macros are intended to streamline runtime configuration for Polkadot parachains. Here’s a basic example from the EVM parachain runtime maintained in [`openzeppelin/polkadot-runtime-templates`](https://github.com/OpenZeppelin/polkadot-runtime-templates):
The macros are intended to streamline runtime configuration for Polkadot parachains. Here’s a basic example from the EVM parachain runtime maintained in the [Polkadot runtime templates](https://github.com/OpenZeppelin/polkadot-runtime-templates):

```rust, ignore
use openzeppelin_polkadot_wrappers::{impl_openzeppelin_system, SystemConfig};
use openzeppelin_pallet_abstractions::{impl_openzeppelin_system, SystemConfig};
pub struct OpenZeppelinRuntime;
impl SystemConfig for OpenZeppelinRuntime {
Expand Down Expand Up @@ -71,7 +71,7 @@ Here are the other pallet groupings:
Here are their configurations in the EVM parachain runtime:

```rust, ignore
use openzeppelin_polkadot_wrappers::{
use openzeppelin_pallet_abstractions::{
impl_openzeppelin_assets, impl_openzeppelin_consensus, impl_openzeppelin_evm,
impl_openzeppelin_governance, impl_openzeppelin_xcm, AssetsConfig,
ConsensusConfig, EvmConfig, GovernanceConfig, XcmConfig,
Expand Down Expand Up @@ -115,15 +115,15 @@ impl_openzeppelin_xcm!(OpenZeppelinRuntime);
impl_openzeppelin_evm!(OpenZeppelinRuntime);
```

Here are a few ways `polkadot-runtime-wrappers` simplifies parachain configuration:
Here are a few ways `openzeppelin-pallet-abstractions` simplifies parachain configuration:

- Basic Setup: Only a few LOC required to get a secure, functioning runtime.
- Advanced Configuration: Customize each aspect of the runtime by passing additional parameters to the macros.
- Default Overrides: Override defaults for specific settings while letting the wrapper handle the rest.
- Default Overrides: Override defaults for specific settings while letting the abstractions handle the rest.

## Security

Refer tou our [Security Policy](./SECURITY.MD) for more details.
Refer to our [Security Policy](./SECURITY.MD) for more details.

## Contributing

Expand Down
Loading

0 comments on commit cff4284

Please sign in to comment.