๐Ÿ”งContract Interfaces

Function-level reference for integrating with SIR Protocol contracts.

This section documents the public and external functions of SIR Protocol's core contracts. It is intended for developers building on top of the protocol โ€” bots, aggregators, frontends, and other integrations.

For deployed contract addresses, see Deployments.

circle-info

The core contracts are deployed on Ethereum, HyperEVM, and MegaETH. Function signatures are nearly identical across chains, but there are meaningful differences noted on each page. Always verify against the deployment you are targeting.

Contract Pages

Contract
Description

Main entry point for minting and burning APE/TEA tokens

SIR token, staking for dividends, reward claiming, and fee auctions

TWAP price feed interface

LP token (ERC1155) and leveraged token (ERC20) interfaces

Key Structs

These structs appear throughout the contract interfaces.

VaultParameters

Identifies a specific vault. Used as input to most Vault functions.

struct VaultParameters {
    address debtToken;
    address collateralToken;
    int8 leverageTier;       // Range: -2 to +2
}

Reserves

Collateral reserves held by a vault, returned by getReserves().

VaultState

On-chain storage representation of a vault's state.

Fees

Fee breakdown returned during mint/burn operations.

Auction

State of a fee auction.

Last updated