From c1303841d5c3f0fcde811074b9e9939b26f72cfe Mon Sep 17 00:00:00 2001 From: Arun Jangra Date: Thu, 27 Jun 2024 01:23:45 +0530 Subject: [PATCH] fix : readme lint fix --- .markdownlint.json | 10 ++++++++++ README.md | 14 +++++++------- 2 files changed, 17 insertions(+), 7 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..21ac02e --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,10 @@ +{ + "MD033": false, + "MD041": false, + "MD045": false, + "MD003": false, + "MD013": { + "code_blocks": false, + "line_length": 307 + } +} diff --git a/README.md b/README.md index d9ed977..cce8056 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 - +StarknetTokenBridge.sol (Starkgate v2.0.1) - ## StarkNet Consensus Protocol Contracts