@ardier16/q-js-sdk/lib/web3-contracts/Vesting.d.ts

Typescript Library to interact with Q System Contracts

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */

import BN from "bn.js";
import { ContractOptions } from "web3-eth-contract";
import { EventLog } from "web3-core";
import { EventEmitter } from "events";
import {
  Callback,
  PayableTransactionObject,
  NonPayableTransactionObject,
  BlockType,
  ContractEventLog,
  BaseContract,
} from "./types";

interface EventOptions {
  filter?: object;
  fromBlock?: BlockType;
  topics?: string[];
}

export type NewTimeLock = ContractEventLog<{
  _account: string;
  _timelock: [string, string, string];
  0: string;
  1: [string, string, string];
}>;
export type Purged = ContractEventLog<{
  _account: string;
  _timelock: [string, string, string];
  0: string;
  1: [string, string, string];
}>;

export interface Vesting extends BaseContract {
  constructor(
    jsonInterface: any[],
    address?: string,
    options?: ContractOptions
  ): Vesting;
  clone(): Vesting;
  methods: {
    depositOnBehalfOf(
      _account: string,
      _releaseStart: number | string | BN,
      _releaseEnd: number | string | BN
    ): PayableTransactionObject<void>;

    getMinimumBalance(
      _account: string,
      _timestamp: number | string | BN
    ): NonPayableTransactionObject<string>;

    getTimeLocks(
      _account: string
    ): NonPayableTransactionObject<[string, string, string][]>;

    purgeTimeLocks(_account: string): NonPayableTransactionObject<void>;

    initialize(_registry: string): NonPayableTransactionObject<void>;

    lock(_amount: number | string | BN): NonPayableTransactionObject<void>;

    withdraw(_amount: number | string | BN): NonPayableTransactionObject<void>;

    announceUnlock(
      _amount: number | string | BN
    ): NonPayableTransactionObject<void>;

    unlock(_amount: number | string | BN): NonPayableTransactionObject<void>;

    getLockInfo(): NonPayableTransactionObject<
      [string, string, string, string]
    >;

    balanceOf(_account: string): NonPayableTransactionObject<string>;

    withdrawableBalanceOf(
      _account: string
    ): NonPayableTransactionObject<string>;
  };
  events: {
    NewTimeLock(cb?: Callback<NewTimeLock>): EventEmitter;
    NewTimeLock(
      options?: EventOptions,
      cb?: Callback<NewTimeLock>
    ): EventEmitter;

    Purged(cb?: Callback<Purged>): EventEmitter;
    Purged(options?: EventOptions, cb?: Callback<Purged>): EventEmitter;

    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
  };

  once(event: "NewTimeLock", cb: Callback<NewTimeLock>): void;
  once(
    event: "NewTimeLock",
    options: EventOptions,
    cb: Callback<NewTimeLock>
  ): void;

  once(event: "Purged", cb: Callback<Purged>): void;
  once(event: "Purged", options: EventOptions, cb: Callback<Purged>): void;
}