node.ts

import { BigNumber, BigNumberish } from "ethers/utils";
import { JsonRpcNotification, JsonRpcResponse, Rpc } from "rpc-server";

import { OutcomeType } from ".";
import {
  AppABIEncodings,
  AppInstanceJson,
  AppInstanceProposal
} from "./data-types";
import { SolidityValueType } from "./simple-types";

export interface IRpcNodeProvider {
  onMessage(callback: (message: JsonRpcResponse | JsonRpcNotification) => void);
  sendMessage(message: Rpc);
}

export namespace Node {
  /**
   * The message type for Nodes to communicate with each other.
   */
  export type NodeMessage = {
    from: string;
    type: EventName;
  };

  // This is used instead of the ethers `Transaction` because that type
  // requires the nonce and chain ID to be specified, when sometimes those
  // arguments are not known at the time of creating a transaction.
  export type MinimalTransaction = {
    to: string;
    value: BigNumberish;
    data: string;
  };

  export interface ServiceFactory {
    connect?(host: string, port: string): ServiceFactory;
    auth?(email: string, password: string): Promise<void>;
    createMessagingService?(messagingServiceKey: string): IMessagingService;
    createStoreService?(storeServiceKey: string): IStoreService;
  }

  export interface IMessagingService {
    send(to: string, msg: Node.NodeMessage): Promise<void>;
    onReceive(address: string, callback: (msg: Node.NodeMessage) => void);
  }

  /**
   * An interface for a stateful storage service with an API very similar to Firebase's API.
   * Values are addressed by paths, which are separated by the forward slash separator `/`.
   * `get` must return values whose paths have prefixes that match the provided path,
   * keyed by the remaining path.
   * `set` allows multiple values and paths to be atomically set. In Firebase, passing `null`
   * as `value` deletes the entry at the given prefix, and passing objects with null subvalues
   * deletes entries at the path extended by the subvalue's path within the object. `set` must
   * have the same behaviour if the `allowDelete` flag is passed; otherwise, any null values or
   * subvalues throws an error.
   */
  export interface IStoreService {
    get(path: string): Promise<any>;
    set(
      pairs: { path: string; value: any }[],
      allowDelete?: Boolean
    ): Promise<void>;
    reset?(): Promise<void>;
  }

  export interface IPrivateKeyGenerator {
    (s: string): Promise<string>;
  }

  /**
   * Centralized locking service (i.e. redis)
   */
  export interface ILockService {
    acquireLock(
      lockName: string,
      callback: (...args: any[]) => any,
      timeout: number
    ): Promise<any>;
  }

  export enum ErrorType {
    ERROR = "error"
  }

  // SOURCE: https://github.com/counterfactual/monorepo/blob/master/packages/cf.js/API_REFERENCE.md#public-methods
  export enum MethodName {
    ACCEPT_STATE = "acceptState",
    GET_PROPOSED_APP_INSTANCE = "getProposedAppInstance"
  }

  export enum RpcMethodName {
    CREATE_CHANNEL = "chan_create",
    DEPOSIT = "chan_deposit",
    DEPLOY_STATE_DEPOSIT_HOLDER = "chan_deployStateDepositHolder",
    GET_CHANNEL_ADDRESSES = "chan_getChannelAddresses",
    GET_APP_INSTANCE_DETAILS = "chan_getAppInstance",
    GET_APP_INSTANCES = "chan_getAppInstances",
    GET_STATE_DEPOSIT_HOLDER_ADDRESS = "chan_getStateDepositHolderAddress",
    GET_FREE_BALANCE_STATE = "chan_getFreeBalanceState",
    GET_TOKEN_INDEXED_FREE_BALANCE_STATES = "chan_getTokenIndexedFreeBalanceStates",
    GET_PROPOSED_APP_INSTANCES = "chan_getProposedAppInstances",
    GET_STATE = "chan_getState",
    GET_STATE_CHANNEL = "chan_getStateChannel",
    INSTALL = "chan_install",
    INSTALL_VIRTUAL = "chan_installVirtual",
    PROPOSE_INSTALL = "chan_proposeInstall",
    PROPOSE_INSTALL_VIRTUAL = "chan_proposeInstallVirtual",
    PROPOSE_STATE = "chan_proposeState",
    REJECT_INSTALL = "chan_rejectInstall",
    REJECT_STATE = "chan_rejectState",
    UPDATE_STATE = "chan_updateState",
    TAKE_ACTION = "chan_takeAction",
    UNINSTALL = "chan_uninstall",
    UNINSTALL_VIRTUAL = "chan_uninstallVirtual",
    WITHDRAW = "chan_withdraw",
    WITHDRAW_COMMITMENT = "chan_withdrawCommitment"
  }

