Interface ISuperTokenFactory

interface ISuperTokenFactory {
    callStatic: {
        computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
            isDeployed: boolean;
            superTokenAddress: string;
        }>;
        createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<string>;
        createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<string>;
        createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<string>;
        createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<string>;
        createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<string>;
        getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<string>;
        getHost(overrides?): Promise<string>;
        getSuperTokenLogic(overrides?): Promise<string>;
        initialize(overrides?): Promise<void>;
        initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<void>;
    };
    estimateGas: {
        computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<BigNumber>;
        createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<BigNumber>;
        createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<BigNumber>;
        createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<BigNumber>;
        createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<BigNumber>;
        createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<BigNumber>;
        getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<BigNumber>;
        getHost(overrides?): Promise<BigNumber>;
        getSuperTokenLogic(overrides?): Promise<BigNumber>;
        initialize(overrides?): Promise<BigNumber>;
        initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<BigNumber>;
    };
    filters: {
        CustomSuperTokenCreated(token?): CustomSuperTokenCreatedEventFilter;
        CustomSuperTokenCreated(address)(token?): CustomSuperTokenCreatedEventFilter;
        SuperTokenCreated(token?): SuperTokenCreatedEventFilter;
        SuperTokenCreated(address)(token?): SuperTokenCreatedEventFilter;
        SuperTokenLogicCreated(tokenLogic?): SuperTokenLogicCreatedEventFilter;
        SuperTokenLogicCreated(address)(tokenLogic?): SuperTokenLogicCreatedEventFilter;
    };
    functions: {
        computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
            isDeployed: boolean;
            superTokenAddress: string;
        }>;
        createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<ContractTransaction>;
        createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<ContractTransaction>;
        createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>;
        createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<ContractTransaction>;
        createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>;
        getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<[string] & {
            superTokenAddress: string;
        }>;
        getHost(overrides?): Promise<[string] & {
            host: string;
        }>;
        getSuperTokenLogic(overrides?): Promise<[string] & {
            superToken: string;
        }>;
        initialize(overrides?): Promise<ContractTransaction>;
        initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<ContractTransaction>;
    };
    interface: ISuperTokenFactoryInterface;
    off: OnEvent<ISuperTokenFactory>;
    on: OnEvent<ISuperTokenFactory>;
    once: OnEvent<ISuperTokenFactory>;
    populateTransaction: {
        computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<PopulatedTransaction>;
        createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<PopulatedTransaction>;
        createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<PopulatedTransaction>;
        createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<PopulatedTransaction>;
        createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<PopulatedTransaction>;
        createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<PopulatedTransaction>;
        getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<PopulatedTransaction>;
        getHost(overrides?): Promise<PopulatedTransaction>;
        getSuperTokenLogic(overrides?): Promise<PopulatedTransaction>;
        initialize(overrides?): Promise<PopulatedTransaction>;
        initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<ISuperTokenFactory>;
    attach(addressOrName): this;
    computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
        isDeployed: boolean;
        superTokenAddress: string;
    }>;
    connect(signerOrProvider): this;
    createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<ISuperTokenFactory>;
    getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<string>;
    getHost(overrides?): Promise<string>;
    getSuperTokenLogic(overrides?): Promise<string>;
    initialize(overrides?): Promise<ContractTransaction>;
    initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<ContractTransaction>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
}

Hierarchy

  • BaseContract
    • ISuperTokenFactory

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

attach computeCanonicalERC20WrapperAddress connect createCanonicalERC20Wrapper createERC20Wrapper(address,uint8,string,string) createERC20Wrapper(address,uint8,string,string,address) createERC20Wrapper(address,uint8,uint8,string,string) createERC20Wrapper(address,uint8,uint8,string,string,address) deployed getCanonicalERC20Wrapper getHost getSuperTokenLogic initialize initializeCustomSuperToken listeners queryFilter removeAllListeners

Properties

callStatic

callStatic: {
    computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
        isDeployed: boolean;
        superTokenAddress: string;
    }>;
    createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<string>;
    createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<string>;
    createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<string>;
    createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<string>;
    createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<string>;
    getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<string>;
    getHost(overrides?): Promise<string>;
    getSuperTokenLogic(overrides?): Promise<string>;
    initialize(overrides?): Promise<void>;
    initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<void>;
}

