edge-core-js/lib/flow/exports.js

Edge account & wallet management library

// @flow

import type {
  EdgeContext,
  EdgeContextOptions,
  EdgeCorePlugins,
  EdgeCorePluginsInit,
  EdgeCrashReporter,
  EdgeFakeUser,
  EdgeFakeWorld,
  EdgeFakeWorldOptions,
  EdgeIo,
  EdgeLoginMessage,
  EdgeLogSettings,
  EdgeNativeIo,
  EdgeOnLog,
} from "./types";

export * from "./types";

declare export function addEdgeCorePlugins(plugins: EdgeCorePlugins): void;
declare export function lockEdgeCorePlugins(): void;
declare export function closeEdge(): void;
declare export function makeFakeIo(): EdgeIo;

// System-specific io exports:
declare export function makeBrowserIo(): EdgeIo;
declare export function makeNodeIo(path: string): EdgeIo;

/**
 * Initializes the Edge core library,
 * automatically selecting the appropriate platform.
 */
declare export function makeEdgeContext(
  opts: EdgeContextOptions,
): Promise<EdgeContext>;

declare export function makeFakeEdgeWorld(
  users?: EdgeFakeUser[],
  opts?: EdgeFakeWorldOptions,
): Promise<EdgeFakeWorld>;

// ---------------------------------------------------------------------
// react-native
// ---------------------------------------------------------------------

type CommonProps = {
  // Allows the Chrome debugger to attach to the Android WebView.
  // This is mainly useful for debugging plugins,
  // since the `debug` prop also activates Chrome debugging.
  allowDebugging?: boolean;

  // Enable core debugging.
  // You must call `yarn start` in the edge-core-js project for this to work:
  debug?: boolean;

  // React Native modules to pass over the bridge to the plugins:
  nativeIo?: EdgeNativeIo;

  // Extra JavaScript files to load into the core as plugins.
  // Relative URL's resolve to the app's default asset location:
  pluginUris?: string[];

  // Called if something goes wrong when starting the core:
  // This will change to `(error: mixed) => void`
  onError?: (error: any) => mixed;
}

export type EdgeContextProps = {
  ...$Exact<CommonProps>;
  /**
   * Called once the core finishes loading.
   * The return type will change to `=> void`
   */
  onLoad: (context: EdgeContext) => mixed;

  // EdgeFakeWorldOptions:
  crashReporter?: EdgeCrashReporter;
  onLog?: EdgeOnLog;

  // EdgeContextOptions:
  airbitzSupport?: boolean;
  apiKey?: string;
  apiSecret?: Uint8Array;
  appId?: string;
  changeServer?: string | string[];
  infoServer?: string | string[];
  loginServer?: string | string[]; // Do not include `/api` in the path
  syncServer?: string | string[];
  deviceDescription?: string;
  hideKeys?: boolean;
  logSettings?: $Rest<EdgeLogSettings, { ... }>;
  plugins?: EdgeCorePluginsInit;
  skipBlockHeight?: boolean;

  /** @deprecated Use `loginServer` instead */
  authServer?: string;
}

export type EdgeFakeWorldProps = {
  ...$Exact<CommonProps>;
  /**
   * Called once the core finishes loading.
   * The return type will change to `=> void`
   */
  onLoad: (world: EdgeFakeWorld) => mixed;
  users?: EdgeFakeUser[];

  // EdgeFakeWorldOptions:
  crashReporter?: EdgeCrashReporter;
  onLog?: EdgeOnLog;
}

/**
 * We don't want this library to depend on `@types/react`,
 * since that isn't relevant for our Node or browser builds.
 */
type ComponentType<Props> = (props: Props) => {
  type: any;
  props: any;
  key: string | null;
};

/**
 * React Native component for creating an EdgeContext.
 */
declare export var MakeEdgeContext: React$ComponentType<EdgeContextProps>;

/**
 * React Native component for creating an EdgeFakeWorld for testing.
 */
declare export var MakeFakeEdgeWorld: React$ComponentType<EdgeFakeWorldProps>;

/**
 * React Native function for getting login alerts without a context:
 */
declare export function fetchLoginMessages(apiKey: string): EdgeLoginMessage[];