@q-dev/qdex-js-sdk/lib/web3-contracts/DEX_ParametersVoting.d.ts

Typescript Library to interact with Q DEX 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 Initialized = ContractEventLog<{
  version: string;
  0: string;
}>;
export type ProposalCreated = ContractEventLog<{
  _id: string;
  _proposal: [
    string,
    [string, string, string, string, string, string, string, string],
    [string, string, string],
    boolean
  ];
  0: string;
  1: [
    string,
    [string, string, string, string, string, string, string, string],
    [string, string, string],
    boolean
  ];
}>;
export type ProposalExecuted = ContractEventLog<{
  _proposalId: string;
  0: string;
}>;
export type UserVoted = ContractEventLog<{
  _proposalId: string;
  _votingOption: string;
  0: string;
  1: string;
}>;
export type VetoOccurred = ContractEventLog<{
  id: string;
  sender: string;
  0: string;
  1: string;
}>;

export interface DEXParametersVoting extends BaseContract {
  constructor(
    jsonInterface: any[],
    address?: string,
    options?: ContractOptions
  ): DEXParametersVoting;
  clone(): DEXParametersVoting;
  methods: {
    createAddrProposal(
      _remark: string,
      _parameterKey: string,
      _addrValue: string
    ): NonPayableTransactionObject<string>;

    createBoolProposal(
      _remark: string,
      _parameterKey: string,
      _boolValue: boolean
    ): NonPayableTransactionObject<string>;

    createBytesProposal(
      _remark: string,
      _parameterKey: string,
      _bytes32Value: string | number[]
    ): NonPayableTransactionObject<string>;

    createProposal(
      _remark: string,
      _parametersArr: [
        string,
        number | string | BN,
        string,
        boolean,
        string | number[],
        string,
        number | string | BN
      ][]
    ): NonPayableTransactionObject<string>;

    createStrProposal(
      _remark: string,
      _parameterKey: string,
      _strValue: string
    ): NonPayableTransactionObject<string>;

    createToggleFlatFeeProposal(
      _remark: string,
      _addrValue: string
    ): NonPayableTransactionObject<string>;

    createUintProposal(
      _remark: string,
      _parameterKey: string,
      _uintValue: number | string | BN
    ): NonPayableTransactionObject<string>;

    execute(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<void>;

    expertsMembershipKey(): NonPayableTransactionObject<string>;

    expertsParametersKey(): NonPayableTransactionObject<string>;

    getParametersArr(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<
      [string, string, string, boolean, string, string, string][]
    >;

    getProposal(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<
      [
        string,
        [string, string, string, string, string, string, string, string],
        [string, string, string],
        boolean
      ]
    >;

    getProposalStats(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<[string, string, string, string, string]>;

    getStatus(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<string>;

    getVetosNumber(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<string>;

    getVetosPercentage(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<string>;

    hasRootVetoed(
      arg0: number | string | BN,
      arg1: string
    ): NonPayableTransactionObject<boolean>;

    hasUserVoted(
      arg0: number | string | BN,
      arg1: string
    ): NonPayableTransactionObject<boolean>;

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

    majorityKey(): NonPayableTransactionObject<string>;

    proposalCount(): NonPayableTransactionObject<string>;

    proposals(arg0: number | string | BN): NonPayableTransactionObject<{
      base: [
        string,
        [string, string, string, string, string, string, string, string],
        [string, string, string],
        boolean
      ];
      parametersSize: string;
      0: [
        string,
        [string, string, string, string, string, string, string, string],
        [string, string, string],
        boolean
      ];
      1: string;
    }>;

    quorumKey(): NonPayableTransactionObject<string>;

    veto(_proposalId: number | string | BN): NonPayableTransactionObject<void>;

    vetoPeriodKey(): NonPayableTransactionObject<string>;

    voteAgainst(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<void>;

    voteFor(
      _proposalId: number | string | BN
    ): NonPayableTransactionObject<void>;

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

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

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

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

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

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

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

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

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

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

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