Skip to content

Commit

Permalink
add documentation for starknet owner proxy
Browse files Browse the repository at this point in the history
  • Loading branch information
moodysalem committed Jan 9, 2025
1 parent 9bd7c00 commit 529b0f8
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ Contracts in this repository are designed so that they may be used together _or_
- Proposers may only have one active proposal at any time
- The contract can be upgraded via calls to self

#### StarknetOwnerProxy.sol: L1 Proxy

`StarknetOwnerProxy` enables the L2 governor contract to perform actions on L1 via proposals that call `self#send_message_to_l1`.

- The `EthAddress` should be the address of a `StarknetOwnerProxy` referencing the Governor L2 address
- The payload can be computed by calling the `getPayload` view function on the deployed `StarknetOwnerProxy`
- Once the message is accepted on L1, anyone can call `StarknetOwnerProxy#execute` with the proposal's specified `target`, `value` and `data`.

## Testing

Make sure you have [Scarb with asdf](https://docs.swmansion.com/scarb/download#install-via-asdf) installed. You can look at the _.tool-versions_ file to know which version of Scarb is currently used.
Expand Down

0 comments on commit 529b0f8

Please sign in to comment.