  // SOURCE: https://github.com/counterfactual/monorepo/blob/master/packages/cf.js/API_REFERENCE.md#events
  export enum EventName {
    COUNTER_DEPOSIT_CONFIRMED = "counterDepositConfirmed",
    CREATE_CHANNEL = "createChannelEvent",
    DEPOSIT_CONFIRMED = "depositConfirmedEvent",
    DEPOSIT_FAILED = "depositFailed",
    DEPOSIT_STARTED = "depositStartedEvent",
    INSTALL = "installEvent",
    INSTALL_VIRTUAL = "installVirtualEvent",
    PROPOSE_STATE = "proposeStateEvent",
    REJECT_INSTALL = "rejectInstallEvent",
    REJECT_STATE = "rejectStateEvent",
    UNINSTALL = "uninstallEvent",
    UNINSTALL_VIRTUAL = "uninstallVirtualEvent",
    UPDATE_STATE = "updateStateEvent",
    WITHDRAWAL_CONFIRMED = "withdrawalConfirmedEvent",
    WITHDRAWAL_FAILED = "withdrawalFailed",
    WITHDRAWAL_STARTED = "withdrawalStartedEvent",
    PROPOSE_INSTALL = "proposeInstallEvent",
    PROPOSE_INSTALL_VIRTUAL = "proposeInstallEvent",
    PROTOCOL_MESSAGE_EVENT = "protocolMessageEvent",
    WITHDRAW_EVENT = "withdrawEvent",
    REJECT_INSTALL_VIRTUAL = "rejectInstallEvent"
  }

  export type CreateChannelParams = {
    owners: string[];
  };

  export type CreateChannelResult = {
    multisigAddress: string;
    owners: string[];
    counterpartyXpub: string;
  };

  export type CreateChannelTransactionResult = {
    multisigAddress: string;
  };

  export type CreateMultisigParams = {
    owners: string[];
  };

  export type CreateMultisigResult = {
    multisigAddress: string;
  };

  export type DeployStateDepositHolderParams = {
    multisigAddress: string;
    retryCount?: number;
  };

  export type DeployStateDepositHolderResult = {
    transactionHash: string;
  };

  export type DepositParams = {
    multisigAddress: string;
    amount: BigNumber;
    tokenAddress?: string;
  };

  export type DepositResult = {
    multisigBalance: BigNumber;
  };

  export type GetAppInstanceDetailsParams = {
    appInstanceId: string;
  };

  export type GetAppInstanceDetailsResult = {
    appInstance: AppInstanceJson;
  };

  export type GetStateDepositHolderAddressParams = {
    owners: string[];
  };

  export type GetStateDepositHolderAddressResult = {
    address: string;
  };

  export type GetAppInstancesParams = {};

  export type GetAppInstancesResult = {
    appInstances: AppInstanceJson[];
  };

  export type GetChannelAddressesParams = {};

  export type GetChannelAddressesResult = {
    multisigAddresses: string[];
  };

  export type GetFreeBalanceStateParams = {
    multisigAddress: string;
    tokenAddress?: string;
  };

  export type GetFreeBalanceStateResult = {
    [s: string]: BigNumber;
  };

  export type GetTokenIndexedFreeBalanceStatesParams = {
    multisigAddress: string;
  };

  export type GetTokenIndexedFreeBalanceStatesResult = {
    [tokenAddress: string]: {
      [s: string]: BigNumber;
    };
  };

  export type GetProposedAppInstancesParams = {};

  export type GetProposedAppInstancesResult = {
    appInstances: AppInstanceProposal[];
  };

  export type GetProposedAppInstanceParams = {
    appInstanceId: string;
  };

  export type GetProposedAppInstanceResult = {
    appInstance: AppInstanceProposal;
  };

  export type GetStateParams = {
    appInstanceId: string;
  };

  export type GetStateResult = {
    state: SolidityValueType;
  };

