Interface SYBase

interface SYBase {
    _deployedPromise: Promise<Contract>;
    _runningEvents: {
        [eventTag: string]: RunningEvent;
    };
    _wrappedEmits: {
        [eventTag: string]: ((...args) => void);
    };
    address: string;
    callStatic: {
        DOMAIN_SEPARATOR(overrides?): Promise<string>;
        accruedRewards(arg0, overrides?): Promise<BN[]>;
        allowance(owner, spender, overrides?): Promise<BN>;
        approve(spender, amount, overrides?): Promise<boolean>;
        assetInfo(overrides?): Promise<[number, string, number] & {
            assetAddress: string;
            assetDecimals: number;
            assetType: number;
        }>;
        balanceOf(account, overrides?): Promise<BN>;
        claimOwnership(overrides?): Promise<void>;
        claimRewards(arg0, overrides?): Promise<BN[]>;
        decimals(overrides?): Promise<number>;
        deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<BN>;
        eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
            chainId: BN;
            extensions: BN[];
            fields: string;
            name: string;
            salt: string;
            verifyingContract: string;
            version: string;
        }>;
        exchangeRate(overrides?): Promise<BN>;
        getRewardTokens(overrides?): Promise<string[]>;
        getTokensIn(overrides?): Promise<string[]>;
        getTokensOut(overrides?): Promise<string[]>;
        isValidTokenIn(token, overrides?): Promise<boolean>;
        isValidTokenOut(token, overrides?): Promise<boolean>;
        name(overrides?): Promise<string>;
        nonces(owner, overrides?): Promise<BN>;
        owner(overrides?): Promise<string>;
        pause(overrides?): Promise<void>;
        paused(overrides?): Promise<boolean>;
        pendingOwner(overrides?): Promise<string>;
        permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<void>;
        previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>;
        previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>;
        redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<BN>;
        rewardIndexesCurrent(overrides?): Promise<BN[]>;
        rewardIndexesStored(overrides?): Promise<BN[]>;
        symbol(overrides?): Promise<string>;
        totalSupply(overrides?): Promise<BN>;
        transfer(to, amount, overrides?): Promise<boolean>;
        transferFrom(from, to, amount, overrides?): Promise<boolean>;
        transferOwnership(newOwner, direct, renounce, overrides?): Promise<void>;
        unpause(overrides?): Promise<void>;
        yieldToken(overrides?): Promise<string>;
    };
    contractName: "SYBase";
    deployTransaction: TransactionResponse;
    estimateGas: {
        DOMAIN_SEPARATOR(overrides?): Promise<BN>;
        accruedRewards(arg0, overrides?): Promise<BN>;
        allowance(owner, spender, overrides?): Promise<BN>;
        approve(spender, amount, overrides?): Promise<BN>;
        assetInfo(overrides?): Promise<BN>;
        balanceOf(account, overrides?): Promise<BN>;
        claimOwnership(overrides?): Promise<BN>;
        claimRewards(arg0, overrides?): Promise<BN>;
        decimals(overrides?): Promise<BN>;
        deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<BN>;
        eip712Domain(overrides?): Promise<BN>;
        exchangeRate(overrides?): Promise<BN>;
        getRewardTokens(overrides?): Promise<BN>;
        getTokensIn(overrides?): Promise<BN>;
        getTokensOut(overrides?): Promise<BN>;
        isValidTokenIn(token, overrides?): Promise<BN>;
        isValidTokenOut(token, overrides?): Promise<BN>;
        name(overrides?): Promise<BN>;
        nonces(owner, overrides?): Promise<BN>;
        owner(overrides?): Promise<BN>;
        pause(overrides?): Promise<BN>;
        paused(overrides?): Promise<BN>;
        pendingOwner(overrides?): Promise<BN>;
        permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<BN>;
        previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>;
        previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>;
        redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<BN>;
        rewardIndexesCurrent(overrides?): Promise<BN>;
        rewardIndexesStored(overrides?): Promise<BN>;
        symbol(overrides?): Promise<BN>;
        totalSupply(overrides?): Promise<BN>;
        transfer(to, amount, overrides?): Promise<BN>;
        transferFrom(from, to, amount, overrides?): Promise<BN>;
        transferOwnership(newOwner, direct, renounce, overrides?): Promise<BN>;
        unpause(overrides?): Promise<BN>;
        yieldToken(overrides?): Promise<BN>;
    };
    filters: {
        Approval(owner?, spender?, value?): ApprovalEventFilter;
        Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter;
        ClaimRewards(user?, rewardTokens?, rewardAmounts?): ClaimRewardsEventFilter;
        ClaimRewards(address,address[],uint256[])(user?, rewardTokens?, rewardAmounts?): ClaimRewardsEventFilter;
        Deposit(caller?, receiver?, tokenIn?, amountDeposited?, amountSyOut?): DepositEventFilter;
        Deposit(address,address,address,uint256,uint256)(caller?, receiver?, tokenIn?, amountDeposited?, amountSyOut?): DepositEventFilter;
        EIP712DomainChanged(): EIP712DomainChangedEventFilter;
        EIP712DomainChanged()(): EIP712DomainChangedEventFilter;
        Initialized(version?): InitializedEventFilter;
        Initialized(uint8)(version?): InitializedEventFilter;
        OwnershipTransferred(previousOwner?, newOwner?): OwnershipTransferredEventFilter;
        OwnershipTransferred(address,address)(previousOwner?, newOwner?): OwnershipTransferredEventFilter;
        Paused(account?): PausedEventFilter;
        Paused(address)(account?): PausedEventFilter;
        Redeem(caller?, receiver?, tokenOut?, amountSyToRedeem?, amountTokenOut?): RedeemEventFilter;
        Redeem(address,address,address,uint256,uint256)(caller?, receiver?, tokenOut?, amountSyToRedeem?, amountTokenOut?): RedeemEventFilter;
        Transfer(from?, to?, value?): TransferEventFilter;
        Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter;
        Unpaused(account?): UnpausedEventFilter;
        Unpaused(address)(account?): UnpausedEventFilter;
    };
    functions: {
        DOMAIN_SEPARATOR(overrides?): Promise<[string]>;
        accruedRewards(arg0, overrides?): Promise<[BN[]] & {
            rewardAmounts: BN[];
        }>;
        allowance(owner, spender, overrides?): Promise<[BN]>;
        approve(spender, amount, overrides?): Promise<ContractTransaction>;
        assetInfo(overrides?): Promise<[number, string, number] & {
            assetAddress: string;
            assetDecimals: number;
            assetType: number;
        }>;
        balanceOf(account, overrides?): Promise<[BN]>;
        claimOwnership(overrides?): Promise<ContractTransaction>;
        claimRewards(arg0, overrides?): Promise<ContractTransaction>;
        decimals(overrides?): Promise<[number]>;
        deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<ContractTransaction>;
        eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
            chainId: BN;
            extensions: BN[];
            fields: string;
            name: string;
            salt: string;
            verifyingContract: string;
            version: string;
        }>;
        exchangeRate(overrides?): Promise<[BN] & {
            res: BN;
        }>;
        getRewardTokens(overrides?): Promise<[string[]] & {
            rewardTokens: string[];
        }>;
        getTokensIn(overrides?): Promise<[string[]] & {
            res: string[];
        }>;
        getTokensOut(overrides?): Promise<[string[]] & {
            res: string[];
        }>;
        isValidTokenIn(token, overrides?): Promise<[boolean]>;
        isValidTokenOut(token, overrides?): Promise<[boolean]>;
        name(overrides?): Promise<[string]>;
        nonces(owner, overrides?): Promise<[BN]>;
        owner(overrides?): Promise<[string]>;
        pause(overrides?): Promise<ContractTransaction>;
        paused(overrides?): Promise<[boolean]>;
        pendingOwner(overrides?): Promise<[string]>;
        permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<ContractTransaction>;
        previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<[BN] & {
            amountSharesOut: BN;
        }>;
        previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<[BN] & {
            amountTokenOut: BN;
        }>;
        redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<ContractTransaction>;
        rewardIndexesCurrent(overrides?): Promise<ContractTransaction>;
        rewardIndexesStored(overrides?): Promise<[BN[]] & {
            indexes: BN[];
        }>;
        symbol(overrides?): Promise<[string]>;
        totalSupply(overrides?): Promise<[BN]>;
        transfer(to, amount, overrides?): Promise<ContractTransaction>;
        transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>;
        transferOwnership(newOwner, direct, renounce, overrides?): Promise<ContractTransaction>;
        unpause(overrides?): Promise<ContractTransaction>;
        yieldToken(overrides?): Promise<[string]>;
    };
    interface: SYBaseInterface;
    off: OnEvent<SYBase>;
    on: OnEvent<SYBase>;
    once: OnEvent<SYBase>;
    populateTransaction: {
        DOMAIN_SEPARATOR(overrides?): Promise<PopulatedTransaction>;
        accruedRewards(arg0, overrides?): Promise<PopulatedTransaction>;
        allowance(owner, spender, overrides?): Promise<PopulatedTransaction>;
        approve(spender, amount, overrides?): Promise<PopulatedTransaction>;
        assetInfo(overrides?): Promise<PopulatedTransaction>;
        balanceOf(account, overrides?): Promise<PopulatedTransaction>;
        claimOwnership(overrides?): Promise<PopulatedTransaction>;
        claimRewards(arg0, overrides?): Promise<PopulatedTransaction>;
        decimals(overrides?): Promise<PopulatedTransaction>;
        deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<PopulatedTransaction>;
        eip712Domain(overrides?): Promise<PopulatedTransaction>;
        exchangeRate(overrides?): Promise<PopulatedTransaction>;
        getRewardTokens(overrides?): Promise<PopulatedTransaction>;
        getTokensIn(overrides?): Promise<PopulatedTransaction>;
        getTokensOut(overrides?): Promise<PopulatedTransaction>;
        isValidTokenIn(token, overrides?): Promise<PopulatedTransaction>;
        isValidTokenOut(token, overrides?): Promise<PopulatedTransaction>;
        name(overrides?): Promise<PopulatedTransaction>;
        nonces(owner, overrides?): Promise<PopulatedTransaction>;
        owner(overrides?): Promise<PopulatedTransaction>;
        pause(overrides?): Promise<PopulatedTransaction>;
        paused(overrides?): Promise<PopulatedTransaction>;
        pendingOwner(overrides?): Promise<PopulatedTransaction>;
        permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<PopulatedTransaction>;
        previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<PopulatedTransaction>;
        previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<PopulatedTransaction>;
        redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<PopulatedTransaction>;
        rewardIndexesCurrent(overrides?): Promise<PopulatedTransaction>;
        rewardIndexesStored(overrides?): Promise<PopulatedTransaction>;
        symbol(overrides?): Promise<PopulatedTransaction>;
        totalSupply(overrides?): Promise<PopulatedTransaction>;
        transfer(to, amount, overrides?): Promise<PopulatedTransaction>;
        transferFrom(from, to, amount, overrides?): Promise<PopulatedTransaction>;
        transferOwnership(newOwner, direct, renounce, overrides?): Promise<PopulatedTransaction>;
        unpause(overrides?): Promise<PopulatedTransaction>;
        yieldToken(overrides?): Promise<PopulatedTransaction>;
    };
    provider: Provider;
    removeListener: OnEvent<SYBase>;
    resolvedAddress: Promise<string>;
    signer: Signer;
    DOMAIN_SEPARATOR(overrides?): Promise<string>;
    _checkRunningEvents(runningEvent): void;
    _deployed(blockTag?): Promise<Contract>;
    _wrapEvent(runningEvent, log, listener): Event;
    accruedRewards(arg0, overrides?): Promise<BN[]>;
    allowance(owner, spender, overrides?): Promise<BN>;
    approve(spender, amount, overrides?): Promise<ContractTransaction>;
    assetInfo(overrides?): Promise<[number, string, number] & {
        assetAddress: string;
        assetDecimals: number;
        assetType: number;
    }>;
    attach(addressOrName): this;
    balanceOf(account, overrides?): Promise<BN>;
    claimOwnership(overrides?): Promise<ContractTransaction>;
    claimRewards(arg0, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    decimals(overrides?): Promise<number>;
    deployed(): Promise<SYBase>;
    deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<ContractTransaction>;
    eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
        chainId: BN;
        extensions: BN[];
        fields: string;
        name: string;
        salt: string;
        verifyingContract: string;
        version: string;
    }>;
    emit(eventName, ...args): boolean;
    exchangeRate(overrides?): Promise<BN>;
    fallback(overrides?): Promise<TransactionResponse>;
    getRewardTokens(overrides?): Promise<string[]>;
    getTokensIn(overrides?): Promise<string[]>;
    getTokensOut(overrides?): Promise<string[]>;
    isValidTokenIn(token, overrides?): Promise<boolean>;
    isValidTokenOut(token, overrides?): Promise<boolean>;
    listenerCount(eventName?): number;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    name(overrides?): Promise<string>;
    nonces(owner, overrides?): Promise<BN>;
    owner(overrides?): Promise<string>;
    pause(overrides?): Promise<ContractTransaction>;
    paused(overrides?): Promise<boolean>;
    pendingOwner(overrides?): Promise<string>;
    permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<ContractTransaction>;
    previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>;
    previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>;
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<ContractTransaction>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    rewardIndexesCurrent(overrides?): Promise<ContractTransaction>;
    rewardIndexesStored(overrides?): Promise<BN[]>;
    symbol(overrides?): Promise<string>;
    totalSupply(overrides?): Promise<BN>;
    transfer(to, amount, overrides?): Promise<ContractTransaction>;
    transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>;
    transferOwnership(newOwner, direct, renounce, overrides?): Promise<ContractTransaction>;
    unpause(overrides?): Promise<ContractTransaction>;
    yieldToken(overrides?): Promise<string>;
}

Hierarchy

  • BaseContract
    • SYBase

Properties

_deployedPromise _runningEvents _wrappedEmits address callStatic contractName deployTransaction estimateGas filters functions interface off on once populateTransaction provider removeListener resolvedAddress signer

Methods

DOMAIN_SEPARATOR _checkRunningEvents _deployed _wrapEvent accruedRewards allowance approve assetInfo attach balanceOf claimOwnership claimRewards connect decimals deployed deposit eip712Domain emit exchangeRate fallback getRewardTokens getTokensIn getTokensOut isValidTokenIn isValidTokenOut listenerCount listeners name nonces owner pause paused pendingOwner permit previewDeposit previewRedeem queryFilter redeem removeAllListeners rewardIndexesCurrent rewardIndexesStored symbol totalSupply transfer transferFrom transferOwnership unpause yieldToken

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {
    [eventTag: string]: RunningEvent;
}

Type declaration

  • [eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {
    [eventTag: string]: ((...args) => void);
}

Type declaration

  • [eventTag: string]: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

Readonly address

address: string

callStatic

callStatic: {
    DOMAIN_SEPARATOR(overrides?): Promise<string>;
    accruedRewards(arg0, overrides?): Promise<BN[]>;
    allowance(owner, spender, overrides?): Promise<BN>;
    approve(spender, amount, overrides?): Promise<boolean>;
    assetInfo(overrides?): Promise<[number, string, number] & {
        assetAddress: string;
        assetDecimals: number;
        assetType: number;
    }>;
    balanceOf(account, overrides?): Promise<BN>;
    claimOwnership(overrides?): Promise<void>;
    claimRewards(arg0, overrides?): Promise<BN[]>;
    decimals(overrides?): Promise<number>;
    deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<BN>;
    eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
        chainId: BN;
        extensions: BN[];
        fields: string;
        name: string;
        salt: string;
        verifyingContract: string;
        version: string;
    }>;
    exchangeRate(overrides?): Promise<BN>;
    getRewardTokens(overrides?): Promise<string[]>;
    getTokensIn(overrides?): Promise<string[]>;
    getTokensOut(overrides?): Promise<string[]>;
    isValidTokenIn(token, overrides?): Promise<boolean>;
    isValidTokenOut(token, overrides?): Promise<boolean>;
    name(overrides?): Promise<string>;
    nonces(owner, overrides?): Promise<BN>;
    owner(overrides?): Promise<string>;
    pause(overrides?): Promise<void>;
    paused(overrides?): Promise<boolean>;
    pendingOwner(overrides?): Promise<string>;
    permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<void>;
    previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>;
    previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>;
    redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<BN>;
    rewardIndexesCurrent(overrides?): Promise<BN[]>;
    rewardIndexesStored(overrides?): Promise<BN[]>;
    symbol(overrides?): Promise<string>;
    totalSupply(overrides?): Promise<BN>;
    transfer(to, amount, overrides?): Promise<boolean>;
    transferFrom(from, to, amount, overrides?): Promise<boolean>;
    transferOwnership(newOwner, direct, renounce, overrides?): Promise<void>;
    unpause(overrides?): Promise<void>;
    yieldToken(overrides?): Promise<string>;
}

Type declaration

  • DOMAIN_SEPARATOR:function
    • DOMAIN_SEPARATOR(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • accruedRewards:function
    • accruedRewards(arg0, overrides?): Promise<BN[]>

    • Parameters

      • arg0: string
      • Optional overrides: CallOverrides

      Returns Promise<BN[]>

  • allowance:function
    • allowance(owner, spender, overrides?): Promise<BN>

    • Parameters

      • owner: string
      • spender: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • approve:function
    • approve(spender, amount, overrides?): Promise<boolean>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • assetInfo:function
    • assetInfo(overrides?): Promise<[number, string, number] & {
          assetAddress: string;
          assetDecimals: number;
          assetType: number;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[number, string, number] & {
          assetAddress: string;
          assetDecimals: number;
          assetType: number;
      }>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<BN>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • claimOwnership:function
    • claimOwnership(overrides?): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • claimRewards:function
    • claimRewards(arg0, overrides?): Promise<BN[]>

    • Parameters

      • arg0: string
      • Optional overrides: CallOverrides

      Returns Promise<BN[]>

  • decimals:function
    • decimals(overrides?): Promise<number>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<number>

  • deposit:function
    • deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<BN>

    • Parameters

      • receiver: string
      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • minSharesOut: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • eip712Domain:function
    • eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
          chainId: BN;
          extensions: BN[];
          fields: string;
          name: string;
          salt: string;
          verifyingContract: string;
          version: string;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string, string, string, BN, string, string, BN[]] & {
          chainId: BN;
          extensions: BN[];
          fields: string;
          name: string;
          salt: string;
          verifyingContract: string;
          version: string;
      }>

  • exchangeRate:function
    • exchangeRate(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • getRewardTokens:function
    • getRewardTokens(overrides?): Promise<string[]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string[]>

  • getTokensIn:function
    • getTokensIn(overrides?): Promise<string[]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string[]>

  • getTokensOut:function
    • getTokensOut(overrides?): Promise<string[]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string[]>

  • isValidTokenIn:function
    • isValidTokenIn(token, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isValidTokenOut:function
    • isValidTokenOut(token, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • name:function
    • name(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • nonces:function
    • nonces(owner, overrides?): Promise<BN>

    • Parameters

      • owner: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • owner:function
    • owner(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • pause:function
    • pause(overrides?): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • paused:function
    • paused(overrides?): Promise<boolean>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • pendingOwner:function
    • pendingOwner(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • permit:function
    • permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<void>

    • Parameters

      Returns Promise<void>

  • previewDeposit:function
    • previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>

    • Parameters

      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • previewRedeem:function
    • previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>

    • Parameters

      • tokenOut: string
      • amountSharesToRedeem: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • redeem:function
    • redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<BN>

    • Parameters

      • receiver: string
      • amountSharesToRedeem: BigNumberish
      • tokenOut: string
      • minTokenOut: BigNumberish
      • burnFromInternalBalance: boolean
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • rewardIndexesCurrent:function
    • rewardIndexesCurrent(overrides?): Promise<BN[]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN[]>

  • rewardIndexesStored:function
    • rewardIndexesStored(overrides?): Promise<BN[]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN[]>

  • symbol:function
    • symbol(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • totalSupply:function
    • totalSupply(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<boolean>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<boolean>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • transferOwnership:function
    • transferOwnership(newOwner, direct, renounce, overrides?): Promise<void>

    • Parameters

      • newOwner: string
      • direct: boolean
      • renounce: boolean
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • unpause:function
    • unpause(overrides?): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • yieldToken:function
    • yieldToken(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

contractName

contractName: "SYBase"

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: {
    DOMAIN_SEPARATOR(overrides?): Promise<BN>;
    accruedRewards(arg0, overrides?): Promise<BN>;
    allowance(owner, spender, overrides?): Promise<BN>;
    approve(spender, amount, overrides?): Promise<BN>;
    assetInfo(overrides?): Promise<BN>;
    balanceOf(account, overrides?): Promise<BN>;
    claimOwnership(overrides?): Promise<BN>;
    claimRewards(arg0, overrides?): Promise<BN>;
    decimals(overrides?): Promise<BN>;
    deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<BN>;
    eip712Domain(overrides?): Promise<BN>;
    exchangeRate(overrides?): Promise<BN>;
    getRewardTokens(overrides?): Promise<BN>;
    getTokensIn(overrides?): Promise<BN>;
    getTokensOut(overrides?): Promise<BN>;
    isValidTokenIn(token, overrides?): Promise<BN>;
    isValidTokenOut(token, overrides?): Promise<BN>;
    name(overrides?): Promise<BN>;
    nonces(owner, overrides?): Promise<BN>;
    owner(overrides?): Promise<BN>;
    pause(overrides?): Promise<BN>;
    paused(overrides?): Promise<BN>;
    pendingOwner(overrides?): Promise<BN>;
    permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<BN>;
    previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>;
    previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>;
    redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<BN>;
    rewardIndexesCurrent(overrides?): Promise<BN>;
    rewardIndexesStored(overrides?): Promise<BN>;
    symbol(overrides?): Promise<BN>;
    totalSupply(overrides?): Promise<BN>;
    transfer(to, amount, overrides?): Promise<BN>;
    transferFrom(from, to, amount, overrides?): Promise<BN>;
    transferOwnership(newOwner, direct, renounce, overrides?): Promise<BN>;
    unpause(overrides?): Promise<BN>;
    yieldToken(overrides?): Promise<BN>;
}

Type declaration

  • DOMAIN_SEPARATOR:function
    • DOMAIN_SEPARATOR(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • accruedRewards:function
    • accruedRewards(arg0, overrides?): Promise<BN>

    • Parameters

      • arg0: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • allowance:function
    • allowance(owner, spender, overrides?): Promise<BN>

    • Parameters

      • owner: string
      • spender: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • approve:function
    • approve(spender, amount, overrides?): Promise<BN>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • assetInfo:function
    • assetInfo(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<BN>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • claimOwnership:function
    • claimOwnership(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • claimRewards:function
    • claimRewards(arg0, overrides?): Promise<BN>

    • Parameters

      • arg0: string
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • decimals:function
    • decimals(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • deposit:function
    • deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<BN>

    • Parameters

      • receiver: string
      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • minSharesOut: BigNumberish
      • Optional overrides: PayableOverrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • eip712Domain:function
    • eip712Domain(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • exchangeRate:function
    • exchangeRate(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • getRewardTokens:function
    • getRewardTokens(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • getTokensIn:function
    • getTokensIn(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • getTokensOut:function
    • getTokensOut(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • isValidTokenIn:function
    • isValidTokenIn(token, overrides?): Promise<BN>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • isValidTokenOut:function
    • isValidTokenOut(token, overrides?): Promise<BN>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • name:function
    • name(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • nonces:function
    • nonces(owner, overrides?): Promise<BN>

    • Parameters

      • owner: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • owner:function
    • owner(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • pause:function
    • pause(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • paused:function
    • paused(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • pendingOwner:function
    • pendingOwner(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • permit:function
    • permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<BN>

    • Parameters

      Returns Promise<BN>

  • previewDeposit:function
    • previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>

    • Parameters

      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • previewRedeem:function
    • previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>

    • Parameters

      • tokenOut: string
      • amountSharesToRedeem: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • redeem:function
    • redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<BN>

    • Parameters

      • receiver: string
      • amountSharesToRedeem: BigNumberish
      • tokenOut: string
      • minTokenOut: BigNumberish
      • burnFromInternalBalance: boolean
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • rewardIndexesCurrent:function
    • rewardIndexesCurrent(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • rewardIndexesStored:function
    • rewardIndexesStored(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • symbol:function
    • symbol(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • totalSupply:function
    • totalSupply(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<BN>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<BN>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • transferOwnership:function
    • transferOwnership(newOwner, direct, renounce, overrides?): Promise<BN>

    • Parameters

      • newOwner: string
      • direct: boolean
      • renounce: boolean
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • unpause:function
    • unpause(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • yieldToken:function
    • yieldToken(overrides?): Promise<BN>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BN>

filters

filters: {
    Approval(owner?, spender?, value?): ApprovalEventFilter;
    Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter;
    ClaimRewards(user?, rewardTokens?, rewardAmounts?): ClaimRewardsEventFilter;
    ClaimRewards(address,address[],uint256[])(user?, rewardTokens?, rewardAmounts?): ClaimRewardsEventFilter;
    Deposit(caller?, receiver?, tokenIn?, amountDeposited?, amountSyOut?): DepositEventFilter;
    Deposit(address,address,address,uint256,uint256)(caller?, receiver?, tokenIn?, amountDeposited?, amountSyOut?): DepositEventFilter;
    EIP712DomainChanged(): EIP712DomainChangedEventFilter;
    EIP712DomainChanged()(): EIP712DomainChangedEventFilter;
    Initialized(version?): InitializedEventFilter;
    Initialized(uint8)(version?): InitializedEventFilter;
    OwnershipTransferred(previousOwner?, newOwner?): OwnershipTransferredEventFilter;
    OwnershipTransferred(address,address)(previousOwner?, newOwner?): OwnershipTransferredEventFilter;
    Paused(account?): PausedEventFilter;
    Paused(address)(account?): PausedEventFilter;
    Redeem(caller?, receiver?, tokenOut?, amountSyToRedeem?, amountTokenOut?): RedeemEventFilter;
    Redeem(address,address,address,uint256,uint256)(caller?, receiver?, tokenOut?, amountSyToRedeem?, amountTokenOut?): RedeemEventFilter;
    Transfer(from?, to?, value?): TransferEventFilter;
    Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter;
    Unpaused(account?): UnpausedEventFilter;
    Unpaused(address)(account?): UnpausedEventFilter;
}

Type declaration

  • Approval:function
    • Approval(owner?, spender?, value?): ApprovalEventFilter

    • Parameters

      • Optional owner: null | string
      • Optional spender: null | string
      • Optional value: null

      Returns ApprovalEventFilter

  • Approval(address,address,uint256):function
    • Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter

    • Parameters

      • Optional owner: null | string
      • Optional spender: null | string
      • Optional value: null

      Returns ApprovalEventFilter

  • ClaimRewards:function
    • ClaimRewards(user?, rewardTokens?, rewardAmounts?): ClaimRewardsEventFilter

    • Parameters

      • Optional user: null | string
      • Optional rewardTokens: null
      • Optional rewardAmounts: null

      Returns ClaimRewardsEventFilter

  • ClaimRewards(address,address[],uint256[]):function
    • ClaimRewards(address,address[],uint256[])(user?, rewardTokens?, rewardAmounts?): ClaimRewardsEventFilter

    • Parameters

      • Optional user: null | string
      • Optional rewardTokens: null
      • Optional rewardAmounts: null

      Returns ClaimRewardsEventFilter

  • Deposit:function
    • Deposit(caller?, receiver?, tokenIn?, amountDeposited?, amountSyOut?): DepositEventFilter

    • Parameters

      • Optional caller: null | string
      • Optional receiver: null | string
      • Optional tokenIn: null | string
      • Optional amountDeposited: null
      • Optional amountSyOut: null

      Returns DepositEventFilter

  • Deposit(address,address,address,uint256,uint256):function
    • Deposit(address,address,address,uint256,uint256)(caller?, receiver?, tokenIn?, amountDeposited?, amountSyOut?): DepositEventFilter

    • Parameters

      • Optional caller: null | string
      • Optional receiver: null | string
      • Optional tokenIn: null | string
      • Optional amountDeposited: null
      • Optional amountSyOut: null

      Returns DepositEventFilter

  • EIP712DomainChanged:function
    • EIP712DomainChanged(): EIP712DomainChangedEventFilter

    • Returns EIP712DomainChangedEventFilter

  • EIP712DomainChanged():function
    • EIP712DomainChanged()(): EIP712DomainChangedEventFilter

    • Returns EIP712DomainChangedEventFilter

  • Initialized:function
    • Initialized(version?): InitializedEventFilter

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

  • Initialized(uint8):function
    • Initialized(uint8)(version?): InitializedEventFilter

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

  • OwnershipTransferred:function
    • OwnershipTransferred(previousOwner?, newOwner?): OwnershipTransferredEventFilter

    • Parameters

      • Optional previousOwner: null | string
      • Optional newOwner: null | string

      Returns OwnershipTransferredEventFilter

  • OwnershipTransferred(address,address):function
    • OwnershipTransferred(address,address)(previousOwner?, newOwner?): OwnershipTransferredEventFilter

    • Parameters

      • Optional previousOwner: null | string
      • Optional newOwner: null | string

      Returns OwnershipTransferredEventFilter

  • Paused:function
    • Paused(account?): PausedEventFilter

    • Parameters

      • Optional account: null

      Returns PausedEventFilter

  • Paused(address):function
    • Paused(address)(account?): PausedEventFilter

    • Parameters

      • Optional account: null

      Returns PausedEventFilter

  • Redeem:function
    • Redeem(caller?, receiver?, tokenOut?, amountSyToRedeem?, amountTokenOut?): RedeemEventFilter

    • Parameters

      • Optional caller: null | string
      • Optional receiver: null | string
      • Optional tokenOut: null | string
      • Optional amountSyToRedeem: null
      • Optional amountTokenOut: null

      Returns RedeemEventFilter

  • Redeem(address,address,address,uint256,uint256):function
    • Redeem(address,address,address,uint256,uint256)(caller?, receiver?, tokenOut?, amountSyToRedeem?, amountTokenOut?): RedeemEventFilter

    • Parameters

      • Optional caller: null | string
      • Optional receiver: null | string
      • Optional tokenOut: null | string
      • Optional amountSyToRedeem: null
      • Optional amountTokenOut: null

      Returns RedeemEventFilter

  • Transfer:function
    • Transfer(from?, to?, value?): TransferEventFilter

    • Parameters

      • Optional from: null | string
      • Optional to: null | string
      • Optional value: null

      Returns TransferEventFilter

  • Transfer(address,address,uint256):function
    • Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter

    • Parameters

      • Optional from: null | string
      • Optional to: null | string
      • Optional value: null

      Returns TransferEventFilter

  • Unpaused:function
    • Unpaused(account?): UnpausedEventFilter

    • Parameters

      • Optional account: null

      Returns UnpausedEventFilter

  • Unpaused(address):function
    • Unpaused(address)(account?): UnpausedEventFilter

    • Parameters

      • Optional account: null

      Returns UnpausedEventFilter

functions

functions: {
    DOMAIN_SEPARATOR(overrides?): Promise<[string]>;
    accruedRewards(arg0, overrides?): Promise<[BN[]] & {
        rewardAmounts: BN[];
    }>;
    allowance(owner, spender, overrides?): Promise<[BN]>;
    approve(spender, amount, overrides?): Promise<ContractTransaction>;
    assetInfo(overrides?): Promise<[number, string, number] & {
        assetAddress: string;
        assetDecimals: number;
        assetType: number;
    }>;
    balanceOf(account, overrides?): Promise<[BN]>;
    claimOwnership(overrides?): Promise<ContractTransaction>;
    claimRewards(arg0, overrides?): Promise<ContractTransaction>;
    decimals(overrides?): Promise<[number]>;
    deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<ContractTransaction>;
    eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
        chainId: BN;
        extensions: BN[];
        fields: string;
        name: string;
        salt: string;
        verifyingContract: string;
        version: string;
    }>;
    exchangeRate(overrides?): Promise<[BN] & {
        res: BN;
    }>;
    getRewardTokens(overrides?): Promise<[string[]] & {
        rewardTokens: string[];
    }>;
    getTokensIn(overrides?): Promise<[string[]] & {
        res: string[];
    }>;
    getTokensOut(overrides?): Promise<[string[]] & {
        res: string[];
    }>;
    isValidTokenIn(token, overrides?): Promise<[boolean]>;
    isValidTokenOut(token, overrides?): Promise<[boolean]>;
    name(overrides?): Promise<[string]>;
    nonces(owner, overrides?): Promise<[BN]>;
    owner(overrides?): Promise<[string]>;
    pause(overrides?): Promise<ContractTransaction>;
    paused(overrides?): Promise<[boolean]>;
    pendingOwner(overrides?): Promise<[string]>;
    permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<ContractTransaction>;
    previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<[BN] & {
        amountSharesOut: BN;
    }>;
    previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<[BN] & {
        amountTokenOut: BN;
    }>;
    redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<ContractTransaction>;
    rewardIndexesCurrent(overrides?): Promise<ContractTransaction>;
    rewardIndexesStored(overrides?): Promise<[BN[]] & {
        indexes: BN[];
    }>;
    symbol(overrides?): Promise<[string]>;
    totalSupply(overrides?): Promise<[BN]>;
    transfer(to, amount, overrides?): Promise<ContractTransaction>;
    transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>;
    transferOwnership(newOwner, direct, renounce, overrides?): Promise<ContractTransaction>;
    unpause(overrides?): Promise<ContractTransaction>;
    yieldToken(overrides?): Promise<[string]>;
}

Type declaration

  • DOMAIN_SEPARATOR:function
    • DOMAIN_SEPARATOR(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • accruedRewards:function
    • accruedRewards(arg0, overrides?): Promise<[BN[]] & {
          rewardAmounts: BN[];
      }>

    • Parameters

      • arg0: string
      • Optional overrides: CallOverrides

      Returns Promise<[BN[]] & {
          rewardAmounts: BN[];
      }>

  • allowance:function
    • allowance(owner, spender, overrides?): Promise<[BN]>

    • Parameters

      • owner: string
      • spender: string
      • Optional overrides: CallOverrides

      Returns Promise<[BN]>

  • approve:function
    • approve(spender, amount, overrides?): Promise<ContractTransaction>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • assetInfo:function
    • assetInfo(overrides?): Promise<[number, string, number] & {
          assetAddress: string;
          assetDecimals: number;
          assetType: number;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[number, string, number] & {
          assetAddress: string;
          assetDecimals: number;
          assetType: number;
      }>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<[BN]>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[BN]>

  • claimOwnership:function
    • claimOwnership(overrides?): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • claimRewards:function
    • claimRewards(arg0, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: string
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • decimals:function
    • decimals(overrides?): Promise<[number]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[number]>

  • deposit:function
    • deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<ContractTransaction>

    • Parameters

      • receiver: string
      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • minSharesOut: BigNumberish
      • Optional overrides: PayableOverrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • eip712Domain:function
    • eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
          chainId: BN;
          extensions: BN[];
          fields: string;
          name: string;
          salt: string;
          verifyingContract: string;
          version: string;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string, string, string, BN, string, string, BN[]] & {
          chainId: BN;
          extensions: BN[];
          fields: string;
          name: string;
          salt: string;
          verifyingContract: string;
          version: string;
      }>

  • exchangeRate:function
    • exchangeRate(overrides?): Promise<[BN] & {
          res: BN;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BN] & {
          res: BN;
      }>

  • getRewardTokens:function
    • getRewardTokens(overrides?): Promise<[string[]] & {
          rewardTokens: string[];
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string[]] & {
          rewardTokens: string[];
      }>

  • getTokensIn:function
    • getTokensIn(overrides?): Promise<[string[]] & {
          res: string[];
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string[]] & {
          res: string[];
      }>

  • getTokensOut:function
    • getTokensOut(overrides?): Promise<[string[]] & {
          res: string[];
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string[]] & {
          res: string[];
      }>

  • isValidTokenIn:function
    • isValidTokenIn(token, overrides?): Promise<[boolean]>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isValidTokenOut:function
    • isValidTokenOut(token, overrides?): Promise<[boolean]>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • name:function
    • name(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • nonces:function
    • nonces(owner, overrides?): Promise<[BN]>

    • Parameters

      • owner: string
      • Optional overrides: CallOverrides

      Returns Promise<[BN]>

  • owner:function
    • owner(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • pause:function
    • pause(overrides?): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • paused:function
    • paused(overrides?): Promise<[boolean]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • pendingOwner:function
    • pendingOwner(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • permit:function
    • permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<ContractTransaction>

    • Parameters

      Returns Promise<ContractTransaction>

  • previewDeposit:function
    • previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<[BN] & {
          amountSharesOut: BN;
      }>

    • Parameters

      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BN] & {
          amountSharesOut: BN;
      }>

  • previewRedeem:function
    • previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<[BN] & {
          amountTokenOut: BN;
      }>

    • Parameters

      • tokenOut: string
      • amountSharesToRedeem: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BN] & {
          amountTokenOut: BN;
      }>

  • redeem:function
    • redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<ContractTransaction>

    • Parameters

      • receiver: string
      • amountSharesToRedeem: BigNumberish
      • tokenOut: string
      • minTokenOut: BigNumberish
      • burnFromInternalBalance: boolean
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • rewardIndexesCurrent:function
    • rewardIndexesCurrent(overrides?): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • rewardIndexesStored:function
    • rewardIndexesStored(overrides?): Promise<[BN[]] & {
          indexes: BN[];
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BN[]] & {
          indexes: BN[];
      }>

  • symbol:function
    • symbol(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • totalSupply:function
    • totalSupply(overrides?): Promise<[BN]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BN]>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<ContractTransaction>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • transferOwnership:function
    • transferOwnership(newOwner, direct, renounce, overrides?): Promise<ContractTransaction>

    • Parameters

      • newOwner: string
      • direct: boolean
      • renounce: boolean
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • unpause:function
    • unpause(overrides?): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • yieldToken:function
    • yieldToken(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

interface

interface: SYBaseInterface

off

off: OnEvent<SYBase>

on

on: OnEvent<SYBase>

once

once: OnEvent<SYBase>

populateTransaction

populateTransaction: {
    DOMAIN_SEPARATOR(overrides?): Promise<PopulatedTransaction>;
    accruedRewards(arg0, overrides?): Promise<PopulatedTransaction>;
    allowance(owner, spender, overrides?): Promise<PopulatedTransaction>;
    approve(spender, amount, overrides?): Promise<PopulatedTransaction>;
    assetInfo(overrides?): Promise<PopulatedTransaction>;
    balanceOf(account, overrides?): Promise<PopulatedTransaction>;
    claimOwnership(overrides?): Promise<PopulatedTransaction>;
    claimRewards(arg0, overrides?): Promise<PopulatedTransaction>;
    decimals(overrides?): Promise<PopulatedTransaction>;
    deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<PopulatedTransaction>;
    eip712Domain(overrides?): Promise<PopulatedTransaction>;
    exchangeRate(overrides?): Promise<PopulatedTransaction>;
    getRewardTokens(overrides?): Promise<PopulatedTransaction>;
    getTokensIn(overrides?): Promise<PopulatedTransaction>;
    getTokensOut(overrides?): Promise<PopulatedTransaction>;
    isValidTokenIn(token, overrides?): Promise<PopulatedTransaction>;
    isValidTokenOut(token, overrides?): Promise<PopulatedTransaction>;
    name(overrides?): Promise<PopulatedTransaction>;
    nonces(owner, overrides?): Promise<PopulatedTransaction>;
    owner(overrides?): Promise<PopulatedTransaction>;
    pause(overrides?): Promise<PopulatedTransaction>;
    paused(overrides?): Promise<PopulatedTransaction>;
    pendingOwner(overrides?): Promise<PopulatedTransaction>;
    permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<PopulatedTransaction>;
    previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<PopulatedTransaction>;
    previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<PopulatedTransaction>;
    redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<PopulatedTransaction>;
    rewardIndexesCurrent(overrides?): Promise<PopulatedTransaction>;
    rewardIndexesStored(overrides?): Promise<PopulatedTransaction>;
    symbol(overrides?): Promise<PopulatedTransaction>;
    totalSupply(overrides?): Promise<PopulatedTransaction>;
    transfer(to, amount, overrides?): Promise<PopulatedTransaction>;
    transferFrom(from, to, amount, overrides?): Promise<PopulatedTransaction>;
    transferOwnership(newOwner, direct, renounce, overrides?): Promise<PopulatedTransaction>;
    unpause(overrides?): Promise<PopulatedTransaction>;
    yieldToken(overrides?): Promise<PopulatedTransaction>;
}

Type declaration

  • DOMAIN_SEPARATOR:function
    • DOMAIN_SEPARATOR(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • accruedRewards:function
    • accruedRewards(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • allowance:function
    • allowance(owner, spender, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • owner: string
      • spender: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • approve:function
    • approve(spender, amount, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • spender: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • assetInfo:function
    • assetInfo(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • claimOwnership:function
    • claimOwnership(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • claimRewards:function
    • claimRewards(arg0, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • arg0: string
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • decimals:function
    • decimals(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • deposit:function
    • deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • receiver: string
      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • minSharesOut: BigNumberish
      • Optional overrides: PayableOverrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • eip712Domain:function
    • eip712Domain(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • exchangeRate:function
    • exchangeRate(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getRewardTokens:function
    • getRewardTokens(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTokensIn:function
    • getTokensIn(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTokensOut:function
    • getTokensOut(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isValidTokenIn:function
    • isValidTokenIn(token, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isValidTokenOut:function
    • isValidTokenOut(token, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • name:function
    • name(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • nonces:function
    • nonces(owner, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • owner: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • owner:function
    • owner(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • pause:function
    • pause(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • paused:function
    • paused(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • pendingOwner:function
    • pendingOwner(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • permit:function
    • permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<PopulatedTransaction>

    • Parameters

      Returns Promise<PopulatedTransaction>

  • previewDeposit:function
    • previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • tokenIn: string
      • amountTokenToDeposit: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • previewRedeem:function
    • previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • tokenOut: string
      • amountSharesToRedeem: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • redeem:function
    • redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • receiver: string
      • amountSharesToRedeem: BigNumberish
      • tokenOut: string
      • minTokenOut: BigNumberish
      • burnFromInternalBalance: boolean
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • rewardIndexesCurrent:function
    • rewardIndexesCurrent(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • rewardIndexesStored:function
    • rewardIndexesStored(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • symbol:function
    • symbol(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • totalSupply:function
    • totalSupply(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • transferOwnership:function
    • transferOwnership(newOwner, direct, renounce, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • newOwner: string
      • direct: boolean
      • renounce: boolean
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • unpause:function
    • unpause(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • yieldToken:function
    • yieldToken(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

removeListener

removeListener: OnEvent<SYBase>

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

DOMAIN_SEPARATOR

  • DOMAIN_SEPARATOR(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

_checkRunningEvents

  • _checkRunningEvents(runningEvent): void

  • Parameters

    • runningEvent: RunningEvent

    Returns void

_deployed

  • _deployed(blockTag?): Promise<Contract>

  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

_wrapEvent

  • _wrapEvent(runningEvent, log, listener): Event

  • Parameters

    • runningEvent: RunningEvent
    • log: Log
    • listener: Listener

    Returns Event

accruedRewards

  • accruedRewards(arg0, overrides?): Promise<BN[]>

  • Parameters

    • arg0: string
    • Optional overrides: CallOverrides

    Returns Promise<BN[]>

allowance

  • allowance(owner, spender, overrides?): Promise<BN>

  • Parameters

    • owner: string
    • spender: string
    • Optional overrides: CallOverrides

    Returns Promise<BN>

approve

  • approve(spender, amount, overrides?): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • amount: BigNumberish
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

assetInfo

  • assetInfo(overrides?): Promise<[number, string, number] & {
        assetAddress: string;
        assetDecimals: number;
        assetType: number;
    }>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<[number, string, number] & {
        assetAddress: string;
        assetDecimals: number;
        assetType: number;
    }>

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

balanceOf

  • balanceOf(account, overrides?): Promise<BN>

  • Parameters

    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<BN>

claimOwnership

  • claimOwnership(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

claimRewards

  • claimRewards(arg0, overrides?): Promise<ContractTransaction>

  • Parameters

    • arg0: string
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Provider | Signer

    Returns this

decimals

  • decimals(overrides?): Promise<number>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<number>

deployed

  • deployed(): Promise<SYBase>

  • Returns Promise<SYBase>

deposit

  • deposit(receiver, tokenIn, amountTokenToDeposit, minSharesOut, overrides?): Promise<ContractTransaction>

  • Parameters

    • receiver: string
    • tokenIn: string
    • amountTokenToDeposit: BigNumberish
    • minSharesOut: BigNumberish
    • Optional overrides: PayableOverrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

eip712Domain

  • eip712Domain(overrides?): Promise<[string, string, string, BN, string, string, BN[]] & {
        chainId: BN;
        extensions: BN[];
        fields: string;
        name: string;
        salt: string;
        verifyingContract: string;
        version: string;
    }>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<[string, string, string, BN, string, string, BN[]] & {
        chainId: BN;
        extensions: BN[];
        fields: string;
        name: string;
        salt: string;
        verifyingContract: string;
        version: string;
    }>

emit

  • emit(eventName, ...args): boolean

  • Parameters

    • eventName: string | EventFilter
    • Rest ...args: any[]

    Returns boolean

exchangeRate

  • exchangeRate(overrides?): Promise<BN>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BN>

fallback

  • fallback(overrides?): Promise<TransactionResponse>

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

getRewardTokens

  • getRewardTokens(overrides?): Promise<string[]>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string[]>

getTokensIn

  • getTokensIn(overrides?): Promise<string[]>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string[]>

getTokensOut

  • getTokensOut(overrides?): Promise<string[]>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string[]>

isValidTokenIn

  • isValidTokenIn(token, overrides?): Promise<boolean>

  • Parameters

    • token: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isValidTokenOut

  • isValidTokenOut(token, overrides?): Promise<boolean>

  • Parameters

    • token: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

listenerCount

  • listenerCount(eventName?): number

  • Parameters

    • Optional eventName: string | EventFilter

    Returns number

listeners

  • listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

  • Type Parameters

    • TEvent extends TypedEvent<any, any>

    Parameters

    • Optional eventFilter: TypedEventFilter<TEvent>

    Returns TypedListener<TEvent>[]

  • listeners(eventName?): Listener[]

  • Parameters

    • Optional eventName: string

    Returns Listener[]

name

  • name(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

nonces

  • nonces(owner, overrides?): Promise<BN>

  • Parameters

    • owner: string
    • Optional overrides: CallOverrides

    Returns Promise<BN>

owner

  • owner(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

pause

  • pause(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

paused

  • paused(overrides?): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

pendingOwner

  • pendingOwner(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

permit

  • permit(owner, spender, value, deadline, v, r, s, overrides?): Promise<ContractTransaction>

  • Parameters

    Returns Promise<ContractTransaction>

previewDeposit

  • previewDeposit(tokenIn, amountTokenToDeposit, overrides?): Promise<BN>

  • Parameters

    • tokenIn: string
    • amountTokenToDeposit: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BN>

previewRedeem

  • previewRedeem(tokenOut, amountSharesToRedeem, overrides?): Promise<BN>

  • Parameters

    • tokenOut: string
    • amountSharesToRedeem: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BN>

queryFilter

  • queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

  • Type Parameters

    • TEvent extends TypedEvent<any, any>

    Parameters

    • event: TypedEventFilter<TEvent>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TEvent[]>

redeem

  • redeem(receiver, amountSharesToRedeem, tokenOut, minTokenOut, burnFromInternalBalance, overrides?): Promise<ContractTransaction>

  • Parameters

    • receiver: string
    • amountSharesToRedeem: BigNumberish
    • tokenOut: string
    • minTokenOut: BigNumberish
    • burnFromInternalBalance: boolean
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

removeAllListeners

  • removeAllListeners<TEvent>(eventFilter): this

  • Type Parameters

    • TEvent extends TypedEvent<any, any>

    Parameters

    • eventFilter: TypedEventFilter<TEvent>

    Returns this

  • removeAllListeners(eventName?): this

  • Parameters

    • Optional eventName: string

    Returns this

rewardIndexesCurrent

  • rewardIndexesCurrent(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

rewardIndexesStored

  • rewardIndexesStored(overrides?): Promise<BN[]>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BN[]>

symbol

  • symbol(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

totalSupply

  • totalSupply(overrides?): Promise<BN>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BN>

transfer

  • transfer(to, amount, overrides?): Promise<ContractTransaction>

  • Parameters

    • to: string
    • amount: BigNumberish
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

transferFrom

  • transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>

  • Parameters

    • from: string
    • to: string
    • amount: BigNumberish
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

transferOwnership

  • transferOwnership(newOwner, direct, renounce, overrides?): Promise<ContractTransaction>

  • Parameters

    • newOwner: string
    • direct: boolean
    • renounce: boolean
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

unpause

  • unpause(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

yieldToken

  • yieldToken(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc