Interface Superfluid

interface Superfluid {
    callStatic: {
        APP_WHITE_LISTING_ENABLED(overrides?): Promise<boolean>;
        CALLBACK_GAS_LIMIT(overrides?): Promise<BigNumber>;
        MAX_APP_CALLBACK_LEVEL(overrides?): Promise<BigNumber>;
        MAX_NUM_AGREEMENTS(overrides?): Promise<number>;
        NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<boolean>;
        addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
        allowCompositeApp(targetApp, overrides?): Promise<void>;
        appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<string>;
        appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<string>;
        batchCall(operations, overrides?): Promise<void>;
        callAgreement(agreementClass, callData, userData, overrides?): Promise<string>;
        callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<[string, string] & {
            newCtx: string;
            returnedData: string;
        }>;
        callAppAction(app, callData, overrides?): Promise<string>;
        callAppActionWithContext(app, callData, ctx, overrides?): Promise<string>;
        callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<string>;
        callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<string>;
        castrate(overrides?): Promise<void>;
        changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<void>;
        ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<string>;
        decodeCtx(ctx, overrides?): Promise<ContextStructOutput>;
        forwardBatchCall(operations, overrides?): Promise<void>;
        getAgreementClass(agreementType, overrides?): Promise<string>;
        getAppCallbackLevel(appAddr, overrides?): Promise<number>;
        getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
            isJailed: boolean;
            isSuperApp: boolean;
            noopMask: BigNumber;
        }>;
        getCodeAddress(overrides?): Promise<string>;
        getGovernance(overrides?): Promise<string>;
        getNow(overrides?): Promise<BigNumber>;
        getSuperTokenFactory(overrides?): Promise<string>;
        getSuperTokenFactoryLogic(overrides?): Promise<string>;
        initialize(gov, overrides?): Promise<void>;
        isAgreementClassListed(agreementClass, overrides?): Promise<boolean>;
        isAgreementTypeListed(agreementType, overrides?): Promise<boolean>;
        isApp(app, overrides?): Promise<boolean>;
        isAppJailed(app, overrides?): Promise<boolean>;
        isCompositeAppAllowed(app, targetApp, overrides?): Promise<boolean>;
        isCtxValid(ctx, overrides?): Promise<boolean>;
        isTrustedForwarder(forwarder, overrides?): Promise<boolean>;
        jailApp(ctx, app, reason, overrides?): Promise<string>;
        mapAgreementClasses(bitmap, overrides?): Promise<string[]>;
        proxiableUUID(overrides?): Promise<string>;
        registerAgreementClass(agreementClassLogic, overrides?): Promise<void>;
        registerApp(address,uint256)(app, configWord, overrides?): Promise<void>;
        registerApp(uint256)(configWord, overrides?): Promise<void>;
        registerAppByFactory(app, configWord, overrides?): Promise<void>;
        registerAppWithKey(configWord, registrationKey, overrides?): Promise<void>;
        removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
        replaceGovernance(newGov, overrides?): Promise<void>;
        updateAgreementClass(agreementClassLogic, overrides?): Promise<void>;
        updateCode(newAddress, overrides?): Promise<void>;
        updatePoolBeaconLogic(newLogic, overrides?): Promise<void>;
        updateSuperTokenFactory(newFactory, overrides?): Promise<void>;
        updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<void>;
        versionRecipient(overrides?): Promise<string>;
    };
    estimateGas: {
        APP_WHITE_LISTING_ENABLED(overrides?): Promise<BigNumber>;
        CALLBACK_GAS_LIMIT(overrides?): Promise<BigNumber>;
        MAX_APP_CALLBACK_LEVEL(overrides?): Promise<BigNumber>;
        MAX_NUM_AGREEMENTS(overrides?): Promise<BigNumber>;
        NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<BigNumber>;
        addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
        allowCompositeApp(targetApp, overrides?): Promise<BigNumber>;
        appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<BigNumber>;
        appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<BigNumber>;
        batchCall(operations, overrides?): Promise<BigNumber>;
        callAgreement(agreementClass, callData, userData, overrides?): Promise<BigNumber>;
        callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<BigNumber>;
        callAppAction(app, callData, overrides?): Promise<BigNumber>;
        callAppActionWithContext(app, callData, ctx, overrides?): Promise<BigNumber>;
        callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<BigNumber>;
        callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<BigNumber>;
        castrate(overrides?): Promise<BigNumber>;
        changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<BigNumber>;
        ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<BigNumber>;
        decodeCtx(ctx, overrides?): Promise<BigNumber>;
        forwardBatchCall(operations, overrides?): Promise<BigNumber>;
        getAgreementClass(agreementType, overrides?): Promise<BigNumber>;
        getAppCallbackLevel(appAddr, overrides?): Promise<BigNumber>;
        getAppManifest(app, overrides?): Promise<BigNumber>;
        getCodeAddress(overrides?): Promise<BigNumber>;
        getGovernance(overrides?): Promise<BigNumber>;
        getNow(overrides?): Promise<BigNumber>;
        getSuperTokenFactory(overrides?): Promise<BigNumber>;
        getSuperTokenFactoryLogic(overrides?): Promise<BigNumber>;
        initialize(gov, overrides?): Promise<BigNumber>;
        isAgreementClassListed(agreementClass, overrides?): Promise<BigNumber>;
        isAgreementTypeListed(agreementType, overrides?): Promise<BigNumber>;
        isApp(app, overrides?): Promise<BigNumber>;
        isAppJailed(app, overrides?): Promise<BigNumber>;
        isCompositeAppAllowed(app, targetApp, overrides?): Promise<BigNumber>;
        isCtxValid(ctx, overrides?): Promise<BigNumber>;
        isTrustedForwarder(forwarder, overrides?): Promise<BigNumber>;
        jailApp(ctx, app, reason, overrides?): Promise<BigNumber>;
        mapAgreementClasses(bitmap, overrides?): Promise<BigNumber>;
        proxiableUUID(overrides?): Promise<BigNumber>;
        registerAgreementClass(agreementClassLogic, overrides?): Promise<BigNumber>;
        registerApp(address,uint256)(app, configWord, overrides?): Promise<BigNumber>;
        registerApp(uint256)(configWord, overrides?): Promise<BigNumber>;
        registerAppByFactory(app, configWord, overrides?): Promise<BigNumber>;
        registerAppWithKey(configWord, registrationKey, overrides?): Promise<BigNumber>;
        removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
        replaceGovernance(newGov, overrides?): Promise<BigNumber>;
        updateAgreementClass(agreementClassLogic, overrides?): Promise<BigNumber>;
        updateCode(newAddress, overrides?): Promise<BigNumber>;
        updatePoolBeaconLogic(newLogic, overrides?): Promise<BigNumber>;
        updateSuperTokenFactory(newFactory, overrides?): Promise<BigNumber>;
        updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<BigNumber>;
        versionRecipient(overrides?): Promise<BigNumber>;
    };
    filters: {
        AgreementClassRegistered(agreementType?, code?): AgreementClassRegisteredEventFilter;
        AgreementClassRegistered(bytes32,address)(agreementType?, code?): AgreementClassRegisteredEventFilter;
        AgreementClassUpdated(agreementType?, code?): AgreementClassUpdatedEventFilter;
        AgreementClassUpdated(bytes32,address)(agreementType?, code?): AgreementClassUpdatedEventFilter;
        AppRegistered(app?): AppRegisteredEventFilter;
        AppRegistered(address)(app?): AppRegisteredEventFilter;
        CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter;
        CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter;
        GovernanceReplaced(oldGov?, newGov?): GovernanceReplacedEventFilter;
        GovernanceReplaced(address,address)(oldGov?, newGov?): GovernanceReplacedEventFilter;
        Initialized(version?): InitializedEventFilter;
        Initialized(uint8)(version?): InitializedEventFilter;
        Jail(app?, reason?): JailEventFilter;
        Jail(address,uint256)(app?, reason?): JailEventFilter;
        PoolBeaconLogicUpdated(beaconProxy?, newBeaconLogic?): PoolBeaconLogicUpdatedEventFilter;
        PoolBeaconLogicUpdated(address,address)(beaconProxy?, newBeaconLogic?): PoolBeaconLogicUpdatedEventFilter;
        SuperTokenFactoryUpdated(newFactory?): SuperTokenFactoryUpdatedEventFilter;
        SuperTokenFactoryUpdated(address)(newFactory?): SuperTokenFactoryUpdatedEventFilter;
        SuperTokenLogicUpdated(token?, code?): SuperTokenLogicUpdatedEventFilter;
        SuperTokenLogicUpdated(address,address)(token?, code?): SuperTokenLogicUpdatedEventFilter;
    };
    functions: {
        APP_WHITE_LISTING_ENABLED(overrides?): Promise<[boolean]>;
        CALLBACK_GAS_LIMIT(overrides?): Promise<[BigNumber]>;
        MAX_APP_CALLBACK_LEVEL(overrides?): Promise<[BigNumber]>;
        MAX_NUM_AGREEMENTS(overrides?): Promise<[number]>;
        NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<[boolean]>;
        addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<[BigNumber] & {
            newBitmap: BigNumber;
        }>;
        allowCompositeApp(targetApp, overrides?): Promise<ContractTransaction>;
        appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<ContractTransaction>;
        appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<ContractTransaction>;
        batchCall(operations, overrides?): Promise<ContractTransaction>;
        callAgreement(agreementClass, callData, userData, overrides?): Promise<ContractTransaction>;
        callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<ContractTransaction>;
        callAppAction(app, callData, overrides?): Promise<ContractTransaction>;
        callAppActionWithContext(app, callData, ctx, overrides?): Promise<ContractTransaction>;
        callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>;
        callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>;
        castrate(overrides?): Promise<ContractTransaction>;
        changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<ContractTransaction>;
        ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<ContractTransaction>;
        decodeCtx(ctx, overrides?): Promise<[ContextStructOutput] & {
            context: ContextStructOutput;
        }>;
        forwardBatchCall(operations, overrides?): Promise<ContractTransaction>;
        getAgreementClass(agreementType, overrides?): Promise<[string] & {
            agreementClass: string;
        }>;
        getAppCallbackLevel(appAddr, overrides?): Promise<[number]>;
        getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
            isJailed: boolean;
            isSuperApp: boolean;
            noopMask: BigNumber;
        }>;
        getCodeAddress(overrides?): Promise<[string] & {
            codeAddress: string;
        }>;
        getGovernance(overrides?): Promise<[string]>;
        getNow(overrides?): Promise<[BigNumber]>;
        getSuperTokenFactory(overrides?): Promise<[string] & {
            factory: string;
        }>;
        getSuperTokenFactoryLogic(overrides?): Promise<[string] & {
            logic: string;
        }>;
        initialize(gov, overrides?): Promise<ContractTransaction>;
        isAgreementClassListed(agreementClass, overrides?): Promise<[boolean] & {
            yes: boolean;
        }>;
        isAgreementTypeListed(agreementType, overrides?): Promise<[boolean] & {
            yes: boolean;
        }>;
        isApp(app, overrides?): Promise<[boolean]>;
        isAppJailed(app, overrides?): Promise<[boolean]>;
        isCompositeAppAllowed(app, targetApp, overrides?): Promise<[boolean]>;
        isCtxValid(ctx, overrides?): Promise<[boolean]>;
        isTrustedForwarder(forwarder, overrides?): Promise<[boolean]>;
        jailApp(ctx, app, reason, overrides?): Promise<ContractTransaction>;
        mapAgreementClasses(bitmap, overrides?): Promise<[string[]] & {
            agreementClasses: string[];
        }>;
        proxiableUUID(overrides?): Promise<[string]>;
        registerAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>;
        registerApp(address,uint256)(app, configWord, overrides?): Promise<ContractTransaction>;
        registerApp(uint256)(configWord, overrides?): Promise<ContractTransaction>;
        registerAppByFactory(app, configWord, overrides?): Promise<ContractTransaction>;
        registerAppWithKey(configWord, registrationKey, overrides?): Promise<ContractTransaction>;
        removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<[BigNumber] & {
            newBitmap: BigNumber;
        }>;
        replaceGovernance(newGov, overrides?): Promise<ContractTransaction>;
        updateAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>;
        updateCode(newAddress, overrides?): Promise<ContractTransaction>;
        updatePoolBeaconLogic(newLogic, overrides?): Promise<ContractTransaction>;
        updateSuperTokenFactory(newFactory, overrides?): Promise<ContractTransaction>;
        updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<ContractTransaction>;
        versionRecipient(overrides?): Promise<[string]>;
    };
    interface: SuperfluidInterface;
    off: OnEvent<Superfluid>;
    on: OnEvent<Superfluid>;
    once: OnEvent<Superfluid>;
    populateTransaction: {
        APP_WHITE_LISTING_ENABLED(overrides?): Promise<PopulatedTransaction>;
        CALLBACK_GAS_LIMIT(overrides?): Promise<PopulatedTransaction>;
        MAX_APP_CALLBACK_LEVEL(overrides?): Promise<PopulatedTransaction>;
        MAX_NUM_AGREEMENTS(overrides?): Promise<PopulatedTransaction>;
        NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<PopulatedTransaction>;
        addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<PopulatedTransaction>;
        allowCompositeApp(targetApp, overrides?): Promise<PopulatedTransaction>;
        appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<PopulatedTransaction>;
        appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<PopulatedTransaction>;
        batchCall(operations, overrides?): Promise<PopulatedTransaction>;
        callAgreement(agreementClass, callData, userData, overrides?): Promise<PopulatedTransaction>;
        callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<PopulatedTransaction>;
        callAppAction(app, callData, overrides?): Promise<PopulatedTransaction>;
        callAppActionWithContext(app, callData, ctx, overrides?): Promise<PopulatedTransaction>;
        callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<PopulatedTransaction>;
        callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<PopulatedTransaction>;
        castrate(overrides?): Promise<PopulatedTransaction>;
        changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<PopulatedTransaction>;
        ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<PopulatedTransaction>;
        decodeCtx(ctx, overrides?): Promise<PopulatedTransaction>;
        forwardBatchCall(operations, overrides?): Promise<PopulatedTransaction>;
        getAgreementClass(agreementType, overrides?): Promise<PopulatedTransaction>;
        getAppCallbackLevel(appAddr, overrides?): Promise<PopulatedTransaction>;
        getAppManifest(app, overrides?): Promise<PopulatedTransaction>;
        getCodeAddress(overrides?): Promise<PopulatedTransaction>;
        getGovernance(overrides?): Promise<PopulatedTransaction>;
        getNow(overrides?): Promise<PopulatedTransaction>;
        getSuperTokenFactory(overrides?): Promise<PopulatedTransaction>;
        getSuperTokenFactoryLogic(overrides?): Promise<PopulatedTransaction>;
        initialize(gov, overrides?): Promise<PopulatedTransaction>;
        isAgreementClassListed(agreementClass, overrides?): Promise<PopulatedTransaction>;
        isAgreementTypeListed(agreementType, overrides?): Promise<PopulatedTransaction>;
        isApp(app, overrides?): Promise<PopulatedTransaction>;
        isAppJailed(app, overrides?): Promise<PopulatedTransaction>;
        isCompositeAppAllowed(app, targetApp, overrides?): Promise<PopulatedTransaction>;
        isCtxValid(ctx, overrides?): Promise<PopulatedTransaction>;
        isTrustedForwarder(forwarder, overrides?): Promise<PopulatedTransaction>;
        jailApp(ctx, app, reason, overrides?): Promise<PopulatedTransaction>;
        mapAgreementClasses(bitmap, overrides?): Promise<PopulatedTransaction>;
        proxiableUUID(overrides?): Promise<PopulatedTransaction>;
        registerAgreementClass(agreementClassLogic, overrides?): Promise<PopulatedTransaction>;
        registerApp(address,uint256)(app, configWord, overrides?): Promise<PopulatedTransaction>;
        registerApp(uint256)(configWord, overrides?): Promise<PopulatedTransaction>;
        registerAppByFactory(app, configWord, overrides?): Promise<PopulatedTransaction>;
        registerAppWithKey(configWord, registrationKey, overrides?): Promise<PopulatedTransaction>;
        removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<PopulatedTransaction>;
        replaceGovernance(newGov, overrides?): Promise<PopulatedTransaction>;
        updateAgreementClass(agreementClassLogic, overrides?): Promise<PopulatedTransaction>;
        updateCode(newAddress, overrides?): Promise<PopulatedTransaction>;
        updatePoolBeaconLogic(newLogic, overrides?): Promise<PopulatedTransaction>;
        updateSuperTokenFactory(newFactory, overrides?): Promise<PopulatedTransaction>;
        updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<PopulatedTransaction>;
        versionRecipient(overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<Superfluid>;
    APP_WHITE_LISTING_ENABLED(overrides?): Promise<boolean>;
    CALLBACK_GAS_LIMIT(overrides?): Promise<BigNumber>;
    MAX_APP_CALLBACK_LEVEL(overrides?): Promise<BigNumber>;
    MAX_NUM_AGREEMENTS(overrides?): Promise<number>;
    NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<boolean>;
    addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
    allowCompositeApp(targetApp, overrides?): Promise<ContractTransaction>;
    appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<ContractTransaction>;
    appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<ContractTransaction>;
    attach(addressOrName): this;
    batchCall(operations, overrides?): Promise<ContractTransaction>;
    callAgreement(agreementClass, callData, userData, overrides?): Promise<ContractTransaction>;
    callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<ContractTransaction>;
    callAppAction(app, callData, overrides?): Promise<ContractTransaction>;
    callAppActionWithContext(app, callData, ctx, overrides?): Promise<ContractTransaction>;
    callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>;
    callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>;
    castrate(overrides?): Promise<ContractTransaction>;
    changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<ContractTransaction>;
    decodeCtx(ctx, overrides?): Promise<ContextStructOutput>;
    deployed(): Promise<Superfluid>;
    forwardBatchCall(operations, overrides?): Promise<ContractTransaction>;
    getAgreementClass(agreementType, overrides?): Promise<string>;
    getAppCallbackLevel(appAddr, overrides?): Promise<number>;
    getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
        isJailed: boolean;
        isSuperApp: boolean;
        noopMask: BigNumber;
    }>;
    getCodeAddress(overrides?): Promise<string>;
    getGovernance(overrides?): Promise<string>;
    getNow(overrides?): Promise<BigNumber>;
    getSuperTokenFactory(overrides?): Promise<string>;
    getSuperTokenFactoryLogic(overrides?): Promise<string>;
    initialize(gov, overrides?): Promise<ContractTransaction>;
    isAgreementClassListed(agreementClass, overrides?): Promise<boolean>;
    isAgreementTypeListed(agreementType, overrides?): Promise<boolean>;
    isApp(app, overrides?): Promise<boolean>;
    isAppJailed(app, overrides?): Promise<boolean>;
    isCompositeAppAllowed(app, targetApp, overrides?): Promise<boolean>;
    isCtxValid(ctx, overrides?): Promise<boolean>;
    isTrustedForwarder(forwarder, overrides?): Promise<boolean>;
    jailApp(ctx, app, reason, overrides?): Promise<ContractTransaction>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    mapAgreementClasses(bitmap, overrides?): Promise<string[]>;
    proxiableUUID(overrides?): Promise<string>;
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    registerAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>;
    registerApp(address,uint256)(app, configWord, overrides?): Promise<ContractTransaction>;
    registerApp(uint256)(configWord, overrides?): Promise<ContractTransaction>;
    registerAppByFactory(app, configWord, overrides?): Promise<ContractTransaction>;
    registerAppWithKey(configWord, registrationKey, overrides?): Promise<ContractTransaction>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
    replaceGovernance(newGov, overrides?): Promise<ContractTransaction>;
    updateAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>;
    updateCode(newAddress, overrides?): Promise<ContractTransaction>;
    updatePoolBeaconLogic(newLogic, overrides?): Promise<ContractTransaction>;
    updateSuperTokenFactory(newFactory, overrides?): Promise<ContractTransaction>;
    updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<ContractTransaction>;
    versionRecipient(overrides?): Promise<string>;
}

