mysterium-vpn-js/lib/transactor/settlement.d.ts

Javascript SDK for Mysterium node

/**
 * Copyright (c) 2020 BlockDev AG
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
import { Pageable, PaginationQuery } from '../common/pageable';
export interface SettleRequest {
    hermesIds: string[];
    providerId: string;
}
export interface SettleWithBeneficiaryRequest {
    hermesId: string;
    providerId: string;
    beneficiary: string;
}
export interface DecreaseStakeRequest {
    id?: string;
    amount?: number;
    transactorFee?: number;
}
export interface Settlement {
    txHash: string;
    providerId: string;
    hermesId: string;
    channelAddress: string;
    beneficiary: string;
    amount: number;
    fees: number;
    settledAt: string;
    isWithdrawal: boolean;
    blockExplorerUrl: string;
}
export declare enum SettlementType {
    Settlement = "settlement",
    Withdrawal = "withdrawal"
}
export interface SettlementListQuery extends PaginationQuery {
    dateFrom?: string;
    dateTo?: string;
    providerId?: string;
    hermesId?: string;
    types?: SettlementType[];
}
export interface SettlementStats {
    withdrawalTotal?: string;
}
export declare type SettlementListResponse = Pageable<Settlement> & SettlementStats;
export declare enum BeneficiaryTxState {
    COMPLETED = "completed",
    PENDING = "pending"
}
export interface BeneficiaryTxStatus {
    state: BeneficiaryTxState;
    error: string;
}
export declare const validateSettlementResponse: <T>(response: any) => any;