Type declaration

  • computeCanonicalERC20WrapperAddress:function
    • computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
          isDeployed: boolean;
          superTokenAddress: string;
      }>

    • Parameters

      • _underlyingToken: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, boolean] & {
          isDeployed: boolean;
          superTokenAddress: string;
      }>

  • createCanonicalERC20Wrapper:function
    • createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<string>

    • Parameters

      • _underlyingToken: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createERC20Wrapper(address,uint8,string,string):function
    • createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<string>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createERC20Wrapper(address,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<string>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createERC20Wrapper(address,uint8,uint8,string,string):function
    • createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<string>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createERC20Wrapper(address,uint8,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<string>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getCanonicalERC20Wrapper:function
    • getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<string>

    • Parameters

      • _underlyingTokenAddress: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • initializeCustomSuperToken:function
    • initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<void>

    • Parameters

      • customSuperTokenProxy: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

estimateGas

estimateGas: {
    computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<BigNumber>;
    createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<BigNumber>;
    createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<BigNumber>;
    createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<BigNumber>;
    createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<BigNumber>;
    createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<BigNumber>;
    getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<BigNumber>;
    getHost(overrides?): Promise<BigNumber>;
    getSuperTokenLogic(overrides?): Promise<BigNumber>;
    initialize(overrides?): Promise<BigNumber>;
    initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<BigNumber>;
}

Type declaration

  • computeCanonicalERC20WrapperAddress:function
    • computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<BigNumber>

    • Parameters

      • _underlyingToken: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • createCanonicalERC20Wrapper:function
    • createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • createERC20Wrapper(address,uint8,string,string):function
    • createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<BigNumber>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • createERC20Wrapper(address,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<BigNumber>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • createERC20Wrapper(address,uint8,uint8,string,string):function
    • createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<BigNumber>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • createERC20Wrapper(address,uint8,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<BigNumber>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • getCanonicalERC20Wrapper:function
    • getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<BigNumber>

    • Parameters

      • _underlyingTokenAddress: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • initializeCustomSuperToken:function
    • initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

filters

filters: {
    CustomSuperTokenCreated(token?): CustomSuperTokenCreatedEventFilter;
    CustomSuperTokenCreated(address)(token?): CustomSuperTokenCreatedEventFilter;
    SuperTokenCreated(token?): SuperTokenCreatedEventFilter;
    SuperTokenCreated(address)(token?): SuperTokenCreatedEventFilter;
    SuperTokenLogicCreated(tokenLogic?): SuperTokenLogicCreatedEventFilter;
    SuperTokenLogicCreated(address)(tokenLogic?): SuperTokenLogicCreatedEventFilter;
}

Type declaration

  • CustomSuperTokenCreated:function
    • CustomSuperTokenCreated(token?): CustomSuperTokenCreatedEventFilter

    • Parameters

      • Optional token: null | string

      Returns CustomSuperTokenCreatedEventFilter

  • CustomSuperTokenCreated(address):function
    • CustomSuperTokenCreated(address)(token?): CustomSuperTokenCreatedEventFilter

    • Parameters

      • Optional token: null | string

      Returns CustomSuperTokenCreatedEventFilter

  • SuperTokenCreated:function
    • SuperTokenCreated(token?): SuperTokenCreatedEventFilter

    • Parameters

      • Optional token: null | string

      Returns SuperTokenCreatedEventFilter

  • SuperTokenCreated(address):function
    • SuperTokenCreated(address)(token?): SuperTokenCreatedEventFilter

    • Parameters

      • Optional token: null | string

      Returns SuperTokenCreatedEventFilter

  • SuperTokenLogicCreated:function
    • SuperTokenLogicCreated(tokenLogic?): SuperTokenLogicCreatedEventFilter

    • Parameters

      • Optional tokenLogic: null | string

      Returns SuperTokenLogicCreatedEventFilter

  • SuperTokenLogicCreated(address):function
    • SuperTokenLogicCreated(address)(tokenLogic?): SuperTokenLogicCreatedEventFilter

    • Parameters

      • Optional tokenLogic: null | string

      Returns SuperTokenLogicCreatedEventFilter

functions

functions: {
    computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
        isDeployed: boolean;
        superTokenAddress: string;
    }>;
    createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<ContractTransaction>;
    createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>;
    getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<[string] & {
        superTokenAddress: string;
    }>;
    getHost(overrides?): Promise<[string] & {
        host: string;
    }>;
    getSuperTokenLogic(overrides?): Promise<[string] & {
        superToken: string;
    }>;
    initialize(overrides?): Promise<ContractTransaction>;
    initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<ContractTransaction>;
}

Type declaration

  • computeCanonicalERC20WrapperAddress:function
    • computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
          isDeployed: boolean;
          superTokenAddress: string;
      }>

    • Parameters

      • _underlyingToken: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, boolean] & {
          isDeployed: boolean;
          superTokenAddress: string;
      }>

  • createCanonicalERC20Wrapper:function
    • createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • createERC20Wrapper(address,uint8,string,string):function
    • createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<ContractTransaction>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • createERC20Wrapper(address,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • createERC20Wrapper(address,uint8,uint8,string,string):function
    • createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<ContractTransaction>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • createERC20Wrapper(address,uint8,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • getCanonicalERC20Wrapper:function
    • getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<[string] & {
          superTokenAddress: string;
      }>

    • Parameters

      • _underlyingTokenAddress: string
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

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

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • initializeCustomSuperToken:function
    • initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

interface

interface: ISuperTokenFactoryInterface

off

off: OnEvent<ISuperTokenFactory>

on

on: OnEvent<ISuperTokenFactory>

once

once: OnEvent<ISuperTokenFactory>

populateTransaction

populateTransaction: {
    computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<PopulatedTransaction>;
    createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<PopulatedTransaction>;
    createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<PopulatedTransaction>;
    createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<PopulatedTransaction>;
    createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<PopulatedTransaction>;
    createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<PopulatedTransaction>;
    getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<PopulatedTransaction>;
    getHost(overrides?): Promise<PopulatedTransaction>;
    getSuperTokenLogic(overrides?): Promise<PopulatedTransaction>;
    initialize(overrides?): Promise<PopulatedTransaction>;
    initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

  • computeCanonicalERC20WrapperAddress:function
    • computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • _underlyingToken: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • createCanonicalERC20Wrapper:function
    • createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • createERC20Wrapper(address,uint8,string,string):function
    • createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • createERC20Wrapper(address,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • underlyingToken: string
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • createERC20Wrapper(address,uint8,uint8,string,string):function
    • createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • createERC20Wrapper(address,uint8,uint8,string,string,address):function
    • createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • underlyingToken: string
      • underlyingDecimals: BigNumberish
      • upgradability: BigNumberish
      • name: string
      • symbol: string
      • admin: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • getCanonicalERC20Wrapper:function
    • getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • _underlyingTokenAddress: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • initializeCustomSuperToken:function
    • initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<ISuperTokenFactory>

Methods

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

computeCanonicalERC20WrapperAddress

  • computeCanonicalERC20WrapperAddress(_underlyingToken, overrides?): Promise<[string, boolean] & {
        isDeployed: boolean;
        superTokenAddress: string;
    }>

  • Parameters

    • _underlyingToken: string
    • Optional overrides: CallOverrides

    Returns Promise<[string, boolean] & {
        isDeployed: boolean;
        superTokenAddress: string;
    }>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

createCanonicalERC20Wrapper

  • createCanonicalERC20Wrapper(_underlyingToken, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

createERC20Wrapper(address,uint8,string,string)

  • createERC20Wrapper(address,uint8,string,string)(underlyingToken, upgradability, name, symbol, overrides?): Promise<ContractTransaction>

  • Parameters

    • underlyingToken: string
    • upgradability: BigNumberish
    • name: string
    • symbol: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

createERC20Wrapper(address,uint8,string,string,address)

  • createERC20Wrapper(address,uint8,string,string,address)(underlyingToken, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>

  • Parameters

    • underlyingToken: string
    • upgradability: BigNumberish
    • name: string
    • symbol: string
    • admin: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

createERC20Wrapper(address,uint8,uint8,string,string)

  • createERC20Wrapper(address,uint8,uint8,string,string)(underlyingToken, underlyingDecimals, upgradability, name, symbol, overrides?): Promise<ContractTransaction>

  • Parameters

    • underlyingToken: string
    • underlyingDecimals: BigNumberish
    • upgradability: BigNumberish
    • name: string
    • symbol: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

createERC20Wrapper(address,uint8,uint8,string,string,address)

  • createERC20Wrapper(address,uint8,uint8,string,string,address)(underlyingToken, underlyingDecimals, upgradability, name, symbol, admin, overrides?): Promise<ContractTransaction>

  • Parameters

    • underlyingToken: string
    • underlyingDecimals: BigNumberish
    • upgradability: BigNumberish
    • name: string
    • symbol: string
    • admin: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deployed

  • deployed(): Promise<ISuperTokenFactory>

  • Returns Promise<ISuperTokenFactory>

getCanonicalERC20Wrapper

  • getCanonicalERC20Wrapper(_underlyingTokenAddress, overrides?): Promise<string>

  • Parameters

    • _underlyingTokenAddress: string
    • Optional overrides: CallOverrides

    Returns Promise<string>

getHost

  • getHost(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getSuperTokenLogic

  • getSuperTokenLogic(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

initialize

  • initialize(overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

initializeCustomSuperToken

  • initializeCustomSuperToken(customSuperTokenProxy, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

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

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

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc