Skip to content

Commit

Permalink
docs: small nits on readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
0xjei committed Dec 4, 2024
1 parent 3b19b24 commit 55f6037
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Excubiae

Excubiae is a composable framework for building custom attribute-based access control policies on Ethereum.
Excubiae is a composable framework for creating custom attribute-based access control policies on EVM-compatible networks.

The framework provides a set of common, abstract, and flexible smart contracts to simplify the creation of reusable, attribute-based criteria. These contracts, called "gatekeepers," are solution-agnostic, enforcing checks against user-provided evidence and maintaining records of those who meet the criteria.
It provides a set of abstract and flexible smart contracts, known as "gatekeepers," to streamline the definition of reusable criteria. These solution-agnostic contracts enforce checks against user-provided evidence and track those who satisfy the requirements.

This approach enables seamless interoperability across different protocols. For instance, a single check could combine verifiable attributes from Semaphore and MACI, ensuring flexible and composable access control based on two different protocols. Indeed, for example, you can define criteria to verify token ownership or/and validate a zero-knowledge proof (ZKP). Using these criteria, you can create a policy to enforce the checks and integrate it seamlessly into your smart contract logic. A practical use case might involve requiring verification before registering a new voter for a poll (e.g., in a MACI-based voting system).
This approach enables seamless interoperability across different protocols. For instance, a single check could combine verifiable attributes from Semaphore and MACI, ensuring flexible and composable access control. Indeed, for example, you can define criteria to verify token ownership and/or validate a zero-knowledge proof (ZKP). Using these criteria, you can create a policy to enforce the checks and integrate it seamlessly into your smart contract logic. A practical use case might involve requiring verification before registering a new voter for a poll (e.g., in a MACI-based voting system).

You can learn more in this [design document](https://hackmd.io/@0xjei/B1RXoTh71e).

Expand Down Expand Up @@ -77,7 +77,7 @@ yarn compile:contracts

```bash
yarn version:bump <package-name> <version>
# e.g. yarn version:bump imt.sol 2.0.0
# e.g. yarn version:bump excubiae 0.2.0
```

This step creates a commit and a git tag.
Expand All @@ -92,7 +92,7 @@ git push origin main

```bash
git push origin <package-name>-<version>
# e.g. git push origin excubiae-v0.1.0
# e.g. git push origin excubiae-v0.2.0
```

After pushing the new git tag, a workflow will be triggered and will publish the package on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically.
2 changes: 1 addition & 1 deletion packages/contracts/contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ yarn add @excubiae/contracts

## Usage

This package is configured to support the combination of [Hardhat](https://hardhat.org/) and [Foundry](https://book.getfoundry.sh/), see the Hardhat [documentation](https://hardhat.org/hardhat-runner/docs/advanced/hardhat-and-foundry) to learn more.
This package is configured to support the combination of [Hardhat](https://hardhat.org/) and [Foundry](https://book.getfoundry.sh/), see the Hardhat's [documentation](https://hardhat.org/hardhat-runner/docs/advanced/hardhat-and-foundry) to learn more.

### Compile contracts

Expand Down

0 comments on commit 55f6037

Please sign in to comment.