Skip to content

docs: fixes and improvement #1176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fixes and improvement #1176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ contracts

## Contract Docs<a name="contract-docs"></a>

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<a name="getting-started"></a>
Expand Down
2 changes: 1 addition & 1 deletion archive/docs/HyphenFacet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion archive/docs/MultichainFacet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

@coderabbitai coderabbitai bot May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix section reference for update scripts
Under the "Structure of Update scripts" header, the bullet still reads "Each deployment script…". It should reference update scripts to avoid confusion.

Proposed diff:

-  - Each deployment script follows this format:
+  - Each update script follows this format:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Each deployment script follows this format:
- Each update script follows this format:
🤖 Prompt for AI Agents 
In conventions.md at line 344, the bullet point incorrectly refers to "Each
deployment script" under the "Structure of Update scripts" header. Change the
wording to reference "Each update script" instead to accurately reflect the
section content and avoid confusion.

- Inherits `UpdateScriptBase` for consistency in update logic.
- Calls `update("{ContractName}")` to handle facet upgrades in the Diamond architecture.
- Ensures correct function selectors are updated.
Expand Down