Hierarchy

  • BaseContract
    • Superfluid

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

APP_WHITE_LISTING_ENABLED CALLBACK_GAS_LIMIT MAX_APP_CALLBACK_LEVEL MAX_NUM_AGREEMENTS NON_UPGRADABLE_DEPLOYMENT addToAgreementClassesBitmap allowCompositeApp appCallbackPop appCallbackPush attach batchCall callAgreement callAgreementWithContext callAppAction callAppActionWithContext callAppAfterCallback callAppBeforeCallback castrate changeSuperTokenAdmin connect ctxUseCredit decodeCtx deployed forwardBatchCall getAgreementClass getAppCallbackLevel getAppManifest getCodeAddress getGovernance getNow getSuperTokenFactory getSuperTokenFactoryLogic initialize isAgreementClassListed isAgreementTypeListed isApp isAppJailed isCompositeAppAllowed isCtxValid isTrustedForwarder jailApp listeners mapAgreementClasses proxiableUUID queryFilter registerAgreementClass registerApp(address,uint256) registerApp(uint256) registerAppByFactory registerAppWithKey removeAllListeners removeFromAgreementClassesBitmap replaceGovernance updateAgreementClass updateCode updatePoolBeaconLogic updateSuperTokenFactory updateSuperTokenLogic versionRecipient

