raiden-ts/dist/contracts/UserDeposit.d.ts

Raiden Light Client Typescript/Javascript SDK

import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result, EventFragment } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common";
export interface UserDepositInterface extends utils.Interface {
    functions: {
        "balances(address)": FunctionFragment;
        "contractExists(address)": FunctionFragment;
        "deposit(address,uint256)": FunctionFragment;
        "effectiveBalance(address)": FunctionFragment;
        "failsafe_addition(uint256,uint256)": FunctionFragment;
        "failsafe_subtract(uint256,uint256)": FunctionFragment;
        "init(address,address)": FunctionFragment;
        "max(uint256,uint256)": FunctionFragment;
        "min(uint256,uint256)": FunctionFragment;
        "msc_address()": FunctionFragment;
        "one_to_n_address()": FunctionFragment;
        "planWithdraw(uint256)": FunctionFragment;
        "signature_prefix()": FunctionFragment;
        "token()": FunctionFragment;
        "total_deposit(address)": FunctionFragment;
        "transfer(address,address,uint256)": FunctionFragment;
        "whole_balance()": FunctionFragment;
        "whole_balance_limit()": FunctionFragment;
        "withdraw(uint256)": FunctionFragment;
        "withdrawToBeneficiary(uint256,address)": FunctionFragment;
        "withdraw_plans(address)": FunctionFragment;
        "withdraw_timeout()": FunctionFragment;
    };
    getFunction(nameOrSignatureOrTopic: "balances" | "contractExists" | "deposit" | "effectiveBalance" | "failsafe_addition" | "failsafe_subtract" | "init" | "max" | "min" | "msc_address" | "one_to_n_address" | "planWithdraw" | "signature_prefix" | "token" | "total_deposit" | "transfer" | "whole_balance" | "whole_balance_limit" | "withdraw" | "withdrawToBeneficiary" | "withdraw_plans" | "withdraw_timeout"): FunctionFragment;
    encodeFunctionData(functionFragment: "balances", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "contractExists", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "deposit", values: [PromiseOrValue<string>, PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "effectiveBalance", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "failsafe_addition", values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "failsafe_subtract", values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "init", values: [PromiseOrValue<string>, PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "max", values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "min", values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "msc_address", values?: undefined): string;
    encodeFunctionData(functionFragment: "one_to_n_address", values?: undefined): string;
    encodeFunctionData(functionFragment: "planWithdraw", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "signature_prefix", values?: undefined): string;
    encodeFunctionData(functionFragment: "token", values?: undefined): string;
    encodeFunctionData(functionFragment: "total_deposit", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "transfer", values: [
        PromiseOrValue<string>,
        PromiseOrValue<string>,
        PromiseOrValue<BigNumberish>
    ]): string;
    encodeFunctionData(functionFragment: "whole_balance", values?: undefined): string;
    encodeFunctionData(functionFragment: "whole_balance_limit", values?: undefined): string;
    encodeFunctionData(functionFragment: "withdraw", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "withdrawToBeneficiary", values: [PromiseOrValue<BigNumberish>, PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "withdraw_plans", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "withdraw_timeout", values?: undefined): string;
    decodeFunctionResult(functionFragment: "balances", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "contractExists", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "deposit", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "effectiveBalance", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "failsafe_addition", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "failsafe_subtract", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "init", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "max", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "min", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "msc_address", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "one_to_n_address", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "planWithdraw", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "signature_prefix", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "token", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "total_deposit", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "transfer", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "whole_balance", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "whole_balance_limit", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdraw", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdrawToBeneficiary", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdraw_plans", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdraw_timeout", data: BytesLike): Result;
    events: {
        "BalanceReduced(address,uint256)": EventFragment;
        "WithdrawPlanned(address,uint256)": EventFragment;
    };
    getEvent(nameOrSignatureOrTopic: "BalanceReduced"): EventFragment;
    getEvent(nameOrSignatureOrTopic: "WithdrawPlanned"): EventFragment;
}
export interface BalanceReducedEventObject {
    owner: string;
    newBalance: BigNumber;
}
export declare type BalanceReducedEvent = TypedEvent<[
    string,
    BigNumber
], BalanceReducedEventObject>;
export declare type BalanceReducedEventFilter = TypedEventFilter<BalanceReducedEvent>;
export interface WithdrawPlannedEventObject {
    withdrawer: string;
    plannedBalance: BigNumber;
}
export declare type WithdrawPlannedEvent = TypedEvent<[
    string,
    BigNumber
], WithdrawPlannedEventObject>;
export declare type WithdrawPlannedEventFilter = TypedEventFilter<WithdrawPlannedEvent>;
export interface UserDeposit extends BaseContract {
    connect(signerOrProvider: Signer | Provider | string): this;
    attach(addressOrName: string): this;
    deployed(): Promise<this>;
    interface: UserDepositInterface;
    queryFilter<TEvent extends TypedEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>;
    listeners<TEvent extends TypedEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>;
    listeners(eventName?: string): Array<Listener>;
    removeAllListeners<TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>): this;
    removeAllListeners(eventName?: string): this;
    off: OnEvent<this>;
    on: OnEvent<this>;
    once: OnEvent<this>;
    removeListener: OnEvent<this>;
    functions: {
        balances(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[BigNumber]>;
        contractExists(contract_address: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[boolean]>;
        deposit(beneficiary: PromiseOrValue<string>, new_total_deposit: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        effectiveBalance(owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[BigNumber] & {
            remaining_balance: BigNumber;
        }>;
        failsafe_addition(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
        failsafe_subtract(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber, BigNumber]>;
        init(_msc_address: PromiseOrValue<string>, _one_to_n_address: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        max(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
        min(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
        msc_address(overrides?: CallOverrides): Promise<[string]>;
        one_to_n_address(overrides?: CallOverrides): Promise<[string]>;
        planWithdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        signature_prefix(overrides?: CallOverrides): Promise<[string]>;
        token(overrides?: CallOverrides): Promise<[string]>;
        total_deposit(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[BigNumber]>;
        transfer(sender: PromiseOrValue<string>, receiver: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        whole_balance(overrides?: CallOverrides): Promise<[BigNumber]>;
        whole_balance_limit(overrides?: CallOverrides): Promise<[BigNumber]>;
        withdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        withdrawToBeneficiary(amount: PromiseOrValue<BigNumberish>, beneficiary: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        withdraw_plans(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[
            BigNumber,
            BigNumber
        ] & {
            amount: BigNumber;
            withdrawable_after: BigNumber;
        }>;
        withdraw_timeout(overrides?: CallOverrides): Promise<[BigNumber]>;
    };
    balances(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
    contractExists(contract_address: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
    deposit(beneficiary: PromiseOrValue<string>, new_total_deposit: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    effectiveBalance(owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
    failsafe_addition(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    failsafe_subtract(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber, BigNumber]>;
    init(_msc_address: PromiseOrValue<string>, _one_to_n_address: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    max(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    min(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    msc_address(overrides?: CallOverrides): Promise<string>;
    one_to_n_address(overrides?: CallOverrides): Promise<string>;
    planWithdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    signature_prefix(overrides?: CallOverrides): Promise<string>;
    token(overrides?: CallOverrides): Promise<string>;
    total_deposit(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
    transfer(sender: PromiseOrValue<string>, receiver: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    whole_balance(overrides?: CallOverrides): Promise<BigNumber>;
    whole_balance_limit(overrides?: CallOverrides): Promise<BigNumber>;
    withdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    withdrawToBeneficiary(amount: PromiseOrValue<BigNumberish>, beneficiary: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    withdraw_plans(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[
        BigNumber,
        BigNumber
    ] & {
        amount: BigNumber;
        withdrawable_after: BigNumber;
    }>;
    withdraw_timeout(overrides?: CallOverrides): Promise<BigNumber>;
    callStatic: {
        balances(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        contractExists(contract_address: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
        deposit(beneficiary: PromiseOrValue<string>, new_total_deposit: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
        effectiveBalance(owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        failsafe_addition(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        failsafe_subtract(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber, BigNumber]>;
        init(_msc_address: PromiseOrValue<string>, _one_to_n_address: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        max(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        min(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        msc_address(overrides?: CallOverrides): Promise<string>;
        one_to_n_address(overrides?: CallOverrides): Promise<string>;
        planWithdraw(amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
        signature_prefix(overrides?: CallOverrides): Promise<string>;
        token(overrides?: CallOverrides): Promise<string>;
        total_deposit(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        transfer(sender: PromiseOrValue<string>, receiver: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
        whole_balance(overrides?: CallOverrides): Promise<BigNumber>;
        whole_balance_limit(overrides?: CallOverrides): Promise<BigNumber>;
        withdraw(amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
        withdrawToBeneficiary(amount: PromiseOrValue<BigNumberish>, beneficiary: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        withdraw_plans(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[
            BigNumber,
            BigNumber
        ] & {
            amount: BigNumber;
            withdrawable_after: BigNumber;
        }>;
        withdraw_timeout(overrides?: CallOverrides): Promise<BigNumber>;
    };
    filters: {
        "BalanceReduced(address,uint256)"(owner?: PromiseOrValue<string> | null, newBalance?: null): BalanceReducedEventFilter;
        BalanceReduced(owner?: PromiseOrValue<string> | null, newBalance?: null): BalanceReducedEventFilter;
        "WithdrawPlanned(address,uint256)"(withdrawer?: PromiseOrValue<string> | null, plannedBalance?: null): WithdrawPlannedEventFilter;
        WithdrawPlanned(withdrawer?: PromiseOrValue<string> | null, plannedBalance?: null): WithdrawPlannedEventFilter;
    };
    estimateGas: {
        balances(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        contractExists(contract_address: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        deposit(beneficiary: PromiseOrValue<string>, new_total_deposit: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        effectiveBalance(owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        failsafe_addition(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        failsafe_subtract(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        init(_msc_address: PromiseOrValue<string>, _one_to_n_address: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        max(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        min(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        msc_address(overrides?: CallOverrides): Promise<BigNumber>;
        one_to_n_address(overrides?: CallOverrides): Promise<BigNumber>;
        planWithdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        signature_prefix(overrides?: CallOverrides): Promise<BigNumber>;
        token(overrides?: CallOverrides): Promise<BigNumber>;
        total_deposit(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        transfer(sender: PromiseOrValue<string>, receiver: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        whole_balance(overrides?: CallOverrides): Promise<BigNumber>;
        whole_balance_limit(overrides?: CallOverrides): Promise<BigNumber>;
        withdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        withdrawToBeneficiary(amount: PromiseOrValue<BigNumberish>, beneficiary: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        withdraw_plans(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        withdraw_timeout(overrides?: CallOverrides): Promise<BigNumber>;
    };
    populateTransaction: {
        balances(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        contractExists(contract_address: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        deposit(beneficiary: PromiseOrValue<string>, new_total_deposit: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        effectiveBalance(owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        failsafe_addition(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        failsafe_subtract(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        init(_msc_address: PromiseOrValue<string>, _one_to_n_address: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        max(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        min(a: PromiseOrValue<BigNumberish>, b: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        msc_address(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        one_to_n_address(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        planWithdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        signature_prefix(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        token(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        total_deposit(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        transfer(sender: PromiseOrValue<string>, receiver: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        whole_balance(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        whole_balance_limit(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        withdraw(amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        withdrawToBeneficiary(amount: PromiseOrValue<BigNumberish>, beneficiary: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        withdraw_plans(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        withdraw_timeout(overrides?: CallOverrides): Promise<PopulatedTransaction>;
    };
}