@ardier16/q-js-sdk/lib/web3-contracts/Saving.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 UserDeposited = ContractEventLog<{
  _user: string;
  _depositAmount: string;
  0: string;
  1: string;
}>;
export type UserWithdrawn = ContractEventLog<{
  _user: string;
  _withdrawAmount: string;
  0: string;
  1: string;
}>;

export interface Saving extends BaseContract {
  constructor(
    jsonInterface: any[],
    address?: string,
    options?: ContractOptions
  ): Saving;
  clone(): Saving;
  methods: {
    aggregatedNormalizedCapital(): NonPayableTransactionObject<string>;

    compoundRateKeeper(): NonPayableTransactionObject<string>;

    normalizedCapitals(arg0: string): NonPayableTransactionObject<string>;

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

    deposit(
      _amount: number | string | BN
    ): NonPayableTransactionObject<boolean>;

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

    updateCompoundRate(): NonPayableTransactionObject<string>;

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

    getBalance(): NonPayableTransactionObject<string>;
  };
  events: {
    UserDeposited(cb?: Callback<UserDeposited>): EventEmitter;
    UserDeposited(
      options?: EventOptions,
      cb?: Callback<UserDeposited>
    ): EventEmitter;

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

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

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

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