Properties

callStatic

callStatic: {
    APP_WHITE_LISTING_ENABLED(overrides?): Promise<boolean>;
    CALLBACK_GAS_LIMIT(overrides?): Promise<BigNumber>;
    MAX_APP_CALLBACK_LEVEL(overrides?): Promise<BigNumber>;
    MAX_NUM_AGREEMENTS(overrides?): Promise<number>;
    NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<boolean>;
    addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
    allowCompositeApp(targetApp, overrides?): Promise<void>;
    appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<string>;
    appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<string>;
    batchCall(operations, overrides?): Promise<void>;
    callAgreement(agreementClass, callData, userData, overrides?): Promise<string>;
    callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<[string, string] & {
        newCtx: string;
        returnedData: string;
    }>;
    callAppAction(app, callData, overrides?): Promise<string>;
    callAppActionWithContext(app, callData, ctx, overrides?): Promise<string>;
    callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<string>;
    callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<string>;
    castrate(overrides?): Promise<void>;
    changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<void>;
    ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<string>;
    decodeCtx(ctx, overrides?): Promise<ContextStructOutput>;
    forwardBatchCall(operations, overrides?): Promise<void>;
    getAgreementClass(agreementType, overrides?): Promise<string>;
    getAppCallbackLevel(appAddr, overrides?): Promise<number>;
    getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
        isJailed: boolean;
        isSuperApp: boolean;
        noopMask: BigNumber;
    }>;
    getCodeAddress(overrides?): Promise<string>;
    getGovernance(overrides?): Promise<string>;
    getNow(overrides?): Promise<BigNumber>;
    getSuperTokenFactory(overrides?): Promise<string>;
    getSuperTokenFactoryLogic(overrides?): Promise<string>;
    initialize(gov, overrides?): Promise<void>;
    isAgreementClassListed(agreementClass, overrides?): Promise<boolean>;
    isAgreementTypeListed(agreementType, overrides?): Promise<boolean>;
    isApp(app, overrides?): Promise<boolean>;
    isAppJailed(app, overrides?): Promise<boolean>;
    isCompositeAppAllowed(app, targetApp, overrides?): Promise<boolean>;
    isCtxValid(ctx, overrides?): Promise<boolean>;
    isTrustedForwarder(forwarder, overrides?): Promise<boolean>;
    jailApp(ctx, app, reason, overrides?): Promise<string>;
    mapAgreementClasses(bitmap, overrides?): Promise<string[]>;
    proxiableUUID(overrides?): Promise<string>;
    registerAgreementClass(agreementClassLogic, overrides?): Promise<void>;
    registerApp(address,uint256)(app, configWord, overrides?): Promise<void>;
    registerApp(uint256)(configWord, overrides?): Promise<void>;
    registerAppByFactory(app, configWord, overrides?): Promise<void>;
    registerAppWithKey(configWord, registrationKey, overrides?): Promise<void>;
    removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
    replaceGovernance(newGov, overrides?): Promise<void>;
    updateAgreementClass(agreementClassLogic, overrides?): Promise<void>;
    updateCode(newAddress, overrides?): Promise<void>;
    updatePoolBeaconLogic(newLogic, overrides?): Promise<void>;
    updateSuperTokenFactory(newFactory, overrides?): Promise<void>;
    updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<void>;
    versionRecipient(overrides?): Promise<string>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<number>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

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

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • allowCompositeApp:function
    • allowCompositeApp(targetApp, overrides?): Promise<void>

    • Parameters

      • targetApp: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • appCallbackPop:function
    • appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<string>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedDelta: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • appCallbackPush:function
    • appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<string>

    • Parameters

      • ctx: BytesLike
      • app: string
      • appCreditGranted: BigNumberish
      • appCreditUsed: BigNumberish
      • appCreditToken: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • batchCall:function
    • batchCall(operations, overrides?): Promise<void>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • callAgreement:function
    • callAgreement(agreementClass, callData, userData, overrides?): Promise<string>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • callAgreementWithContext:function
    • callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<[string, string] & {
          newCtx: string;
          returnedData: string;
      }>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[string, string] & {
          newCtx: string;
          returnedData: string;
      }>

  • callAppAction:function
    • callAppAction(app, callData, overrides?): Promise<string>

    • Parameters

      • app: string
      • callData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • callAppActionWithContext:function
    • callAppActionWithContext(app, callData, ctx, overrides?): Promise<string>

    • Parameters

      • app: string
      • callData: BytesLike
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • callAppAfterCallback:function
    • callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<string>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • callAppBeforeCallback:function
    • callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<string>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • changeSuperTokenAdmin:function
    • changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<void>

    • Parameters

      • token: string
      • newAdmin: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • ctxUseCredit:function
    • ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<string>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedMore: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • decodeCtx:function
    • decodeCtx(ctx, overrides?): Promise<ContextStructOutput>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<ContextStructOutput>

  • forwardBatchCall:function
    • forwardBatchCall(operations, overrides?): Promise<void>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getAppCallbackLevel:function
    • getAppCallbackLevel(appAddr, overrides?): Promise<number>

    • Parameters

      • appAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<number>

  • getAppManifest:function
    • getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
          isJailed: boolean;
          isSuperApp: boolean;
          noopMask: BigNumber;
      }>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean, boolean, BigNumber] & {
          isJailed: boolean;
          isSuperApp: boolean;
          noopMask: BigNumber;
      }>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • gov: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • isAgreementClassListed:function
    • isAgreementClassListed(agreementClass, overrides?): Promise<boolean>

    • Parameters

      • agreementClass: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isAgreementTypeListed:function
    • isAgreementTypeListed(agreementType, overrides?): Promise<boolean>

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isApp:function
    • isApp(app, overrides?): Promise<boolean>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isAppJailed:function
    • isAppJailed(app, overrides?): Promise<boolean>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isCompositeAppAllowed:function
    • isCompositeAppAllowed(app, targetApp, overrides?): Promise<boolean>

    • Parameters

      • app: string
      • targetApp: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isCtxValid:function
    • isCtxValid(ctx, overrides?): Promise<boolean>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isTrustedForwarder:function
    • isTrustedForwarder(forwarder, overrides?): Promise<boolean>

    • Parameters

      • forwarder: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • jailApp:function
    • jailApp(ctx, app, reason, overrides?): Promise<string>

    • Parameters

      • ctx: BytesLike
      • app: string
      • reason: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • mapAgreementClasses:function
    • mapAgreementClasses(bitmap, overrides?): Promise<string[]>

    • Parameters

      • bitmap: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string[]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • registerAgreementClass:function
    • registerAgreementClass(agreementClassLogic, overrides?): Promise<void>

    • Parameters

      • agreementClassLogic: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerApp(address,uint256):function
    • registerApp(address,uint256)(app, configWord, overrides?): Promise<void>

    • Parameters

      • app: string
      • configWord: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerApp(uint256):function
    • registerApp(uint256)(configWord, overrides?): Promise<void>

    • Parameters

      • configWord: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerAppByFactory:function
    • registerAppByFactory(app, configWord, overrides?): Promise<void>

    • Parameters

      • app: string
      • configWord: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • registerAppWithKey:function
    • registerAppWithKey(configWord, registrationKey, overrides?): Promise<void>

    • Parameters

      • configWord: BigNumberish
      • registrationKey: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • replaceGovernance:function
    • replaceGovernance(newGov, overrides?): Promise<void>

    • Parameters

      • newGov: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateAgreementClass:function
    • updateAgreementClass(agreementClassLogic, overrides?): Promise<void>

    • Parameters

      • agreementClassLogic: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • newAddress: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updatePoolBeaconLogic:function
    • updatePoolBeaconLogic(newLogic, overrides?): Promise<void>

    • Parameters

      • newLogic: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateSuperTokenFactory:function
    • updateSuperTokenFactory(newFactory, overrides?): Promise<void>

    • Parameters

      • newFactory: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateSuperTokenLogic:function
    • updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<void>

    • Parameters

      • token: string
      • newLogicOverride: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

estimateGas

estimateGas: {
    APP_WHITE_LISTING_ENABLED(overrides?): Promise<BigNumber>;
    CALLBACK_GAS_LIMIT(overrides?): Promise<BigNumber>;
    MAX_APP_CALLBACK_LEVEL(overrides?): Promise<BigNumber>;
    MAX_NUM_AGREEMENTS(overrides?): Promise<BigNumber>;
    NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<BigNumber>;
    addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
    allowCompositeApp(targetApp, overrides?): Promise<BigNumber>;
    appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<BigNumber>;
    appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<BigNumber>;
    batchCall(operations, overrides?): Promise<BigNumber>;
    callAgreement(agreementClass, callData, userData, overrides?): Promise<BigNumber>;
    callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<BigNumber>;
    callAppAction(app, callData, overrides?): Promise<BigNumber>;
    callAppActionWithContext(app, callData, ctx, overrides?): Promise<BigNumber>;
    callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<BigNumber>;
    callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<BigNumber>;
    castrate(overrides?): Promise<BigNumber>;
    changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<BigNumber>;
    ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<BigNumber>;
    decodeCtx(ctx, overrides?): Promise<BigNumber>;
    forwardBatchCall(operations, overrides?): Promise<BigNumber>;
    getAgreementClass(agreementType, overrides?): Promise<BigNumber>;
    getAppCallbackLevel(appAddr, overrides?): Promise<BigNumber>;
    getAppManifest(app, overrides?): Promise<BigNumber>;
    getCodeAddress(overrides?): Promise<BigNumber>;
    getGovernance(overrides?): Promise<BigNumber>;
    getNow(overrides?): Promise<BigNumber>;
    getSuperTokenFactory(overrides?): Promise<BigNumber>;
    getSuperTokenFactoryLogic(overrides?): Promise<BigNumber>;
    initialize(gov, overrides?): Promise<BigNumber>;
    isAgreementClassListed(agreementClass, overrides?): Promise<BigNumber>;
    isAgreementTypeListed(agreementType, overrides?): Promise<BigNumber>;
    isApp(app, overrides?): Promise<BigNumber>;
    isAppJailed(app, overrides?): Promise<BigNumber>;
    isCompositeAppAllowed(app, targetApp, overrides?): Promise<BigNumber>;
    isCtxValid(ctx, overrides?): Promise<BigNumber>;
    isTrustedForwarder(forwarder, overrides?): Promise<BigNumber>;
    jailApp(ctx, app, reason, overrides?): Promise<BigNumber>;
    mapAgreementClasses(bitmap, overrides?): Promise<BigNumber>;
    proxiableUUID(overrides?): Promise<BigNumber>;
    registerAgreementClass(agreementClassLogic, overrides?): Promise<BigNumber>;
    registerApp(address,uint256)(app, configWord, overrides?): Promise<BigNumber>;
    registerApp(uint256)(configWord, overrides?): Promise<BigNumber>;
    registerAppByFactory(app, configWord, overrides?): Promise<BigNumber>;
    registerAppWithKey(configWord, registrationKey, overrides?): Promise<BigNumber>;
    removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>;
    replaceGovernance(newGov, overrides?): Promise<BigNumber>;
    updateAgreementClass(agreementClassLogic, overrides?): Promise<BigNumber>;
    updateCode(newAddress, overrides?): Promise<BigNumber>;
    updatePoolBeaconLogic(newLogic, overrides?): Promise<BigNumber>;
    updateSuperTokenFactory(newFactory, overrides?): Promise<BigNumber>;
    updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<BigNumber>;
    versionRecipient(overrides?): Promise<BigNumber>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • allowCompositeApp:function
    • allowCompositeApp(targetApp, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • appCallbackPop:function
    • appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<BigNumber>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedDelta: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • appCallbackPush:function
    • appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<BigNumber>

    • Parameters

      • ctx: BytesLike
      • app: string
      • appCreditGranted: BigNumberish
      • appCreditUsed: BigNumberish
      • appCreditToken: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • batchCall:function
    • batchCall(operations, overrides?): Promise<BigNumber>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: PayableOverrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • callAgreement:function
    • callAgreement(agreementClass, callData, userData, overrides?): Promise<BigNumber>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • callAgreementWithContext:function
    • callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • callAppAction:function
    • callAppAction(app, callData, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • callAppActionWithContext:function
    • callAppActionWithContext(app, callData, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • callData: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • callAppAfterCallback:function
    • callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • callAppBeforeCallback:function
    • callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • changeSuperTokenAdmin:function
    • changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • ctxUseCredit:function
    • ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<BigNumber>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedMore: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • decodeCtx:function
    • decodeCtx(ctx, overrides?): Promise<BigNumber>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • forwardBatchCall:function
    • forwardBatchCall(operations, overrides?): Promise<BigNumber>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getAppCallbackLevel:function
    • getAppCallbackLevel(appAddr, overrides?): Promise<BigNumber>

    • Parameters

      • appAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getAppManifest:function
    • getAppManifest(app, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • isAgreementClassListed:function
    • isAgreementClassListed(agreementClass, overrides?): Promise<BigNumber>

    • Parameters

      • agreementClass: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isApp:function
    • isApp(app, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isAppJailed:function
    • isAppJailed(app, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isCompositeAppAllowed:function
    • isCompositeAppAllowed(app, targetApp, overrides?): Promise<BigNumber>

    • Parameters

      • app: string
      • targetApp: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isCtxValid:function
    • isCtxValid(ctx, overrides?): Promise<BigNumber>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isTrustedForwarder:function
    • isTrustedForwarder(forwarder, overrides?): Promise<BigNumber>

    • Parameters

      • forwarder: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • jailApp:function
    • jailApp(ctx, app, reason, overrides?): Promise<BigNumber>

    • Parameters

      • ctx: BytesLike
      • app: string
      • reason: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • mapAgreementClasses:function
    • mapAgreementClasses(bitmap, overrides?): Promise<BigNumber>

    • Parameters

      • bitmap: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • registerAgreementClass:function
    • registerAgreementClass(agreementClassLogic, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • registerApp(address,uint256):function
    • registerApp(address,uint256)(app, configWord, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • registerApp(uint256):function
    • registerApp(uint256)(configWord, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • registerAppByFactory:function
    • registerAppByFactory(app, configWord, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • registerAppWithKey:function
    • registerAppWithKey(configWord, registrationKey, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • replaceGovernance:function
    • replaceGovernance(newGov, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • updateAgreementClass:function
    • updateAgreementClass(agreementClassLogic, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • updatePoolBeaconLogic:function
    • updatePoolBeaconLogic(newLogic, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • updateSuperTokenFactory:function
    • updateSuperTokenFactory(newFactory, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • updateSuperTokenLogic:function
    • updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

filters

filters: {
    AgreementClassRegistered(agreementType?, code?): AgreementClassRegisteredEventFilter;
    AgreementClassRegistered(bytes32,address)(agreementType?, code?): AgreementClassRegisteredEventFilter;
    AgreementClassUpdated(agreementType?, code?): AgreementClassUpdatedEventFilter;
    AgreementClassUpdated(bytes32,address)(agreementType?, code?): AgreementClassUpdatedEventFilter;
    AppRegistered(app?): AppRegisteredEventFilter;
    AppRegistered(address)(app?): AppRegisteredEventFilter;
    CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter;
    CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter;
    GovernanceReplaced(oldGov?, newGov?): GovernanceReplacedEventFilter;
    GovernanceReplaced(address,address)(oldGov?, newGov?): GovernanceReplacedEventFilter;
    Initialized(version?): InitializedEventFilter;
    Initialized(uint8)(version?): InitializedEventFilter;
    Jail(app?, reason?): JailEventFilter;
    Jail(address,uint256)(app?, reason?): JailEventFilter;
    PoolBeaconLogicUpdated(beaconProxy?, newBeaconLogic?): PoolBeaconLogicUpdatedEventFilter;
    PoolBeaconLogicUpdated(address,address)(beaconProxy?, newBeaconLogic?): PoolBeaconLogicUpdatedEventFilter;
    SuperTokenFactoryUpdated(newFactory?): SuperTokenFactoryUpdatedEventFilter;
    SuperTokenFactoryUpdated(address)(newFactory?): SuperTokenFactoryUpdatedEventFilter;
    SuperTokenLogicUpdated(token?, code?): SuperTokenLogicUpdatedEventFilter;
    SuperTokenLogicUpdated(address,address)(token?, code?): SuperTokenLogicUpdatedEventFilter;
}

Type declaration

  • AgreementClassRegistered:function
    • AgreementClassRegistered(agreementType?, code?): AgreementClassRegisteredEventFilter

    • Parameters

      • Optional agreementType: null
      • Optional code: null

      Returns AgreementClassRegisteredEventFilter

  • AgreementClassRegistered(bytes32,address):function
    • AgreementClassRegistered(bytes32,address)(agreementType?, code?): AgreementClassRegisteredEventFilter

    • Parameters

      • Optional agreementType: null
      • Optional code: null

      Returns AgreementClassRegisteredEventFilter

  • AgreementClassUpdated:function
    • AgreementClassUpdated(agreementType?, code?): AgreementClassUpdatedEventFilter

    • Parameters

      • Optional agreementType: null
      • Optional code: null

      Returns AgreementClassUpdatedEventFilter

  • AgreementClassUpdated(bytes32,address):function
    • AgreementClassUpdated(bytes32,address)(agreementType?, code?): AgreementClassUpdatedEventFilter

    • Parameters

      • Optional agreementType: null
      • Optional code: null

      Returns AgreementClassUpdatedEventFilter

  • AppRegistered:function
    • AppRegistered(app?): AppRegisteredEventFilter

    • Parameters

      • Optional app: null | string

      Returns AppRegisteredEventFilter

  • AppRegistered(address):function
    • AppRegistered(address)(app?): AppRegisteredEventFilter

    • Parameters

      • Optional app: null | string

      Returns AppRegisteredEventFilter

  • 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

  • GovernanceReplaced:function
    • GovernanceReplaced(oldGov?, newGov?): GovernanceReplacedEventFilter

    • Parameters

      • Optional oldGov: null
      • Optional newGov: null

      Returns GovernanceReplacedEventFilter

  • GovernanceReplaced(address,address):function
    • GovernanceReplaced(address,address)(oldGov?, newGov?): GovernanceReplacedEventFilter

    • Parameters

      • Optional oldGov: null
      • Optional newGov: null

      Returns GovernanceReplacedEventFilter

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

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

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

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

  • Jail:function
    • Jail(app?, reason?): JailEventFilter

    • Parameters

      • Optional app: null | string
      • Optional reason: null

      Returns JailEventFilter

  • Jail(address,uint256):function
    • Jail(address,uint256)(app?, reason?): JailEventFilter

    • Parameters

      • Optional app: null | string
      • Optional reason: null

      Returns JailEventFilter

  • PoolBeaconLogicUpdated:function
    • PoolBeaconLogicUpdated(beaconProxy?, newBeaconLogic?): PoolBeaconLogicUpdatedEventFilter

    • Parameters

      • Optional beaconProxy: null | string
      • Optional newBeaconLogic: null

      Returns PoolBeaconLogicUpdatedEventFilter

  • PoolBeaconLogicUpdated(address,address):function
    • PoolBeaconLogicUpdated(address,address)(beaconProxy?, newBeaconLogic?): PoolBeaconLogicUpdatedEventFilter

    • Parameters

      • Optional beaconProxy: null | string
      • Optional newBeaconLogic: null

      Returns PoolBeaconLogicUpdatedEventFilter

  • SuperTokenFactoryUpdated:function
    • SuperTokenFactoryUpdated(newFactory?): SuperTokenFactoryUpdatedEventFilter

    • Parameters

      • Optional newFactory: null

      Returns SuperTokenFactoryUpdatedEventFilter

  • SuperTokenFactoryUpdated(address):function
    • SuperTokenFactoryUpdated(address)(newFactory?): SuperTokenFactoryUpdatedEventFilter

    • Parameters

      • Optional newFactory: null

      Returns SuperTokenFactoryUpdatedEventFilter

  • SuperTokenLogicUpdated:function
    • SuperTokenLogicUpdated(token?, code?): SuperTokenLogicUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional code: null

      Returns SuperTokenLogicUpdatedEventFilter

  • SuperTokenLogicUpdated(address,address):function
    • SuperTokenLogicUpdated(address,address)(token?, code?): SuperTokenLogicUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional code: null

      Returns SuperTokenLogicUpdatedEventFilter

functions

functions: {
    APP_WHITE_LISTING_ENABLED(overrides?): Promise<[boolean]>;
    CALLBACK_GAS_LIMIT(overrides?): Promise<[BigNumber]>;
    MAX_APP_CALLBACK_LEVEL(overrides?): Promise<[BigNumber]>;
    MAX_NUM_AGREEMENTS(overrides?): Promise<[number]>;
    NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<[boolean]>;
    addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<[BigNumber] & {
        newBitmap: BigNumber;
    }>;
    allowCompositeApp(targetApp, overrides?): Promise<ContractTransaction>;
    appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<ContractTransaction>;
    appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<ContractTransaction>;
    batchCall(operations, overrides?): Promise<ContractTransaction>;
    callAgreement(agreementClass, callData, userData, overrides?): Promise<ContractTransaction>;
    callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<ContractTransaction>;
    callAppAction(app, callData, overrides?): Promise<ContractTransaction>;
    callAppActionWithContext(app, callData, ctx, overrides?): Promise<ContractTransaction>;
    callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>;
    callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>;
    castrate(overrides?): Promise<ContractTransaction>;
    changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<ContractTransaction>;
    ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<ContractTransaction>;
    decodeCtx(ctx, overrides?): Promise<[ContextStructOutput] & {
        context: ContextStructOutput;
    }>;
    forwardBatchCall(operations, overrides?): Promise<ContractTransaction>;
    getAgreementClass(agreementType, overrides?): Promise<[string] & {
        agreementClass: string;
    }>;
    getAppCallbackLevel(appAddr, overrides?): Promise<[number]>;
    getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
        isJailed: boolean;
        isSuperApp: boolean;
        noopMask: BigNumber;
    }>;
    getCodeAddress(overrides?): Promise<[string] & {
        codeAddress: string;
    }>;
    getGovernance(overrides?): Promise<[string]>;
    getNow(overrides?): Promise<[BigNumber]>;
    getSuperTokenFactory(overrides?): Promise<[string] & {
        factory: string;
    }>;
    getSuperTokenFactoryLogic(overrides?): Promise<[string] & {
        logic: string;
    }>;
    initialize(gov, overrides?): Promise<ContractTransaction>;
    isAgreementClassListed(agreementClass, overrides?): Promise<[boolean] & {
        yes: boolean;
    }>;
    isAgreementTypeListed(agreementType, overrides?): Promise<[boolean] & {
        yes: boolean;
    }>;
    isApp(app, overrides?): Promise<[boolean]>;
    isAppJailed(app, overrides?): Promise<[boolean]>;
    isCompositeAppAllowed(app, targetApp, overrides?): Promise<[boolean]>;
    isCtxValid(ctx, overrides?): Promise<[boolean]>;
    isTrustedForwarder(forwarder, overrides?): Promise<[boolean]>;
    jailApp(ctx, app, reason, overrides?): Promise<ContractTransaction>;
    mapAgreementClasses(bitmap, overrides?): Promise<[string[]] & {
        agreementClasses: string[];
    }>;
    proxiableUUID(overrides?): Promise<[string]>;
    registerAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>;
    registerApp(address,uint256)(app, configWord, overrides?): Promise<ContractTransaction>;
    registerApp(uint256)(configWord, overrides?): Promise<ContractTransaction>;
    registerAppByFactory(app, configWord, overrides?): Promise<ContractTransaction>;
    registerAppWithKey(configWord, registrationKey, overrides?): Promise<ContractTransaction>;
    removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<[BigNumber] & {
        newBitmap: BigNumber;
    }>;
    replaceGovernance(newGov, overrides?): Promise<ContractTransaction>;
    updateAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>;
    updateCode(newAddress, overrides?): Promise<ContractTransaction>;
    updatePoolBeaconLogic(newLogic, overrides?): Promise<ContractTransaction>;
    updateSuperTokenFactory(newFactory, overrides?): Promise<ContractTransaction>;
    updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<ContractTransaction>;
    versionRecipient(overrides?): Promise<[string]>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • CALLBACK_GAS_LIMIT:function
    • CALLBACK_GAS_LIMIT(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • MAX_APP_CALLBACK_LEVEL:function
    • MAX_APP_CALLBACK_LEVEL(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[number]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • addToAgreementClassesBitmap:function
    • addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<[BigNumber] & {
          newBitmap: BigNumber;
      }>

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & {
          newBitmap: BigNumber;
      }>

  • allowCompositeApp:function
    • allowCompositeApp(targetApp, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • appCallbackPop:function
    • appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<ContractTransaction>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedDelta: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • appCallbackPush:function
    • appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<ContractTransaction>

    • Parameters

      • ctx: BytesLike
      • app: string
      • appCreditGranted: BigNumberish
      • appCreditUsed: BigNumberish
      • appCreditToken: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • batchCall:function
    • batchCall(operations, overrides?): Promise<ContractTransaction>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: PayableOverrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • callAgreement:function
    • callAgreement(agreementClass, callData, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • callAgreementWithContext:function
    • callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • callAppAction:function
    • callAppAction(app, callData, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • callAppActionWithContext:function
    • callAppActionWithContext(app, callData, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • app: string
      • callData: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • callAppAfterCallback:function
    • callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • callAppBeforeCallback:function
    • callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • changeSuperTokenAdmin:function
    • changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • ctxUseCredit:function
    • ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<ContractTransaction>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedMore: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • decodeCtx:function
    • decodeCtx(ctx, overrides?): Promise<[ContextStructOutput] & {
          context: ContextStructOutput;
      }>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[ContextStructOutput] & {
          context: ContextStructOutput;
      }>

  • forwardBatchCall:function
    • forwardBatchCall(operations, overrides?): Promise<ContractTransaction>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • getAgreementClass:function
    • getAgreementClass(agreementType, overrides?): Promise<[string] & {
          agreementClass: string;
      }>

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

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

  • getAppCallbackLevel:function
    • getAppCallbackLevel(appAddr, overrides?): Promise<[number]>

    • Parameters

      • appAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<[number]>

  • getAppManifest:function
    • getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
          isJailed: boolean;
          isSuperApp: boolean;
          noopMask: BigNumber;
      }>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean, boolean, BigNumber] & {
          isJailed: boolean;
          isSuperApp: boolean;
          noopMask: BigNumber;
      }>

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

    • Parameters

      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • getNow:function
    • getNow(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

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

    • Parameters

      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

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

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • isAgreementClassListed:function
    • isAgreementClassListed(agreementClass, overrides?): Promise<[boolean] & {
          yes: boolean;
      }>

    • Parameters

      • agreementClass: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean] & {
          yes: boolean;
      }>

  • isAgreementTypeListed:function
    • isAgreementTypeListed(agreementType, overrides?): Promise<[boolean] & {
          yes: boolean;
      }>

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[boolean] & {
          yes: boolean;
      }>

  • isApp:function
    • isApp(app, overrides?): Promise<[boolean]>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isAppJailed:function
    • isAppJailed(app, overrides?): Promise<[boolean]>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isCompositeAppAllowed:function
    • isCompositeAppAllowed(app, targetApp, overrides?): Promise<[boolean]>

    • Parameters

      • app: string
      • targetApp: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isCtxValid:function
    • isCtxValid(ctx, overrides?): Promise<[boolean]>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isTrustedForwarder:function
    • isTrustedForwarder(forwarder, overrides?): Promise<[boolean]>

    • Parameters

      • forwarder: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • jailApp:function
    • jailApp(ctx, app, reason, overrides?): Promise<ContractTransaction>

    • Parameters

      • ctx: BytesLike
      • app: string
      • reason: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • mapAgreementClasses:function
    • mapAgreementClasses(bitmap, overrides?): Promise<[string[]] & {
          agreementClasses: string[];
      }>

    • Parameters

      • bitmap: BigNumberish
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • registerAgreementClass:function
    • registerAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerApp(address,uint256):function
    • registerApp(address,uint256)(app, configWord, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerApp(uint256):function
    • registerApp(uint256)(configWord, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerAppByFactory:function
    • registerAppByFactory(app, configWord, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • registerAppWithKey:function
    • registerAppWithKey(configWord, registrationKey, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • removeFromAgreementClassesBitmap:function
    • removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<[BigNumber] & {
          newBitmap: BigNumber;
      }>

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & {
          newBitmap: BigNumber;
      }>

  • replaceGovernance:function
    • replaceGovernance(newGov, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateAgreementClass:function
    • updateAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updatePoolBeaconLogic:function
    • updatePoolBeaconLogic(newLogic, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateSuperTokenFactory:function
    • updateSuperTokenFactory(newFactory, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateSuperTokenLogic:function
    • updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

interface

interface: SuperfluidInterface

off

off: OnEvent<Superfluid>

on

on: OnEvent<Superfluid>

once

once: OnEvent<Superfluid>

populateTransaction

populateTransaction: {
    APP_WHITE_LISTING_ENABLED(overrides?): Promise<PopulatedTransaction>;
    CALLBACK_GAS_LIMIT(overrides?): Promise<PopulatedTransaction>;
    MAX_APP_CALLBACK_LEVEL(overrides?): Promise<PopulatedTransaction>;
    MAX_NUM_AGREEMENTS(overrides?): Promise<PopulatedTransaction>;
    NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<PopulatedTransaction>;
    addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<PopulatedTransaction>;
    allowCompositeApp(targetApp, overrides?): Promise<PopulatedTransaction>;
    appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<PopulatedTransaction>;
    appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<PopulatedTransaction>;
    batchCall(operations, overrides?): Promise<PopulatedTransaction>;
    callAgreement(agreementClass, callData, userData, overrides?): Promise<PopulatedTransaction>;
    callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<PopulatedTransaction>;
    callAppAction(app, callData, overrides?): Promise<PopulatedTransaction>;
    callAppActionWithContext(app, callData, ctx, overrides?): Promise<PopulatedTransaction>;
    callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<PopulatedTransaction>;
    callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<PopulatedTransaction>;
    castrate(overrides?): Promise<PopulatedTransaction>;
    changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<PopulatedTransaction>;
    ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<PopulatedTransaction>;
    decodeCtx(ctx, overrides?): Promise<PopulatedTransaction>;
    forwardBatchCall(operations, overrides?): Promise<PopulatedTransaction>;
    getAgreementClass(agreementType, overrides?): Promise<PopulatedTransaction>;
    getAppCallbackLevel(appAddr, overrides?): Promise<PopulatedTransaction>;
    getAppManifest(app, overrides?): Promise<PopulatedTransaction>;
    getCodeAddress(overrides?): Promise<PopulatedTransaction>;
    getGovernance(overrides?): Promise<PopulatedTransaction>;
    getNow(overrides?): Promise<PopulatedTransaction>;
    getSuperTokenFactory(overrides?): Promise<PopulatedTransaction>;
    getSuperTokenFactoryLogic(overrides?): Promise<PopulatedTransaction>;
    initialize(gov, overrides?): Promise<PopulatedTransaction>;
    isAgreementClassListed(agreementClass, overrides?): Promise<PopulatedTransaction>;
    isAgreementTypeListed(agreementType, overrides?): Promise<PopulatedTransaction>;
    isApp(app, overrides?): Promise<PopulatedTransaction>;
    isAppJailed(app, overrides?): Promise<PopulatedTransaction>;
    isCompositeAppAllowed(app, targetApp, overrides?): Promise<PopulatedTransaction>;
    isCtxValid(ctx, overrides?): Promise<PopulatedTransaction>;
    isTrustedForwarder(forwarder, overrides?): Promise<PopulatedTransaction>;
    jailApp(ctx, app, reason, overrides?): Promise<PopulatedTransaction>;
    mapAgreementClasses(bitmap, overrides?): Promise<PopulatedTransaction>;
    proxiableUUID(overrides?): Promise<PopulatedTransaction>;
    registerAgreementClass(agreementClassLogic, overrides?): Promise<PopulatedTransaction>;
    registerApp(address,uint256)(app, configWord, overrides?): Promise<PopulatedTransaction>;
    registerApp(uint256)(configWord, overrides?): Promise<PopulatedTransaction>;
    registerAppByFactory(app, configWord, overrides?): Promise<PopulatedTransaction>;
    registerAppWithKey(configWord, registrationKey, overrides?): Promise<PopulatedTransaction>;
    removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<PopulatedTransaction>;
    replaceGovernance(newGov, overrides?): Promise<PopulatedTransaction>;
    updateAgreementClass(agreementClassLogic, overrides?): Promise<PopulatedTransaction>;
    updateCode(newAddress, overrides?): Promise<PopulatedTransaction>;
    updatePoolBeaconLogic(newLogic, overrides?): Promise<PopulatedTransaction>;
    updateSuperTokenFactory(newFactory, overrides?): Promise<PopulatedTransaction>;
    updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<PopulatedTransaction>;
    versionRecipient(overrides?): Promise<PopulatedTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • allowCompositeApp:function
    • allowCompositeApp(targetApp, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • appCallbackPop:function
    • appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedDelta: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • appCallbackPush:function
    • appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ctx: BytesLike
      • app: string
      • appCreditGranted: BigNumberish
      • appCreditUsed: BigNumberish
      • appCreditToken: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • batchCall:function
    • batchCall(operations, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: PayableOverrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • callAgreement:function
    • callAgreement(agreementClass, callData, userData, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • callAgreementWithContext:function
    • callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • agreementClass: string
      • callData: BytesLike
      • userData: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • callAppAction:function
    • callAppAction(app, callData, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • callAppActionWithContext:function
    • callAppActionWithContext(app, callData, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • callData: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • callAppAfterCallback:function
    • callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • callAppBeforeCallback:function
    • callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • callData: BytesLike
      • isTermination: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • ctxUseCredit:function
    • ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ctx: BytesLike
      • appCreditUsedMore: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • decodeCtx:function
    • decodeCtx(ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • forwardBatchCall:function
    • forwardBatchCall(operations, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • operations: OperationStruct[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getAppCallbackLevel:function
    • getAppCallbackLevel(appAddr, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • appAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getAppManifest:function
    • getAppManifest(app, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • isAgreementClassListed:function
    • isAgreementClassListed(agreementClass, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • agreementClass: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isApp:function
    • isApp(app, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isAppJailed:function
    • isAppJailed(app, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isCompositeAppAllowed:function
    • isCompositeAppAllowed(app, targetApp, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • app: string
      • targetApp: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isCtxValid:function
    • isCtxValid(ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isTrustedForwarder:function
    • isTrustedForwarder(forwarder, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • forwarder: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • jailApp:function
    • jailApp(ctx, app, reason, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • ctx: BytesLike
      • app: string
      • reason: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • mapAgreementClasses:function
    • mapAgreementClasses(bitmap, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • bitmap: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • registerAgreementClass:function
    • registerAgreementClass(agreementClassLogic, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerApp(address,uint256):function
    • registerApp(address,uint256)(app, configWord, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerApp(uint256):function
    • registerApp(uint256)(configWord, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerAppByFactory:function
    • registerAppByFactory(app, configWord, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • registerAppWithKey:function
    • registerAppWithKey(configWord, registrationKey, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • bitmap: BigNumberish
      • agreementType: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • replaceGovernance:function
    • replaceGovernance(newGov, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updateAgreementClass:function
    • updateAgreementClass(agreementClassLogic, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updatePoolBeaconLogic:function
    • updatePoolBeaconLogic(newLogic, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updateSuperTokenFactory:function
    • updateSuperTokenFactory(newFactory, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<Superfluid>

Methods

APP_WHITE_LISTING_ENABLED

  • APP_WHITE_LISTING_ENABLED(overrides?): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

CALLBACK_GAS_LIMIT

  • CALLBACK_GAS_LIMIT(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

MAX_APP_CALLBACK_LEVEL

  • MAX_APP_CALLBACK_LEVEL(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

MAX_NUM_AGREEMENTS

  • MAX_NUM_AGREEMENTS(overrides?): Promise<number>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<number>

NON_UPGRADABLE_DEPLOYMENT

  • NON_UPGRADABLE_DEPLOYMENT(overrides?): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

addToAgreementClassesBitmap

  • addToAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>

  • Parameters

    • bitmap: BigNumberish
    • agreementType: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

allowCompositeApp

  • allowCompositeApp(targetApp, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

appCallbackPop

  • appCallbackPop(ctx, appCreditUsedDelta, overrides?): Promise<ContractTransaction>

  • Parameters

    • ctx: BytesLike
    • appCreditUsedDelta: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

appCallbackPush

  • appCallbackPush(ctx, app, appCreditGranted, appCreditUsed, appCreditToken, overrides?): Promise<ContractTransaction>

  • Parameters

    • ctx: BytesLike
    • app: string
    • appCreditGranted: BigNumberish
    • appCreditUsed: BigNumberish
    • appCreditToken: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

batchCall

  • batchCall(operations, overrides?): Promise<ContractTransaction>

  • Parameters

    • operations: OperationStruct[]
    • Optional overrides: PayableOverrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

callAgreement

  • callAgreement(agreementClass, callData, userData, overrides?): Promise<ContractTransaction>

  • Parameters

    • agreementClass: string
    • callData: BytesLike
    • userData: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

callAgreementWithContext

  • callAgreementWithContext(agreementClass, callData, userData, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • agreementClass: string
    • callData: BytesLike
    • userData: BytesLike
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

callAppAction

  • callAppAction(app, callData, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

callAppActionWithContext

  • callAppActionWithContext(app, callData, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • app: string
    • callData: BytesLike
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

callAppAfterCallback

  • callAppAfterCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • app: string
    • callData: BytesLike
    • isTermination: boolean
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

callAppBeforeCallback

  • callAppBeforeCallback(app, callData, isTermination, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • app: string
    • callData: BytesLike
    • isTermination: boolean
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

castrate

  • castrate(overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

changeSuperTokenAdmin

  • changeSuperTokenAdmin(token, newAdmin, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

ctxUseCredit

  • ctxUseCredit(ctx, appCreditUsedMore, overrides?): Promise<ContractTransaction>

  • Parameters

    • ctx: BytesLike
    • appCreditUsedMore: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

decodeCtx

  • decodeCtx(ctx, overrides?): Promise<ContextStructOutput>

  • Parameters

    • ctx: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<ContextStructOutput>

deployed

  • deployed(): Promise<Superfluid>

  • Returns Promise<Superfluid>

forwardBatchCall

  • forwardBatchCall(operations, overrides?): Promise<ContractTransaction>

  • Parameters

    • operations: OperationStruct[]
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

getAgreementClass

  • getAgreementClass(agreementType, overrides?): Promise<string>

  • Parameters

    • agreementType: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<string>

getAppCallbackLevel

  • getAppCallbackLevel(appAddr, overrides?): Promise<number>

  • Parameters

    • appAddr: string
    • Optional overrides: CallOverrides

    Returns Promise<number>

getAppManifest

  • getAppManifest(app, overrides?): Promise<[boolean, boolean, BigNumber] & {
        isJailed: boolean;
        isSuperApp: boolean;
        noopMask: BigNumber;
    }>

  • Parameters

    • app: string
    • Optional overrides: CallOverrides

    Returns Promise<[boolean, boolean, BigNumber] & {
        isJailed: boolean;
        isSuperApp: boolean;
        noopMask: BigNumber;
    }>

getCodeAddress

  • getCodeAddress(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getGovernance

  • getGovernance(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getNow

  • getNow(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getSuperTokenFactory

  • getSuperTokenFactory(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getSuperTokenFactoryLogic

  • getSuperTokenFactoryLogic(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

initialize

  • initialize(gov, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

isAgreementClassListed

  • isAgreementClassListed(agreementClass, overrides?): Promise<boolean>

  • Parameters

    • agreementClass: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isAgreementTypeListed

  • isAgreementTypeListed(agreementType, overrides?): Promise<boolean>

  • Parameters

    • agreementType: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isApp

  • isApp(app, overrides?): Promise<boolean>

  • Parameters

    • app: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isAppJailed

  • isAppJailed(app, overrides?): Promise<boolean>

  • Parameters

    • app: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isCompositeAppAllowed

  • isCompositeAppAllowed(app, targetApp, overrides?): Promise<boolean>

  • Parameters

    • app: string
    • targetApp: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isCtxValid

  • isCtxValid(ctx, overrides?): Promise<boolean>

  • Parameters

    • ctx: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isTrustedForwarder

  • isTrustedForwarder(forwarder, overrides?): Promise<boolean>

  • Parameters

    • forwarder: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

jailApp

  • jailApp(ctx, app, reason, overrides?): Promise<ContractTransaction>

  • Parameters

    • ctx: BytesLike
    • app: string
    • reason: BigNumberish
    • 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[]

mapAgreementClasses

  • mapAgreementClasses(bitmap, overrides?): Promise<string[]>

  • Parameters

    • bitmap: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string[]>

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

registerAgreementClass

  • registerAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

registerApp(address,uint256)

  • registerApp(address,uint256)(app, configWord, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

registerApp(uint256)

  • registerApp(uint256)(configWord, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

registerAppByFactory

  • registerAppByFactory(app, configWord, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

registerAppWithKey

  • registerAppWithKey(configWord, registrationKey, overrides?): Promise<ContractTransaction>

  • Parameters

    • configWord: BigNumberish
    • registrationKey: string
    • Optional overrides: Overrides & {
          from?: 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

removeFromAgreementClassesBitmap

  • removeFromAgreementClassesBitmap(bitmap, agreementType, overrides?): Promise<BigNumber>

  • Parameters

    • bitmap: BigNumberish
    • agreementType: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

replaceGovernance

  • replaceGovernance(newGov, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateAgreementClass

  • updateAgreementClass(agreementClassLogic, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateCode

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

  • Parameters

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

    Returns Promise<ContractTransaction>

updatePoolBeaconLogic

  • updatePoolBeaconLogic(newLogic, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateSuperTokenFactory

  • updateSuperTokenFactory(newFactory, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateSuperTokenLogic

  • updateSuperTokenLogic(token, newLogicOverride, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

versionRecipient

  • versionRecipient(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc