WOO Network

https://github.com/woonetwork/docs
Admin
WOOFi provides documentation for developers building on or integrating with its platform, covering...
Tokens:18,414
Snippets:70
Trust Score:6.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Query Price and Swap Tokens using WOOFi CLI

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/rust-sdk.md

Examples demonstrating how to query prices for a token pair (SOL/USDC) and perform a token swap (USDC to SOL) using the WOOFi command-line interface. The swap example shows a transaction of 0.1 USDC to SOL.

```Bash
./woofi-cli try-query SOL USDC 1000000000
./woofi-cli swap USDC SOL 100000 9000
```

--------------------------------

### Install and Build WOOFi TypeScript SDK

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/typescript-sdk.md

This snippet provides the commands to install dependencies and build the WOOFi TypeScript SDK project using Yarn. Running these commands prepares the SDK for local development, testing, and integration into other applications.

```bash
yarn
yarn build
```

--------------------------------

### Displaying Node.js Global Modules Path

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/architecture.md

This snippet demonstrates how to retrieve the `NODE_PATH` environment variable, which is crucial for ensuring Node.js can locate globally installed modules. This setup is necessary for local testing with Anchor and the Typescript SDK.

```Shell
$ echo $NODE_PATH
/Users/<home_dir>/.nvm/versions/node/v18.20.4/lib/node_modules
```

--------------------------------

### Example WOOFi Swap Transaction Output

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/rust-sdk.md

Illustrative output from a successful WOOFi swap transaction. This log shows the transaction signature, a link to view on an explorer, program invocation details, and compute unit consumption, confirming the on-chain execution.

```Log
transaction sent, signature:63AasGTbMBQgHj9RdJ9kz5F7ZxQ9Q7nKBDoR2qHs5d6rjCC2s2tyepa6S2gDv9M5GUG4KVkNqPbDDqDsctWwA7PG
please view on explorer
Program WooFiGFK9x5FBYdvMg3pJBpAkPA8EEYiLcopwrxJvDG invoke [1]
Program log: Instruction: Swap
Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA invoke [2]
Program log: Instruction: Transfer
Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA consumed 4645 of 168578 compute units
...
```

--------------------------------

### Solidity Example: Interacting with WOOFi Pool for Swaps

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-liquidity-source.md

This Solidity sample demonstrates how to programmatically interact with the `IWooPPV2` smart contract. It shows how to query a potential swap amount using `wooPool.query` (or `tryQuery`) and then execute the swap using `wooPool.swap`, including handling token transfers and specifying minimum received amounts.

```Solidity
    IWooPPV2 public wooPool; // IWooPPV2 smart contrac
    
    function sampleFunc(...) external {
        ... your business code ..

        // query the trade
        address fromToken = WBTC_ADDR;
        address toToken = USDT_ADDR;
        uint256 amountIn = 10000000; // 0.1 btc
        
        uint256 amountOut = wooPool.query(fromToken, toToken, amountIn);
        // or wooPool.tryQuery if you don't need the swap.
 
        // swap
        IERC20(toToken).safeTransfer(address(wooPool), amountIn);
        uint256 realToAmount = wooPool.swap(
            fromToken,
            toToken,
            amountIn,
            amountOut * 99 / 100, 
            address(this),
            address(0)
        );
        
        ... other business code to deal with `toToken` ...
    }
```

--------------------------------

### Solidity Example: Querying Swap Amounts with WooRouter

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-liquidity-source.md

This Solidity code demonstrates how to use the `querySwap` and `tryQuerySwap` functions of the WooRouter contract. It shows how to specify input tokens and amounts to retrieve predicted output amounts, illustrating the difference in behavior between the two query methods regarding liquidity checks.

```Solidity
// Query Part
address fromToken = 0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f;  // wbtc
address toToken = 0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8;    // usdc
uint256 amount1 = wooRouter.querySwap(
  fromToken, 
  toToken,
  100000000  // 1 wbtc amount in decimal 8
)

uint256 amount2 = wooRouter.tryQuerySwap(
  fromToken,
  toToken,
  100000000); // 1 wbtc amount in decimal 8

// NOTE: when the balance reserve is enough for swap, amount1 = amount2;
// otherwise, amount2 is still calculated based on wooracle price and woo market-making
// formula, but the amount1 qeury simply failed with insufficient balance error.
```

--------------------------------

### Claim Rebates from WooRebateManager Contract

Source: https://github.com/woonetwork/docs/blob/main/guides/become-a-woofi-broker.md

This guide details the process of claiming pending rebates by interacting with the `claimRebate` function of the `WooRebateManager` smart contract via a blockchain explorer, requiring a connected and signed whitelisted address.

```APIDOC
WooRebateManager Contract Interaction:
  Function: claimRebate
    Description: Initiates a transaction to claim pending rebates.
    Parameters: None (implicitly uses the connected whitelisted address)
    Returns: Transaction confirmation
    Usage:
      1. Navigate to WooRebateManager contract on blockchain explorer.
      2. Go to 'Write Contract' tab.
      3. Connect to web3 with your whitelisted rebate address.
      4. Find 'claimRebate' function.
      5. Click 'Write' and sign the transaction in your wallet.
```

--------------------------------

### Solidity Example: Executing a Token Swap with WooRouter

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-liquidity-source.md

This Solidity code snippet illustrates the complete process of performing a token swap using the `swap` function of the WooRouter contract. It includes the necessary step of approving the `fromToken` for transfer by the router, followed by the actual swap call with all required parameters such as minimum output amount and recipient addresses.

```Solidity
// Swap Part
uint256 amountIn = 100000000;
IERC20(fromToken).safeApprove(address(wooRouter), amountIn);
uint256 realToAmount = wooRouter.swap(
  fromToken,      // wbtc token address
  toToken,        // usdc token address
  amountIn,       // wbtc amount to swap in decimal 8
  19000000000,    // min amount = 19000 usdc (price: 19500)
  address(this),  // the address to receive the swap fund
  address(0)      // the rebateTo address
);
```

--------------------------------

### Query WooracleV2 Price using Python Web3.py

Source: https://github.com/woonetwork/docs/blob/main/resources/on-chain-price-feeds.md

This Python example demonstrates how to query the WooracleV2 smart contract's `price` function using the `web3.py` library. It shows how to establish a connection to an Ethereum-compatible blockchain, load a minimal ABI for the `price` function, instantiate the contract, and then call the `price` function for a specific token (WOO/USDT pair in this case). The function returns a list containing `priceNow` (a large integer representing the price with 8 decimals) and `feasible` (a boolean indicating if the price is available). An example response is `[181915000000000000, True]`.

```Python
import web3
import json

web3_provider = f'your-web3-provider'

w3 = web3.Web3(web3.Web3.HTTPProvider(web3_provider))
abi_str = '[{"inputs": [{"internalType": "address","name": "base","type": "address"}],"name": "price","outputs": [{"internalType": "uint256","name": "priceNow","type": "uint256"},{"internalType": "bool","name": "feasible","type": "bool"}],"stateMutability": "view","type": "function"}]'
abi = json.loads(abi_str)
oracle_addr = '0x962d37fb9d75fe1af9aab323727183e4eae1322d'
contract = w3.eth.contract(address=oracle_addr, abi=abi)

# query WOO/USDT pair quoting price 
woo_addr = '0xcAFcD85D8ca7Ad1e1C6F82F651fA15E33AEfD07b'
result = contract.functions.price(woo_addr).call()
# Example response: [181915000000000000, True]
# print(result)
```

--------------------------------

### Check Pending Rebates on WooRebateManager Contract

Source: https://github.com/woonetwork/docs/blob/main/guides/become-a-woofi-broker.md

This guide outlines the steps to query the `pendingRebate` function of the `WooRebateManager` smart contract using a blockchain explorer to determine the amount of claimable rebates for a whitelisted address.

```APIDOC
WooRebateManager Contract Interaction:
  Function: pendingRebate
    Description: Queries the amount of claimable rebates for a specific address.
    Parameters:
      whitelisted_rebate_address: string (Your whitelisted address)
    Returns:
      amount: number (Current amount of claimable rebates in the quote token)
    Usage:
      1. Navigate to WooRebateManager contract on blockchain explorer.
      2. Go to 'Read Contract' tab.
      3. Find 'pendingRebate' function.
      4. Input 'whitelisted_rebate_address'.
      5. Click 'Query'.
```

--------------------------------

### Retrieve Source-Specific Swap Statistics (GET /source_stat)

Source: https://github.com/woonetwork/docs/blob/main/references/apis/swap.md

This endpoint provides swap statistics broken down by source. It supports specific networks and time periods, similar to the general statistics endpoint. The response includes source ID, name, volume, transaction count, and percentage contribution.

```APIDOC
Endpoint: GET /source_stat

Parameters:
  network: String (optional)
    Description: Blockchain network.
    Default: `''` (empty string)
    Options: `bsc`, `avax`, `fantom`, `polygon`
  period: String (optional)
    Description: Time aggregation period.
    Options: `1d`, `1w`, `1m`, `3m`, `1y`, `all`
    Default: `1m`

Returns:
  id: String
    Description: Source identifier.
  name: String
    Description: Name of the source.
  volume_usd: String
    Description: Source volume (value multiplied by 10^18) in USD.
  txs: Integer
    Description: Number of trades from the source.
  percentage: Decimal
    Description: Percentage contribution to the total (for pie chart).
```

--------------------------------

### Retrieve General Swap Statistics (GET /stat)

Source: https://github.com/woonetwork/docs/blob/main/references/apis/swap.md

This endpoint allows fetching general swap statistics based on network and time period. It supports various networks like BSC, Avalanche, Fantom, Polygon, Arbitrum, and Optimism. The returned data structure varies depending on the specified 'period', providing hourly or daily aggregates.

```APIDOC
Endpoint: GET /stat

Parameters:
  network: String (required)
    Description: Blockchain network.
    Options: `bsc`, `avax`, `fantom`, `polygon`, `arbitrum`, `optimism`
  period: String (optional)
    Description: Time aggregation period.
    Options: `1d`, `1w`, `1m`, `3m`, `1y`, `all`
    Default: `1m`

Returns (when period = '1d'):
  id: String
    Description: `timestamp / 3600` rounded down.
  timestamp: String
    Description: Timestamp on the hour.
  volume_usd: String
    Description: Hourly volume (value multiplied by 10^18) in USD.
  traders: String
    Description: Hourly number of unique addresses.
  txs: String
    Description: Hourly number of trades.

Returns (when period = '1w', '1m', '3m', '1y', 'all'):
  id: String
    Description: `timestamp / 86400` rounded down.
  timestamp: String
    Description: UTC 0 timestamp.
  volume_usd: String
    Description: Daily volume (value multiplied by 10^18) in USD.
  traders: String
    Description: Daily number of unique addresses.
  txs: String
    Description: Daily number of trades.
  turnover_rate_percentage: Decimal
    Description: Daily turnover rate in percentage.
```

--------------------------------

### Build WOOFi Rust SDK

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/rust-sdk.md

Command to compile the WOOFi Swap Rust SDK. This prepares the SDK's executable for local use and testing.

```Bash
cargo build
```

--------------------------------

### Retrieve Staking Information (GET /stakingv2)

Source: https://github.com/woonetwork/docs/blob/main/references/apis/earn-and-stake.md

This API endpoint allows users to retrieve general staking information, including the average and base APRs for all stakers. It returns a JSON object with float values for APRs.

```APIDOC
GET /stakingv2

Returns:
  avg_apr: float - Average APR of all stakers
  base_apr: float - Base apr based on the user's staked WOO only
```

--------------------------------

### WOOFi CLI with Custom RPC URL and Payer Key

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/rust-sdk.md

Commands to query prices and swap tokens using the WOOFi CLI, allowing specification of a custom Solana RPC URL and a custom payer key path. This overrides the default mainnet RPC and `~/.config/solana/id.json` for more flexible testing or deployment environments.

```Bash
./woofi-cli try-query SOL USDC 1000000000 --http-url https://api.mainnet-beta.solana.com --payer-path ~/.config/solana/id.json
./woofi-cli swap USDC SOL 100000 9000 --http-url https://api.mainnet-beta.solana.com --payer-path ~/.config/solana/id.json
```

--------------------------------

### Retrieve Earn Yield Information (GET /yield)

Source: https://github.com/woonetwork/docs/blob/main/references/apis/earn-and-stake.md

This API endpoint provides detailed information about earn yield, including total deposits and auto-compounding details. It supports filtering by network and returns a JSON object with various metrics like APY, TVL, and token details.

```APIDOC
GET /yield

Params:
  network: String - option: `bsc` / `avax` / `polygon` / `arbitrum` / `optimism` / `zksync` / `base` / `mantle`

Returns:
  total_deposit: String - total deposited (value multiplied by`10^<decimals>`)(unit:USD)
  auto_compounding: Object - `auto-compounded`yield aggregator

Auto-Compounding Returns:
  <Vault Address>: Object - deposited token's `vault_address`

Auto-Compounding Symbol Returns:
  symbol: String - target token`symbol`
  source: String - target farm(lowercase)
  apy: Decimal - auto-compounded APR(unit: `%`)
  tvl: String - total deposit of single pool(value multiplied by`10^<decimals>`)(unit:USD)
  price: Decimal - `USD price of symbol`
  share_price: String - net asset value per share
  decimals: Integer - `symbol decimals`, for `tvl calculation`
```

--------------------------------

### WooRouter Contract Interface Definition

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-liquidity-source.md

