Skip to content

Commit

Permalink
fix : readme lint fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Arun Jangra authored and Arun Jangra committed Jun 26, 2024
1 parent 868ebfd commit c130384
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
10 changes: 10 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"MD033": false,
"MD041": false,
"MD045": false,
"MD003": false,
"MD013": {
"code_blocks": false,
"line_length": 307
}
}
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Zaun

This repository contains interfaces and functions to interact with starknet solidity contracts.
This repository contains interfaces and functions to interact with
starknet solidity contracts.

One can use two options for deploying the implementation contract :

- `deploy_contract_behind_unsafe_proxy` : This will deploy the contract behind a minimal proxy
and can be used for dev purposes.
- `deploy_contract_behind_unsafe_proxy` : This will deploy the contract behind a minimal proxy and can be used for dev purposes.

- `deploy_contract_behind_safe_proxy` : This will deploy the contract behind a safe audited
proxy and setting the implementation and upgrades
- `deploy_contract_behind_safe_proxy` : This will deploy the contract behind a safe audited proxy and setting the
implementation and upgrades

## Setup

Expand Down Expand Up @@ -49,8 +49,8 @@ make artifacts

## Bridge Contracts Sources

StarknetEthBridge.sol - https://etherscan.io/address/0x455603AD9ae671F6c1f0f746F24d7904cA603581#code
StarknetTokenBridge.sol (Starkgate v2.0.1) - https://github.com/starknet-io/starkgate-contracts/blob/5a10fd263d29cd032b7229691d043520edae0737/src/solidity/StarknetTokenBridge.sol
StarknetEthBridge.sol - <https://etherscan.io/address/0x455603AD9ae671F6c1f0f746F24d7904cA603581#code>
StarknetTokenBridge.sol (Starkgate v2.0.1) - <https://github.com/starknet-io/starkgate-contracts/blob/5a10fd263d29cd032b7229691d043520edae0737/src/solidity/StarknetTokenBridge.sol>

## StarkNet Consensus Protocol Contracts

Expand Down

0 comments on commit c130384

Please sign in to comment.