Constructors

Properties

Methods

Constructors

Properties

abi: readonly [{
    inputs: readonly [];
    name: "GDA_ADMIN_CANNOT_BE_POOL";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_DISTRIBUTE_FOR_OTHERS_NOT_ALLOWED";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_DISTRIBUTE_FROM_ANY_ADDRESS_NOT_ALLOWED";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_FLOW_DOES_NOT_EXIST";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_INSUFFICIENT_BALANCE";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_NON_CRITICAL_SENDER";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_NOT_POOL_ADMIN";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_NO_NEGATIVE_FLOW_RATE";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_NO_ZERO_ADDRESS_ADMIN";
    type: "error";
}, {
    inputs: readonly [];
    name: "GDA_ONLY_SUPER_TOKEN_POOL";
    type: "error";
}, {
    anonymous: false;
    inputs: readonly [{
        indexed: true;
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        indexed: true;
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        indexed: true;
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        indexed: false;
        internalType: "int256";
        name: "bufferDelta";
        type: "int256";
    }, {
        indexed: false;
        internalType: "uint256";
        name: "newBufferAmount";
        type: "uint256";
    }, {
        indexed: false;
        internalType: "uint256";
        name: "totalBufferAmount";
        type: "uint256";
    }];
    name: "BufferAdjusted";
    type: "event";
}, {
    anonymous: false;
    inputs: readonly [{
        indexed: true;
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        indexed: true;
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        indexed: true;
        internalType: "address";
        name: "distributor";
        type: "address";
    }, {
        indexed: false;
        internalType: "address";
        name: "operator";
        type: "address";
    }, {
        indexed: false;
        internalType: "int96";
        name: "oldFlowRate";
        type: "int96";
    }, {
        indexed: false;
        internalType: "int96";
        name: "newDistributorToPoolFlowRate";
        type: "int96";
    }, {
        indexed: false;
        internalType: "int96";
        name: "newTotalDistributionFlowRate";
        type: "int96";
    }, {
        indexed: false;
        internalType: "address";
        name: "adjustmentFlowRecipient";
        type: "address";
    }, {
        indexed: false;
        internalType: "int96";
        name: "adjustmentFlowRate";
        type: "int96";
    }, {
        indexed: false;
        internalType: "bytes";
        name: "userData";
        type: "bytes";
    }];
    name: "FlowDistributionUpdated";
    type: "event";
}, {
    anonymous: false;
    inputs: readonly [{
        indexed: true;
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        indexed: true;
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        indexed: true;
        internalType: "address";
        name: "distributor";
        type: "address";
    }, {
        indexed: false;
        internalType: "address";
        name: "operator";
        type: "address";
    }, {
        indexed: false;
        internalType: "uint256";
        name: "requestedAmount";
        type: "uint256";
    }, {
        indexed: false;
        internalType: "uint256";
        name: "actualAmount";
        type: "uint256";
    }, {
        indexed: false;
        internalType: "bytes";
        name: "userData";
        type: "bytes";
    }];
    name: "InstantDistributionUpdated";
    type: "event";
}, {
    anonymous: false;
    inputs: readonly [{
        indexed: true;
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        indexed: true;
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        indexed: true;
        internalType: "address";
        name: "account";
        type: "address";
    }, {
        indexed: false;
        internalType: "bool";
        name: "connected";
        type: "bool";
    }, {
        indexed: false;
        internalType: "bytes";
        name: "userData";
        type: "bytes";
    }];
    name: "PoolConnectionUpdated";
    type: "event";
}, {
    anonymous: false;
    inputs: readonly [{
        indexed: true;
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        indexed: true;
        internalType: "address";
        name: "admin";
        type: "address";
    }, {
        indexed: false;
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }];
    name: "PoolCreated";
    type: "event";
}, {
    inputs: readonly [];
    name: "agreementType";
    outputs: readonly [{
        internalType: "bytes32";
        name: "";
        type: "bytes32";
    }];
    stateMutability: "pure";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "address";
        name: "memberAddress";
        type: "address";
    }, {
        internalType: "bytes";
        name: "ctx";
        type: "bytes";
    }];
    name: "claimAll";
    outputs: readonly [{
        internalType: "bytes";
        name: "newCtx";
        type: "bytes";
    }];
    stateMutability: "nonpayable";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "bytes";
        name: "ctx";
        type: "bytes";
    }];
    name: "connectPool";
    outputs: readonly [{
        internalType: "bytes";
        name: "newCtx";
        type: "bytes";
    }];
    stateMutability: "nonpayable";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "admin";
        type: "address";
    }, {
        components: readonly [{
            internalType: "bool";
            name: "transferabilityForUnitsOwner";
            type: "bool";
        }, {
            internalType: "bool";
            name: "distributionFromAnyAddress";
            type: "bool";
        }];
        internalType: "struct PoolConfig";
        name: "poolConfig";
        type: "tuple";
    }];
    name: "createPool";
    outputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }];
    stateMutability: "nonpayable";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "bytes";
        name: "ctx";
        type: "bytes";
    }];
    name: "disconnectPool";
    outputs: readonly [{
        internalType: "bytes";
        name: "newCtx";
        type: "bytes";
    }];
    stateMutability: "nonpayable";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "uint256";
        name: "requestedAmount";
        type: "uint256";
    }, {
        internalType: "bytes";
        name: "ctx";
        type: "bytes";
    }];
    name: "distribute";
    outputs: readonly [{
        internalType: "bytes";
        name: "newCtx";
        type: "bytes";
    }];
    stateMutability: "nonpayable";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "int96";
        name: "requestedFlowRate";
        type: "int96";
    }, {
        internalType: "bytes";
        name: "ctx";
        type: "bytes";
    }];
    name: "distributeFlow";
    outputs: readonly [{
        internalType: "bytes";
        name: "newCtx";
        type: "bytes";
    }];
    stateMutability: "nonpayable";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        internalType: "contract ISuperfluidPool";
        name: "to";
        type: "address";
    }, {
        internalType: "uint256";
        name: "requestedAmount";
        type: "uint256";
    }];
    name: "estimateDistributionActualAmount";
    outputs: readonly [{
        internalType: "uint256";
        name: "actualAmount";
        type: "uint256";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        internalType: "contract ISuperfluidPool";
        name: "to";
        type: "address";
    }, {
        internalType: "int96";
        name: "requestedFlowRate";
        type: "int96";
    }];
    name: "estimateFlowDistributionActualFlowRate";
    outputs: readonly [{
        internalType: "int96";
        name: "actualFlowRate";
        type: "int96";
    }, {
        internalType: "int96";
        name: "totalDistributionFlowRate";
        type: "int96";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "account";
        type: "address";
    }];
    name: "getAccountFlowInfo";
    outputs: readonly [{
        internalType: "uint256";
        name: "timestamp";
        type: "uint256";
    }, {
        internalType: "int96";
        name: "flowRate";
        type: "int96";
    }, {
        internalType: "uint256";
        name: "deposit";
        type: "uint256";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        internalType: "contract ISuperfluidPool";
        name: "to";
        type: "address";
    }];
    name: "getFlow";
    outputs: readonly [{
        internalType: "uint256";
        name: "lastUpdated";
        type: "uint256";
    }, {
        internalType: "int96";
        name: "flowRate";
        type: "int96";
    }, {
        internalType: "uint256";
        name: "deposit";
        type: "uint256";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "from";
        type: "address";
    }, {
        internalType: "contract ISuperfluidPool";
        name: "to";
        type: "address";
    }];
    name: "getFlowRate";
    outputs: readonly [{
        internalType: "int96";
        name: "";
        type: "int96";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "account";
        type: "address";
    }];
    name: "getNetFlow";
    outputs: readonly [{
        internalType: "int96";
        name: "";
        type: "int96";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }];
    name: "getPoolAdjustmentFlowInfo";
    outputs: readonly [{
        internalType: "address";
        name: "";
        type: "address";
    }, {
        internalType: "bytes32";
        name: "";
        type: "bytes32";
    }, {
        internalType: "int96";
        name: "";
        type: "int96";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "address";
        name: "pool";
        type: "address";
    }];
    name: "getPoolAdjustmentFlowRate";
    outputs: readonly [{
        internalType: "int96";
        name: "";
        type: "int96";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "address";
        name: "memberAddr";
        type: "address";
    }];
    name: "isMemberConnected";
    outputs: readonly [{
        internalType: "bool";
        name: "";
        type: "bool";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "account";
        type: "address";
    }, {
        internalType: "uint256";
        name: "timestamp";
        type: "uint256";
    }];
    name: "isPatricianPeriod";
    outputs: readonly [{
        internalType: "bool";
        name: "";
        type: "bool";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "account";
        type: "address";
    }];
    name: "isPatricianPeriodNow";
    outputs: readonly [{
        internalType: "bool";
        name: "isCurrentlyPatricianPeriod";
        type: "bool";
    }, {
        internalType: "uint256";
        name: "timestamp";
        type: "uint256";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "account";
        type: "address";
    }];
    name: "isPool";
    outputs: readonly [{
        internalType: "bool";
        name: "";
        type: "bool";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidToken";
        name: "token";
        type: "address";
    }, {
        internalType: "address";
        name: "account";
        type: "address";
    }, {
        internalType: "uint256";
        name: "time";
        type: "uint256";
    }];
    name: "realtimeBalanceOf";
    outputs: readonly [{
        internalType: "int256";
        name: "dynamicBalance";
        type: "int256";
    }, {
        internalType: "uint256";
        name: "deposit";
        type: "uint256";
    }, {
        internalType: "uint256";
        name: "owedDeposit";
        type: "uint256";
    }];
    stateMutability: "view";
    type: "function";
}, {
    inputs: readonly [{
        internalType: "contract ISuperfluidPool";
        name: "pool";
        type: "address";
    }, {
        internalType: "address";
        name: "memberAddress";
        type: "address";
    }, {
        internalType: "uint128";
        name: "newUnits";
        type: "uint128";
    }, {
        internalType: "bytes";
        name: "ctx";
        type: "bytes";
    }];
    name: "updateMemberUnits";
    outputs: readonly [{
        internalType: "bytes";
        name: "newCtx";
        type: "bytes";
    }];
    stateMutability: "nonpayable";
    type: "function";
}]

Methods

  • Parameters

    • address: string
    • signerOrProvider: Signer | Provider

    Returns IGeneralDistributionAgreementV1

  • Returns IGeneralDistributionAgreementV1Interface

Generated using TypeDoc