Interface AgreementBase

interface AgreementBase {
    callStatic: {
        agreementType(overrides?): Promise<string>;
        castrate(overrides?): Promise<void>;
        getCodeAddress(overrides?): Promise<string>;
        proxiableUUID(overrides?): Promise<string>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            dynamicBalance: BigNumber;
            owedDeposit: BigNumber;
        }>;
        updateCode(newAddress, overrides?): Promise<void>;
    };
    estimateGas: {
        agreementType(overrides?): Promise<BigNumber>;
        castrate(overrides?): Promise<BigNumber>;
        getCodeAddress(overrides?): Promise<BigNumber>;
        proxiableUUID(overrides?): Promise<BigNumber>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>;
        updateCode(newAddress, overrides?): Promise<BigNumber>;
    };
    filters: {
        CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter;
        CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter;
        Initialized(version?): InitializedEventFilter;
        Initialized(uint8)(version?): InitializedEventFilter;
    };
    functions: {
        agreementType(overrides?): Promise<[string]>;
        castrate(overrides?): Promise<ContractTransaction>;
        getCodeAddress(overrides?): Promise<[string] & {
            codeAddress: string;
        }>;
        proxiableUUID(overrides?): Promise<[string]>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            dynamicBalance: BigNumber;
            owedDeposit: BigNumber;
        }>;
        updateCode(newAddress, overrides?): Promise<ContractTransaction>;
    };
    interface: AgreementBaseInterface;
    off: OnEvent<AgreementBase>;
    on: OnEvent<AgreementBase>;
    once: OnEvent<AgreementBase>;
    populateTransaction: {
        agreementType(overrides?): Promise<PopulatedTransaction>;
        castrate(overrides?): Promise<PopulatedTransaction>;
        getCodeAddress(overrides?): Promise<PopulatedTransaction>;
        proxiableUUID(overrides?): Promise<PopulatedTransaction>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>;
        updateCode(newAddress, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<AgreementBase>;
    agreementType(overrides?): Promise<string>;
    attach(addressOrName): this;
    castrate(overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    deployed(): Promise<AgreementBase>;
    getCodeAddress(overrides?): Promise<string>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    proxiableUUID(overrides?): Promise<string>;
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    updateCode(newAddress, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • AgreementBase

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

agreementType attach castrate connect deployed getCodeAddress listeners proxiableUUID queryFilter realtimeBalanceOf removeAllListeners updateCode

Properties

callStatic

callStatic: {
    agreementType(overrides?): Promise<string>;
    castrate(overrides?): Promise<void>;
    getCodeAddress(overrides?): Promise<string>;
    proxiableUUID(overrides?): Promise<string>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>;
    updateCode(newAddress, overrides?): Promise<void>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<void>

    • Parameters

      • newAddress: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

estimateGas

estimateGas: {
    agreementType(overrides?): Promise<BigNumber>;
    castrate(overrides?): Promise<BigNumber>;
    getCodeAddress(overrides?): Promise<BigNumber>;
    proxiableUUID(overrides?): Promise<BigNumber>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>;
    updateCode(newAddress, overrides?): Promise<BigNumber>;
}

Type declaration

  • agreementType:function
    • agreementType(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • castrate:function
    • castrate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • getCodeAddress:function
    • getCodeAddress(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • proxiableUUID:function
    • proxiableUUID(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<BigNumber>

    • Parameters

      • newAddress: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

filters

filters: {
    CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter;
    CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter;
    Initialized(version?): InitializedEventFilter;
    Initialized(uint8)(version?): InitializedEventFilter;
}

Type declaration

  • CodeUpdated:function
    • CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter

    • Parameters

      • Optional uuid: null
      • Optional codeAddress: null

      Returns CodeUpdatedEventFilter

  • CodeUpdated(bytes32,address):function
    • CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter

    • Parameters

      • Optional uuid: null
      • Optional codeAddress: null

      Returns CodeUpdatedEventFilter

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

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

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

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

functions

functions: {
    agreementType(overrides?): Promise<[string]>;
    castrate(overrides?): Promise<ContractTransaction>;
    getCodeAddress(overrides?): Promise<[string] & {
        codeAddress: string;
    }>;
    proxiableUUID(overrides?): Promise<[string]>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>;
    updateCode(newAddress, overrides?): Promise<ContractTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

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

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<ContractTransaction>

    • Parameters

      • newAddress: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

interface

interface: AgreementBaseInterface

off

off: OnEvent<AgreementBase>

on

on: OnEvent<AgreementBase>

once

once: OnEvent<AgreementBase>

populateTransaction

populateTransaction: {
    agreementType(overrides?): Promise<PopulatedTransaction>;
    castrate(overrides?): Promise<PopulatedTransaction>;
    getCodeAddress(overrides?): Promise<PopulatedTransaction>;
    proxiableUUID(overrides?): Promise<PopulatedTransaction>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>;
    updateCode(newAddress, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • newAddress: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<AgreementBase>

Methods

agreementType

  • agreementType(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

castrate

  • castrate(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

deployed

  • deployed(): Promise<AgreementBase>

  • Returns Promise<AgreementBase>

getCodeAddress

  • getCodeAddress(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

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[]

proxiableUUID

  • proxiableUUID(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

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[]>

realtimeBalanceOf

  • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>

  • Parameters

    • token: string
    • account: string
    • time: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>

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

updateCode

  • updateCode(newAddress, overrides?): Promise<ContractTransaction>

  • Parameters

    • newAddress: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc