namillum/zilliqa/js/contract/src/types.ts

Bubble Protocol SDK

//  Copyright (C) 2018 Zilliqa
//
//  This file is part of zilliqa-js
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.

import { Omit } from 'utility-types';
import { TxParams } from '@zilliqa-js/account';

export enum ContractStatus {
  Deployed,
  Rejected,
  Initialised,
}

export type DeployParams = Omit<
  TxParams,
  'toAddr' | 'amount' | 'code' | 'data' | 'receipt' | 'signature'
>;

export type CallParams = Omit<
  TxParams,
  'toAddr' | 'data' | 'code' | 'receipt' | 'signature'
>;

export interface ContractObj {
  address: string;
  abi: ABI;
  init: any;
  state: any;
}

export interface Transition {
  vname: string;
  params: Field[];
}

/**
 * Interface for ABI returned by scilla-checker
 */
export interface ABI {
  scilla_major_version: number;
  vname: string;
  fields: Field[];
  params: Field[];
  transitions: Transition[];
}

export interface Field {
  vname: string;
  type: string;
  depth?: number;
}

export interface Value {
  vname: string;
  type: string;
  value: string | ADTValue;
}

interface ADTValue {
  constructor: string;
  argtypes: string[];
  arguments: Value[];
}

export type Param = Value;
export type TransitionParam = Value;

export type Init = Value[];

// Post v5.0.0 upgrade
export type State = any;

export interface TransitionPayload {
  // the name of the transtion to be called
  _tag: string;
  // amount to send to the contract, if any
  _amount: string;
  params: Value[];
}

// RPC Error Responses
export type DeployError =
  | 'Code is empty and To addr is null'
  | 'To Addr is null'
  | 'Non - contract address called'
  | 'Could not create Transaction'
  | 'Unable to process';

export interface DeploySuccess {
  TranID: string;
  Info: string;
  ContractAddress?: string;
}