Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .changeset/brown-icons-push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@layerzerolabs/hyperliquid-composer": patch
"@layerzerolabs/oft-hyperliquid-example": patch
---

rename FeeAbstraction to PreFundedFeeAbstraction in docs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ const deploy: DeployFunction = async (hre) => {
{
type: 'confirm',
name: 'continueAnyway',
message: 'Do you want to continue with FeeAbstraction anyway?',
message: 'Do you want to continue with PreFundedFeeAbstraction anyway?',
default: false,
},
])
Expand Down Expand Up @@ -136,7 +136,7 @@ const deploy: DeployFunction = async (hre) => {
console.log(`Deplying a contract uses big block which is mined at a transaction per minute.`)
}

// Deploy the OFT composer with FeeAbstraction extension
// Deploy the OFT composer with PreFundedFeeAbstraction extension
const { address: address_composer } = await deploy(contractName_composer, {
from: deployer,
args: [
Expand All @@ -152,7 +152,7 @@ const deploy: DeployFunction = async (hre) => {
})

console.log(
`Deployed HyperliquidComposer with FeeAbstraction: ${contractName_composer}, network: ${hre.network.name}, address: ${address_composer}`
`Deployed HyperliquidComposer with PreFundedFeeAbstraction: ${contractName_composer}, network: ${hre.network.name}, address: ${address_composer}`
)
console.log(` - Spot ID: ${spotId}`)
console.log(
Expand Down
8 changes: 4 additions & 4 deletions examples/oft-hyperliquid/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions packages/hyperliquid-composer/HYPERLIQUID.README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ npx @layerzerolabs/hyperliquid-composer list-quote-asset \
If you're deploying a quote asset token (or plan to make it one):

- **Use `MyHyperLiquidComposer_FeeToken`** - This composer variant provides automatic user activation using the token itself as the fee token
- Regular composers (`MyHyperliquidComposer`, `FeeAbstraction`, `Recoverable`) will work but require users to have HYPE for gas fees
- Regular composers (`MyHyperliquidComposer`, `PreFundedFeeAbstraction`, `Recoverable`) will work but require users to have HYPE for gas fees

The deployment scripts automatically check if your token is a quote asset and guide you to use the appropriate composer type.

Expand Down Expand Up @@ -396,7 +396,7 @@ When the composer detects that a user's address has not been activated on HyperC
On-chain deployments:
USDT0 : [0x80123Ab57c9bc0C452d6c18F92A653a4ee2e7585](https://hyperevmscan.io/address/0x80123Ab57c9bc0C452d6c18F92A653a4ee2e7585)

#### FeeAbstraction Extension
#### PreFundedFeeAbstraction Extension

This extension provides automatic user activation using a **different token** for fees, combined with price oracle integration for dynamic fee calculation.

Expand Down Expand Up @@ -438,12 +438,12 @@ ENA : [0x5879d9821909A41cd3A382A990A4A5A6Ca77F2f0](https://hyperevmscan.io/addre

### Choosing the Right Composer

| Composer Type | Best For | Key Feature |
| ------------------ | --------------------- | --------------------------------------------- |
| **Regular** | Standard tokens | Basic functionality, no extensions |
| **Recoverable** | Any token | Token recovery capability |
| **FeeToken** | **Quote assets only** | Automatic activation using your token |
| **FeeAbstraction** | Non-quote assets | Automatic activation using oracle-priced fees |
| Composer Type | Best For | Key Feature |
| --------------------------- | --------------------- | --------------------------------------------- |
| **Regular** | Standard tokens | Basic functionality, no extensions |
| **Recoverable** | Any token | Token recovery capability |
| **FeeToken** | **Quote assets only** | Automatic activation using your token |
| **PreFundedFeeAbstraction** | Non-quote assets | Automatic activation using oracle-priced fees |

> ⚠️ **Important**: The deployment scripts automatically check if your token is a quote asset and guide you to use the appropriate composer type. See [Quote Assets (Fee Tokens)](#quote-assets-fee-tokens) for more details.

Expand Down
Loading