From 2633cf50f4cc6524f0d177b21c55288c2698a1b8 Mon Sep 17 00:00:00 2001 From: Rahul Lashkari Date: Fri, 30 May 2025 15:04:37 +0530 Subject: [PATCH] docs: fixes and improvement --- README.md | 2 +- archive/docs/HyphenFacet.md | 2 +- archive/docs/MultichainFacet.md | 2 +- conventions.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0c1a8dafb..0e445be51 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,7 @@ contracts ## Contract Docs -You can read more details documentation on each facet [here](./docs/README.md). +You can read more detailed documentation on each facet [here](./docs/README.md). Sample requests to fetch transactions for each facet can be found at the end of each section. ## Getting Started diff --git a/archive/docs/HyphenFacet.md b/archive/docs/HyphenFacet.md index a5d719157..3719cebbc 100644 --- a/archive/docs/HyphenFacet.md +++ b/archive/docs/HyphenFacet.md @@ -2,7 +2,7 @@ ## How it works -The Hyphen Facet works by forwarding Hyphen V2 specific calls to the [LiquidityPool Contract](https://github.com/bcnmy/hyphen-contract/blob/master/contracts/hyphen/LiquidityPool.sol). All bridging is done by calling the `depositErc20` method or `depositNative` method if you using a native token like **ETH** or **MATIC**. +The Hyphen Facet works by forwarding Hyphen V2 specific calls to the [LiquidityPool Contract](https://github.com/bcnmy/hyphen-contract/blob/master/contracts/hyphen/LiquidityPool.sol). All bridging is done by calling the `depositErc20` method or `depositNative` method if you are using a native token like **ETH** or **MATIC**. ```mermaid graph LR; diff --git a/archive/docs/MultichainFacet.md b/archive/docs/MultichainFacet.md index eeca2c4a5..dd719cddd 100644 --- a/archive/docs/MultichainFacet.md +++ b/archive/docs/MultichainFacet.md @@ -16,7 +16,7 @@ graph LR; - `function initMultichain(address anyNative, address[] calldata routers)` - Initializer method. Allow routers. -- `function function registerRouters(address[] calldata routers, bool[] calldata allowed)` +- `function registerRouters(address[] calldata routers, bool[] calldata allowed)` - Register method. Allow or disallow router. - `function startBridgeTokensViaMultichain(BridgeData memory _bridgeData, MultichainData calldata _multichainData)` - Simply bridges tokens using Multichain diff --git a/conventions.md b/conventions.md index b7c17c0b7..0902e4c83 100644 --- a/conventions.md +++ b/conventions.md @@ -334,14 +334,14 @@ Deployment and update scripts for LI.FI smart contracts are located in: `script/ - Deployment scripts must be prefixed with `Deploy` followed by the contract name (e.g., `DeployMayanFacet.s.sol`). - Update scripts must be prefixed with `Update` followed by the contract name (e.g., `UpdateMayanFacet.s.sol`). - **Structure of Deployment scripts:** - - Each deployment script follow this format: + - Each deployment script follows this format: - Inherits `DeployScriptBase` to maintain consistency. - Uses JSON config (`stdJson`) to fetch contract-specific configuration data. - Optionally defines `getConstructorArgs()` if the contract has constructor arguments. - Encodes constructor arguments before deployment. - Calls `deploy()` using `type({ContractName}).creationCode`. - **Structure of Update scripts:** - - Each deployment script follow this format: + - Each deployment script follows this format: - Inherits `UpdateScriptBase` for consistency in update logic. - Calls `update("{ContractName}")` to handle facet upgrades in the Diamond architecture. - Ensures correct function selectors are updated.