@polkadot/api-provider/mock/index.ts

Transport providers for the API

// Copyright 2017-2018 @polkadot/api-provider authors & contributors
// This software may be modified and distributed under the terms
// of the ISC license. See the LICENSE file for details.

import { ProviderInterface, ProviderInterface$Emitted, ProviderInterface$EmitCb } from '../types';

import mocks from './mocks';
import on from './on';
import send from './send';
import state from './state';
import subscribe from './subscribe';
import unsubscribe from './unsubscribe';

/**
 * A moock provider mainly used for testing.
 * @return {ProviderInterface} The mock provider
 */
export default function mockProvider (): ProviderInterface {
  const self = state();

  mocks(self);

  return {
    isConnected: (): boolean =>
      true,
    on: (type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void =>
      on(self, type, sub),
    send: (method: string, params: Array<any>): Promise<any> =>
      send(self, method, params),
    subscribe: (type: string, method: string, ...params: Array<any>): Promise<number> =>
      subscribe(self, type, method, params),
    unsubscribe: (type: string, method: string, id: number): Promise<boolean> =>
      unsubscribe(self, type, method, id)
  };
}