Skip to content

Commit bdab71a

Browse files
committed
fix: readmes
1 parent 161870d commit bdab71a

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/crosschain-data/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,16 @@ Every AMB has their identifier for different chains/networks. In state registrie
5151

5252
- **Core State Registry [CoreStateRegistry.sol](./extensions/CoreStateRegistry.sol)**: Contract inheriting BaseStateRegistry which enables core contracts, including routers & form implementations, to communicate with their counterparts on a different network. Contains its custom logic for payload processing & updating (during deposits).
5353

54-
- **Timelock Form State Registry [TimelockStateRegistry.sol](./extensions/TimelockStateRegistry.sol)**: Contract inheriting BaseStateRegistry, specifically designed to process withdrawal request for ERC4626TimelockForm. Inherits BaseStateRegistry to send acknowledgements on failed withdrawals for timelock forms.
55-
5654
- **Broadcast State Registry [BroadcastRegistry.sol](./BroadcastRegistry.sol)**: BroadcastRegistry proposes a unique form of communication from Chain A to all chains Superform is on, as opposed to BaseStateRegistry which assumes communication between only two chains.
5755

5856
Each individual AMB is in the adapters folder and is named after the Arbitrary Message Bridge (AMB).
5957

58+
- **[AxelarImplementation.sol](./adapters/axelar/AxelarImplementation.sol)**: Adapter for Axelar AMB
59+
6060
- **[LayerzeroImplementation.sol](./adapters/layerzero/LayerzeroImplementation.sol)**: Adapter for Layerzero AMB
6161

62+
- **[LayerzeroV2Implementation.sol](./adapters/layerzero-v2/LayerzeroV2Implementation.sol)**: Adapter for Layerzero V2 AMB
63+
6264
- **[HyperlaneImplementation.sol](./adapters/hyperlane/HyperlaneImplementation.sol)**: Adapter for Hyperlane AMB
6365

6466
- **[WormholeARImplementation.sol](./adapters/wormhole/automatic-relayer/WormholeARImplementation.sol)**: Adapter for Wormhole Automatic Relayer AMB

src/forms/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,4 @@ Interaction with Superforms happens through the four implemented external functi
1212

1313
**ERC4626Form.sol:** The standard implementation of a Form contract. This Form interacts with a corresponding ERC4626 compliant vault.
1414

15-
**ERC4626KYCDAOForm.sol:** The standard implementation of a Form contract integrated with KYCDao's whitelist NFT. This Form interacts with a corresponding ERC4626 compliant vault.
16-
17-
**ERC4626TimelockForm.sol:** A variant of the standard Form contract that includes timelock functionality. This Form contract is used when time-based conditions need to be met during the deposit or withdrawal process. This Form requires a [TimelockRegistry](../crosschain-data/extensions/TimelockStateRegistry.sol) to execute redemption at a later time through the processUnlock() function.
15+
**ERC5115Form.sol:** This Form interacts with a corresponding ERC5115 compliant vault.

0 commit comments

Comments
 (0)