  export type InstallParams = {
    appInstanceId: string;
  };

  export type InstallResult = {
    appInstance: AppInstanceJson;
  };

  export type InstallVirtualParams = InstallParams & {
    intermediaryIdentifier: string;
  };

  export type InstallVirtualResult = InstallResult;

  export type ProposeInstallParams = {
    appDefinition: string;
    abiEncodings: AppABIEncodings;
    initiatorDeposit: BigNumber;
    initiatorDepositTokenAddress?: string;
    responderDeposit: BigNumber;
    responderDepositTokenAddress?: string;
    timeout: BigNumber;
    initialState: SolidityValueType;
    proposedToIdentifier: string;
    outcomeType: OutcomeType;
  };

  export type ProposeInstallVirtualParams = ProposeInstallParams & {
    intermediaryIdentifier: string;
  };

  export type ProposeInstallVirtualResult = ProposeInstallResult;

  export type ProposeInstallResult = {
    appInstanceId: string;
  };

  export type RejectInstallParams = {
    appInstanceId: string;
  };

  export type RejectInstallResult = {};

  export type TakeActionParams = {
    appInstanceId: string;
    action: SolidityValueType;
  };

  export type TakeActionResult = {
    newState: SolidityValueType;
  };

  export type UninstallParams = {
    appInstanceId: string;
  };

  export type UninstallResult = {};

  export type UninstallVirtualParams = UninstallParams & {
    intermediaryIdentifier: string;
  };

  export type UninstallVirtualResult = UninstallResult;

  export type UpdateStateParams = {
    appInstanceId: string;
    newState: SolidityValueType;
  };

  export type UpdateStateResult = {
    newState: SolidityValueType;
  };

  export type WithdrawParams = {
    multisigAddress: string;
    recipient?: string;
    amount: BigNumber;
    tokenAddress?: string;
  };

  export type WithdrawResult = {
    recipient: string;
    txHash: string;
  };

  export type WithdrawCommitmentParams = WithdrawParams;

  export type WithdrawCommitmentResult = {
    transaction: MinimalTransaction;
  };

  export type MethodParams =
    | GetAppInstancesParams
    | GetProposedAppInstancesParams
    | ProposeInstallParams
    | ProposeInstallVirtualParams
    | RejectInstallParams
    | InstallParams
    | InstallVirtualParams
    | GetStateParams
    | GetAppInstanceDetailsParams
    | TakeActionParams
    | UninstallParams
    | CreateChannelParams
    | GetChannelAddressesParams
    | DeployStateDepositHolderParams;
  export type MethodResult =
    | GetAppInstancesResult
    | GetProposedAppInstancesResult
    | ProposeInstallResult
    | ProposeInstallVirtualResult
    | RejectInstallResult
    | InstallResult
    | InstallVirtualResult
    | GetStateResult
    | GetAppInstanceDetailsResult
    | TakeActionResult
    | UninstallResult
    | CreateChannelResult
    | GetChannelAddressesResult
    | DeployStateDepositHolderResult;

  export type CreateMultisigEventData = {
    owners: string[];
    multisigAddress: string;
  };

  export type InstallEventData = {
    appInstanceId: string;
  };

  export type RejectInstallEventData = {
    appInstance: AppInstanceProposal;
  };

  export type UninstallEventData = {
    appInstanceId: string;
  };

  export type UpdateStateEventData = {
    appInstanceId: string;
    newState: SolidityValueType;
    action?: SolidityValueType;
  };

  export type WithdrawEventData = {
    amount: BigNumber;
  };

  export type EventData =
    | InstallEventData
    | RejectInstallEventData
    | UpdateStateEventData
    | UninstallEventData
    | CreateMultisigEventData;

  export type MethodMessage = {
    type: MethodName;
    requestId: string;
  };

  export type MethodRequest = MethodMessage & {
    params: MethodParams;
  };

  export type MethodResponse = MethodMessage & {
    result: MethodResult;
  };

  export type Event = {
    type: EventName;
    data: EventData;
  };

  export type Error = {
    type: ErrorType;
    requestId?: string;
    data: {
      errorName: string;
      message?: string;
      appInstanceId?: string;
      extra?: { [k: string]: string | number | boolean | object };
    };
  };

  export type Message = MethodRequest | MethodResponse | Event | Error;
}