ganache-core

  • Version 2.13.2
  • Published
  • 3.33 MB
  • 30 dependencies
  • MIT license

Install

npm i ganache-core
yarn add ganache-core
pnpm add ganache-core

Overview

[![npm Version](https://img.shields.io/npm/v/ganache-core.svg)](https://www.npmjs.com/package/ganache-core) [![npm Downloads](https://img.shields.io/npm/dm/ganache-core.svg)](https://www.npmjs.com/package/ganache-core) [![Build Status](https://travis-ci.o

Index

Namespaces

namespace ganache-core

module 'ganache-core' {}

    interface JsonRpcPayload

    interface JsonRpcPayload {}

      property id

      id?: string | number;

        property jsonrpc

        jsonrpc: string;

          property method

          method: string;

            property params

            params: any[];

              interface JsonRpcResponse

              interface JsonRpcResponse {}

                property error

                error?: string;

                  property id

                  id: number;

                    property jsonrpc

                    jsonrpc: string;

                      property result

                      result?: any;

                        namespace ganache-core.Ganache

                        namespace ganache-core.Ganache {}

                          function provider

                          provider: (opts?: IProviderOptions) => Provider;

                            function server

                            server: (opts?: IServerOptions) => Server;

                              interface IProviderOptions

                              interface IProviderOptions {}

                                property account_keys_path

                                account_keys_path?: string;

                                  property accounts

                                  accounts?: object[];

                                    property allowUnlimitedContractSize

                                    allowUnlimitedContractSize?: boolean;

                                      property blockTime

                                      blockTime?: number;

                                        property db_path

                                        db_path?: string;

                                          property debug

                                          debug?: boolean;

                                            property default_balance_ether

                                            default_balance_ether?: number;

                                              property fork

                                              fork?: string | object;

                                                property fork_block_number

                                                fork_block_number?: string | number;

                                                  property forkCacheSize

                                                  forkCacheSize?: number;

                                                    property gasLimit

                                                    gasLimit?: string | number;

                                                      property gasPrice

                                                      gasPrice?: string;

                                                        property hardfork

                                                        hardfork?:
                                                        | 'byzantium'
                                                        | 'constantinople'
                                                        | 'petersburg'
                                                        | 'istanbul'
                                                        | 'muirGlacier';

                                                          property hd_path

                                                          hd_path?: string;

                                                            property locked

                                                            locked?: boolean;

                                                              property logger

                                                              logger?: {
                                                              log(msg: string): void;
                                                              };

                                                                property mnemonic

                                                                mnemonic?: string;

                                                                  property network_id

                                                                  network_id?: number;

                                                                    property networkId

                                                                    networkId?: number;

                                                                      property port

                                                                      port?: number;

                                                                        property seed

                                                                        seed?: any;

                                                                          property time

                                                                          time?: Date;

                                                                            property total_accounts

                                                                            total_accounts?: number;

                                                                              property unlocked_accounts

                                                                              unlocked_accounts?: string[];

                                                                                property verbose

                                                                                verbose?: boolean;

                                                                                  property vmErrorsOnRPCResponse

                                                                                  vmErrorsOnRPCResponse?: boolean;

                                                                                    property ws

                                                                                    ws?: boolean;

                                                                                      interface IServerOptions

                                                                                      interface IServerOptions extends IProviderOptions {}

                                                                                        property keepAliveTimeout

                                                                                        keepAliveTimeout?: number;

                                                                                          interface Provider

                                                                                          interface Provider {}

                                                                                            property close

                                                                                            close: (callback: Function) => void;

                                                                                              method on

                                                                                              on: (type: string, callback: () => void) => void;

                                                                                                method once

                                                                                                once: (type: string, callback: () => void) => void;

                                                                                                  method removeAllListeners

                                                                                                  removeAllListeners: (type: string) => void;

                                                                                                    method removeListener

                                                                                                    removeListener: (type: string, callback: () => void) => void;

                                                                                                      method send

                                                                                                      send: (
                                                                                                      payload: JsonRpcPayload,
                                                                                                      callback: (error: Error | null, result?: JsonRpcResponse) => void
                                                                                                      ) => void;

                                                                                                        interface Server

                                                                                                        interface Server extends HttpServer {}

                                                                                                          property provider

                                                                                                          provider: Provider;

                                                                                                            Package Files (1)

                                                                                                            Dependencies (30)

                                                                                                            Dev Dependencies (33)

                                                                                                            Peer Dependencies (0)

                                                                                                            No peer dependencies.

                                                                                                            Badge

                                                                                                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ganache-core.

                                                                                                            • Markdown
                                                                                                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ganache-core)
                                                                                                            • HTML
                                                                                                              <a href="https://www.jsdocs.io/package/ganache-core"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>