This Solidity interface defines the external functions available on the WooRouter contract. It includes methods for querying potential swap amounts (`querySwap`, `tryQuerySwap`) and for executing token swaps (`swap`), specifying their parameters, return types, and visibility. This serves as the API specification for interacting with the router.

```Solidity
    /// @dev query the amount to swap fromToken -> toToken
    /// @param fromToken the from token
    /// @param toToken the to token
    /// @param fromAmount the amount of fromToken to swap
    /// @return toAmount the predicted amount to receive
    function querySwap(
        address fromToken,
        address toToken,
        uint256 fromAmount
    ) external view returns (uint256 toAmount);
    
    /// @dev query the amount to swap fromToken -> toToken,
    ///      WITHOUT checking the reserve balance; so it
    ///      always returns the quoted amount (for reference).
    /// @param fromToken the from token
    /// @param toToken the to token
    /// @param fromAmount the amount of fromToken to swap
    /// @return toAmount the predicted amount to receive
    function tryQuerySwap(
        address fromToken,
        address toToken,
        uint256 fromAmount
    ) external view returns (uint256 toAmount);
    
    /// @notice Swap `fromToken` to `toToken`.
    /// @param fromToken the from token
    /// @param toToken the to token
    /// @param fromAmount the amount of `fromToken` to swap
    /// @param minToAmount the minimum amount of `toToken` to receive
    /// @param to the destination address
    /// @param rebateTo the rebate address (optional, can be 0)
    /// @return realToAmount the amount of toToken to receive
    function swap(
        address fromToken,
        address toToken,
        uint256 fromAmount,
        uint256 minToAmount,
        address payable to,
        address rebateTo
    ) external payable returns (uint256 realToAmount);
```

--------------------------------

### Solidity Interface for WOOFi Pool V2 (IWooPPV2)

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-liquidity-source.md

This Solidity interface defines the essential functions for interacting with the WOOFi liquidity pool. It includes methods to retrieve the quote token address, check the pool size for a specific token, query potential swap amounts with or without balance checks, and execute token swaps with specified parameters and minimum received amounts.

```Solidity
    /// @notice The quote token address (immutable).
    /// @return address of quote token
    function quoteToken() external view returns (address);

    /// @notice Gets the pool size of the specified token (swap liquidity).
    /// @param token the token address
    /// @return the pool size
    function poolSize(address token) external view returns (uint256);

    /// @notice Query the amount to swap `fromToken` to `toToken`, without checking the pool reserve balance.
    /// @param fromToken the from token
    /// @param toToken the to token
    /// @param fromAmount the amount of `fromToken` to swap
    /// @return toAmount the swapped amount of `toToken`
    function tryQuery(
        address fromToken,
        address toToken,
        uint256 fromAmount
    ) external view returns (uint256 toAmount);

    /// @notice Query the amount to swap `fromToken` to `toToken`, with checking the pool reserve balance.
    /// @dev tx reverts when 'toToken' balance is insufficient.
    /// @param fromToken the from token
    /// @param toToken the to token
    /// @param fromAmount the amount of `fromToken` to swap
    /// @return toAmount the swapped amount of `toToken`
    function query(
        address fromToken,
        address toToken,
        uint256 fromAmount
    ) external view returns (uint256 toAmount);

    /// @notice Swap `fromToken` to `toToken`.
    /// @param fromToken the from token
    /// @param toToken the to token
    /// @param fromAmount the amount of `fromToken` to swap
    /// @param minToAmount the minimum amount of `toToken` to receive
    /// @param to the destination address
    /// @param rebateTo the rebate address (optional, can be address ZERO)
    /// @return realToAmount the amount of toToken to receive
    function swap(
        address fromToken,
        address toToken,
        uint256 fromAmount,
        uint256 minToAmount,
        address to,
        address rebateTo
    ) external returns (uint256 realToAmount);
```

--------------------------------

### Generate WOOFi TypeScript SDK TypeDoc

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/typescript-sdk.md

This command generates comprehensive API documentation for the WOOFi TypeScript SDK using TypeDoc. The output documentation, which includes details on classes, methods, and types, can be found in the `docs` folder, providing a clear reference for developers.

```bash
yarn run docs
```

--------------------------------

### Retrieve Supported Tokens from IntegrationHelper.sol

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-liquidity-source.md

Describes the `getSupportTokens()` function available on the `IntegrationHelper.sol` contract. This function allows integrators to programmatically retrieve the address of the quote token and a list of all tradable base token addresses supported by `WooPPV2.sol` on a given chain.

```APIDOC
IntegrationHelper.sol:
  getSupportTokens():
    Returns:
      - first value: quoteToken address
      - second value: array of baseToken addresses
```

--------------------------------

### Run WOOFi TypeScript SDK Tests

Source: https://github.com/woonetwork/docs/blob/main/guides/integrate-woofi-as-a-liquidity-source-on-solana/typescript-sdk.md

This command executes the test suite for the WOOFi TypeScript SDK against a local validator. It is used to verify the SDK's functionality, ensure correct interactions with the sPMM contract, and validate any changes made to the codebase.

```bash
yarn test
```

--------------------------------

### WOO Network Base Contracts - Swap

Source: https://github.com/woonetwork/docs/blob/main/references/readme/base.md

Lists the deployed contract addresses and their corresponding contract names for core swap functionalities within the WOO Network, including routers, price pools, oracles, and integration helpers.

```APIDOC
Swap Contracts:
  0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7: WooRouterV2
  0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c: CrossswapRouterv5
  0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4: WooPPV2.2
  0x2A375567f5E13F6bd74fDa7627Df3b1Af6BfA5a6: WooracleV2.1
  0xC4E9B633685461E7B7A807D12a246C81f96F31B8: IntegrationHelper(token info)
  0xF3df0A31ec5EA438150987805e841F960b9471b6: WOO OFT
```

--------------------------------

### WOO Network Base Contracts - Pro

Source: https://github.com/woonetwork/docs/blob/main/references/readme/base.md

Lists the deployed contract addresses and their corresponding contract names for professional trading and administrative functionalities, including cross-chain routing and proxy administration.

```APIDOC
Pro Contracts:
  0xac8951A442fe70342f9597044B7b7657D5ad55ec: ProCrossChainRouter
  0x3933CA6058E3549bbf25BA71901b82C11916EC16: ProxyAdmin
  0x88A19967013CA274c296bFA433eb1BAc4D47B0dc: NonceCounter
```

--------------------------------

### OP Mainnet Swap Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/op-mainnet.md

Lists the contract addresses and their corresponding names for core swap functionalities on the Optimism mainnet, including routers, price feeds, and integration helpers.

```APIDOC
0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7: WooRouterV2
0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c: CrosswapRouter v5
0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4: WooPPV2.2
0xA43305Ce0164D87d7B2368f91a1dcC4eBdA75127: WooracleV2.2
0x96329d66074EB8386Ae8bFD6698B2E3FDA87e15E: IntegrationHelper (token info)
```

--------------------------------

### Solana WOOFi Swap Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/solana.md

Lists the key contract addresses for the WOOFi Swap program and associated oracles on the Solana blockchain. This includes the main WOOFi Program, the SOL Wooracle, and the USDC Wooracle, which are crucial for facilitating token swaps.

```APIDOC
Contract Addresses (Swap):
  WooFi Program: WooFif76YGRNjk1pA8wCsN67aQsD9f9iLsz4NcJ1AVb
  SOL Wooracle: mjkf7dn23RrwPphKvqze2dJcTUAXnXRBSS51qGGLB4Y
  USDC Wooracle: Dk1BiYeDuM4PPQDiNNnqaiiKHPEZ65DJSVjdcSwKt4aU
```

--------------------------------

### WOO Network Sonic: Swap Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/sonic.md

Lists the deployed contract addresses and their corresponding contract names essential for the swap functionality on the WOO Network's Sonic platform. This includes the router, price provider, oracle, and helper contracts.

```APIDOC
Address                                    Contract
0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7 WooRouterV2
0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4 WooPPV2
0x2A375567f5E13F6bd74fDa7627Df3b1Af6BfA5a6 WooracleV2.1
0xc8521e41DE46036A61c562062862681f0060CD7E IntegrationHelper (token info)
0xF3df0A31ec5EA438150987805e841F960b9471b6 WooOFT
```

--------------------------------

### Ethereum Swap Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/ethereum.md

Lists the Ethereum contract addresses and their corresponding contract names related to swap functionalities within the WOO Network ecosystem.

```APIDOC
Contract Addresses for Swap:
  WooRouter: 0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7
  CrossswapRouterV5: 0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c
  WooOFTAdapter: 0xAd6cA80Fe4D3c54f6433fF725d744772AaE87711
```

--------------------------------

### WOO Network Base Contracts - Peripheries

Source: https://github.com/woonetwork/docs/blob/main/references/readme/base.md

Lists the deployed contract addresses and their corresponding contract names for peripheral functionalities like fee management, rebate management, and access control within the WOO Network.

```APIDOC
Peripheries Contracts:
  0xc45B55032caFeaff3b8057d52758D8f8211DA54D: WooFeeManager
  0x7616614084e040028D6a61c0f3A9699c121A6500: WooRebateManager
  0xAf558f888e138CA9416111Ec7aE8e28354Cd9239: WooAccessManager
```

--------------------------------

### WOOFi Rebate Manager Smart Contract Addresses (Current)

Source: https://github.com/woonetwork/docs/blob/main/guides/become-a-woofi-broker.md

These are the current smart contract addresses for the WOOFi Rebate Manager, used by whitelisted brokers to check and claim their daily processed rebates across various blockchain networks.

```APIDOC
Same address across Arbitrum, Avalanche, BSC, Optimism, Polygon PoS, Ethereum, Linea, Base, Mantle, Sonic: 0x7616614084e040028D6a61c0f3A9699c121A6500
zkSync Era: 0x66C9467eC052Fb258e24DcCe87E93A0002966014
```

--------------------------------

### WooracleV2 Smart Contract Interface Definition

Source: https://github.com/woonetwork/docs/blob/main/resources/on-chain-price-feeds.md

This Solidity interface defines the public functions available on the WooracleV2 smart contract. It includes functions to retrieve Chainlink prices (`cloPrice`), Wooracle's self-posted prices (`woPrice`), a composite price that falls back to Chainlink if Wooracle's is unavailable (`price`), and the detailed state of a token within Wooracle (`state`). These functions are crucial for interacting with the on-chain price feed from other smart contracts or off-chain applications.

```Solidity
    /**
     * @notice Returns the ChainLink price of the base token / quote token
     * @param the base token address
     * @return the Chainlink price and the price's last-update timestamp
     */
    function cloPrice(address base) external view returns (uint256 price, uint256 timestamp);

    /**
     * @notice Returns the Woo self-posted price of the base token / quote token
     * @param the base token address
     * @return the Wooracle price and the price's last-update timestamp
     */
    function woPrice(address base) external view returns (uint128 price, uint256 timestamp);

    /**
     * @notice Returns the Woo self-posted price if available, otherwise fallback to ChainLink's price.
     * @dev the price is in base token / quote token, and decimal is same as the chainlink
     *   price decimal
     * @param the base token address
     * @return the compositive price and the flag indicating the price is available or not.
     */
    function price(address base) external view returns (uint256 priceNow, bool feasible);

    /**
     * Returns the detailed state of the current base token in Wooracle.
     *
     * struct State {
     *   uint128 price;
     *   uint64 spread;
     *   uint64 coeff;
     *   bool woFeasible;
     * }
     *
     * @param the base token address
     * @return the state
     */
    function state(address base) external view returns (State memory);
```

--------------------------------

### Ethereum Pro Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/ethereum.md

Provides the Ethereum contract addresses and their corresponding contract names for professional trading features on the WOO Network.

```APIDOC
Contract Addresses for Pro:
  ProCrossChainRouter: 0xac8951A442fe70342f9597044B7b7657D5ad55ec
  ProxyAdmin: 0x3933CA6058E3549bbf25BA71901b82C11916EC16
  NonceCounter: 0x88A19967013CA274c296bFA433eb1BAc4D47B0dc
```

--------------------------------

### Avalanche C-chain Pro Contracts

Source: https://github.com/woonetwork/docs/blob/main/references/readme/avalanche-c-chain.md

Lists the contract addresses and names related to Pro functionalities on the Avalanche C-chain, including cross-chain routing, proxy administration, and nonce management.

```APIDOC
ProCrossChainRouter: 0xac8951A442fe70342f9597044B7b7657D5ad55ec
ProxyAdmin: 0x3933CA6058E3549bbf25BA71901b82C11916EC16
NonceCounter: 0x88A19967013CA274c296bFA433eb1BAc4D47B0dc
```

--------------------------------

### Polygon PoS Swap Contracts

Source: https://github.com/woonetwork/docs/blob/main/references/readme/polygon-pos.md

Lists the contract addresses and their corresponding names for swap-related functionalities on the Polygon PoS network, including routers, price feeds, and helper contracts.

```APIDOC
Address                               Contract
0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7 WooRouterV2
0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c CrosswapRouterV5
0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4 WooPPv2
0x2A8Ede62D0717C8C92b88639ecf603FDF31A8428 WooracleV2.2
0x7Ba560eB735AbDCf9a3a5692272652A0cc81850d IntegrationHelper (token info)
```

--------------------------------

### Mantle Swap Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/mantle.md

Lists the deployed contract addresses and their corresponding contract names for core swap functionalities on the Mantle network. This includes routers for token swaps, price feed oracles, and liquidity pool contracts.

```APIDOC
Address                                   Contract
0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7 WooRouterV2
0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c CrossswapRouterv5
0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4 WooPPV2
0x2A375567f5E13F6bd74fDa7627Df3b1Af6BfA5a6 WooracleV2.1
0x86b223E83D2FA43456b433687c8F47A35a9bE24C IntegrationHelper(token info)
0xF3df0A31ec5EA438150987805e841F960b9471b6 WooOFT
```

--------------------------------

### Swap Contracts on BNB Smart Chain

Source: https://github.com/woonetwork/docs/blob/main/references/readme/bnb-smart-chain.md

Provides a list of contract addresses and their corresponding names for various swap-related functionalities on the BNB Smart Chain, including routers, liquidity pools, oracles, and integration helpers.

```APIDOC
0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7: WooRouterV2
0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4: WooPPV2.2
0x2A375567f5E13F6bd74fDa7627Df3b1Af6BfA5a6: WooracleV2.1
0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c: CrossRouterv5
0xAA9c15cd603428cA8ddD45e933F8EfE3Afbcc173: IntegrationHelper (token info)
```

--------------------------------

### Avalanche C-chain Swap Contracts

Source: https://github.com/woonetwork/docs/blob/main/references/readme/avalanche-c-chain.md

Lists the contract addresses and their corresponding contract names used for swap functionalities on the Avalanche C-chain, including routers and price providers.

```APIDOC
WooRouterV2: 0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7
CrossswapRouterV5: 0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c
WooPPV2.2: 0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4
WooracleV2.1: 0x2A375567f5E13F6bd74fDa7627Df3b1Af6BfA5a6
IntegrationHelper (token info): 0x020630613E296c3E9b06186f630D1bF97A2B6Ad1
```

--------------------------------

### Solana WOOFi Periphery Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/solana.md

Details the contract addresses for peripheral components of the WOOFi ecosystem on Solana. This section includes addresses for the Woo OFT program, the WOO token itself, and the Woo authority, which are integral to the broader WOOFi functionality.

```APIDOC
Contract Addresses (Peripheries):
  Woo OFT program: woo98ny1QLULqdTzpNM8PiJpwfzL5MJ9pAmLw1rfvk7
  WOO token: Dz8VutERqbHR2aFL5A3s1Ky4dG1unJT1jUFXXPaY9ytX
  Woo authority: 8pvYwZhuSY2GdW6zZ3PennYnRCuGtdK3BzBkGRnQbpeN
```

--------------------------------

### Linea Swap Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/linea.md

Lists the contract addresses and their corresponding contract names for decentralized exchange (DEX) swap functionalities on the Linea network, including routers and core trading components.

```APIDOC
WooRouterV2: 0x4c4AF8DBc524681930a27b2F1Af5bcC8062E6fB7
CrossswapRouterv5: 0xB84aEfEF2DDDE628d5c7F1fba320dE63e3f4757c
WooPPV2: 0x5520385bFcf07Ec87C4c53A7d8d65595Dff69FA4
WooracleV2.1: 0x2A375567f5E13F6bd74fDa7627Df3b1Af6BfA5a6
IntegrationHelper(token info): 0x7e1996945eA8866DE873179DC1677E93A4380107
WooOFT: 0xF3df0A31ec5EA438150987805e841F960b9471b6
```

--------------------------------

### OP Mainnet Pro Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/op-mainnet.md

Lists contract addresses related to professional trading features on the Optimism mainnet, including cross-chain routing, deposit management, proxy administration, and nonce tracking.

```APIDOC
0xac8951A442fe70342f9597044B7b7657D5ad55ec: ProCrossChainRouter
0x4E21a65A9F4672EF2cdfb7FA6B0f1e39d6e4E50e: ProDepositor
0x3933CA6058E3549bbf25BA71901b82C11916EC16: ProxyAdmin
0x88A19967013CA274c296bFA433eb1BAc4D47B0dc: NonceCounter
```

--------------------------------

### WOOFi Rebate Manager Smart Contract Addresses (Deprecated)

Source: https://github.com/woonetwork/docs/blob/main/guides/become-a-woofi-broker.md

This table lists deprecated smart contract addresses for the WOOFi Rebate Manager across different blockchain networks. Brokers with unclaimed rebates in these older contracts are advised to check and claim them as soon as possible.

```APIDOC
Network | Deprecated rebate manager smart contract address
--- | ---
Arbitrum | 0x505ac728645d2ef84380961F72bAea500b3efa3f
Avalanche | 0xbF401edBb0265D037BfC89DfFeB7dbDa10b57C22
Avalanche | 0x49d26A6Eeeb49E79a0C73B95fD99D23698D3614A
BNB Chain | 0x0208D735576B3D974024237393F4617285bf0563
BNB Chain | 0x4f3e0B02F50937Bc21F523F1Dd430A34cAF4de98
BNB Chain | 0xce7CDc8e5C00796392E611D95C713420A6e31342
Fantom | 0x0D37e768c3eD8a3FA494d03AF69605C5bE9a68e4
Fantom | 0x6F09AE4925739453d7C8c9a22fD07585148DFc01
Polygon | 0x3d605fA64595Dba86f7780E128816ADAAeCA8A2b
Polygon | 0x913E116cD0E279763B0419798c0bA18F9311B390
Optimism | 0x36b680fB76Dad86bcB2Cefc83fAE05e3Fe147706
zkSync Era | 0x921A51ee71f769715866D2Ca43D8Ac57B196347a
Polygon zkEVM | 0xa2101FD320D06e0A744e4FE90ef8A20ECd027001
Linea | 0xa2101FD320D06e0A744e4FE90ef8A20ECd027001
Base | 0x7214833BE05Ce39f6dCd97668e521162e6C18937
Mantle | 0xb130a49065178465931d4f887056328CeA5D723f
```

--------------------------------

### zkSync Era Swap Contracts

Source: https://github.com/woonetwork/docs/blob/main/references/readme/zksync-era.md

This section lists the contract addresses and their corresponding names for WOO Network's core swap functionalities on the zkSync Era blockchain. These contracts facilitate token exchanges and related operations.

```APIDOC
0x09873bfECA34F1Acd0a7e55cDA591f05d8a75369: WooRouterV2
0xE656d70bc3550e3EEE9dE7dC79367A44Fd13d975: WooPPV2
0xAe45cBE2d1E90358CbD216bC16f2C9267a4EA80a: WooracleV2.1
0x636DfeB023463F176f87D61E3B604231986bd935: IntegrationHelper (token info)
0xF38583e662d3DC8bBE9ce791f06E1Dd46800AaaF: WooOFT
```

--------------------------------

### Pro-Related Contracts on BNB Smart Chain

Source: https://github.com/woonetwork/docs/blob/main/references/readme/bnb-smart-chain.md

Lists contract addresses and names for advanced or 'Pro' functionalities, including cross-chain routing, proxy administration, and nonce management, on the BNB Smart Chain.

```APIDOC
0xac8951A442fe70342f9597044B7b7657D5ad55ec: ProCrossChainRouter
0x3933CA6058E3549bbf25BA71901b82C11916EC16: ProxyAdmin
0x88A19967013CA274c296bFA433eb1BAc4D47B0dc: NonceCounter
```

--------------------------------

### OP Mainnet Earn Contract Addresses

Source: https://github.com/woonetwork/docs/blob/main/references/readme/op-mainnet.md

Details the contract addresses for various earning mechanisms on the Optimism mainnet, including vaults, lending managers, withdraw managers, farming vaults, and specific strategies for different assets like ETH, OP, and USDC.

```APIDOC
0xB54e1d90d845d888d39dcaCBd54a3EEc0d8853B2: SuperChargerVault_ETH
0x1dDd225ef26714Bb8055dDCEaEE2589ba09c89ed: LendingManager_ETH
0x91741863A48f0B29fC0B6D10b3cdE2122feB58f7: WithdrawManager_ETH
0x7e1996945eA8866DE873179DC1677E93A4380107: farmingvault_ETH
0x95360A64447Ca746B82ABd1D0ED49f3E34F2e6E9: AaveStrategy_ETH
0xc0f8C29e3a9A7650a3F642e467d70087819926d6: RewardMasterchef
0xcA7184eA1cb4cF04d49Bf219c49a39231299dA26: SuperChargerVault_OP
0xD2635bc7e4E4F63B2892eD80D0b0f9Dff7eDA899: LendingManager_OP
0x0FAd8f10746171C0616cE4B7B4E2e9439a9a02E2: WithdrawManager_OP
0xa8452E2d63B29783ED2E5ca0d8D4Fe0cC2161D5B: farmingvault_OP
0xDa4B53F75921C109fED0ffd8AD9f22430B4c3438: voidstrategy_OP
0x18aa88bb25b8f15FDbE329f789dD000bf679753E: SuperChargerVault_USDC
0x4bAa5Fd82A455f2BfEFF4FBB91969288D7DE7316: LendingManager_USDC
0x2500AD59b46fF4B96f8e1EaC3fE1f78eAF955777: WithdrawManager_USDC
0x73504eaCB100c7576146618DC306c97454CB3620: USDC_VaultV2
0xfD7ed9D3d4fD88595AF6a87f798ffDB42b4D7ccB: USDC_StrategyAave
```
Tokens:
Raw