Skip to content
This repository has been archived by the owner on Jan 11, 2024. It is now read-only.

Commit

Permalink
Merge branch 'main' of github.com:consensus-shipyard/ipc-solidity-actors
Browse files Browse the repository at this point in the history
Signed-off-by: Alfonso de la Rocha <[email protected]>
  • Loading branch information
adlrocha committed Aug 7, 2023
2 parents 9dbd6d5 + f96a293 commit cc109a5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ The project accommodates the following main contracts
- `SubnetActorDiamond.sol`: Reference implementation of an IPC SubnetActor within the Diamond pattern.
- `SubnetRegistry.sol`: Registry contract for seamlessly deploying subnet actors.

# Documentation

## High-level Overview

The original idea of IPC is presented in these [paper](https://research.protocol.ai/publications/hierarchical-consensus-a-horizontal-scaling-framework-for-blockchains/delarocha2022.pdf), [post](https://docs.filecoin.io/basics/interplanetary-consensus/overview/) and [video](https://www.youtube.com/watch?v=G7d5KNRZdp0). The protocol has evolved a lot since the original paper, so take it as a high-level description of the system.

## Specification

The current specification draft is available [here](https://github.com/consensus-shipyard/IPC-design-reference-spec/blob/main/main.pdf).

# Deploying IPC Solidity contracts
Before deploying the contract, you'll need to configure the `RPC_URL` and `PRIVATE_KEY` environmental variables
to point to your network provider and the private key of the address you want to use for the deployment, respectively.
Expand Down Expand Up @@ -111,4 +121,7 @@ or
make prepare
```

Use `make storage` to check that the storage layout has not been corrupted.
Use `make storage` to check that the storage layout has not been corrupted.

# Bugs
Please report any bugs using the [issue tracker](https://github.com/consensus-shipyard/ipc-solidity-actors/issues).
5 changes: 5 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Security

## Reporting a vulnerability

Please report any security-sensitive issues via [email protected]

0 comments on commit cc109a5

Please sign in to comment.