@connext/types/src/methods.ts

import { Address, AssetId, BigNumber, Bytes32, PublicIdentifier, SolidityValueType } from "./basic";
import { AppState } from "./contracts";

import { AppABIEncodings, AppInstanceJson } from "./app";
import { OutcomeType } from "./contracts";
import { PublicParams, PublicResults } from "./public";
import { StateChannelJSON } from "./state";
import { MinimalTransaction } from "./commitments";
import { enumify } from "./utils";

////////////////////////////////////////

type CreateChannelParams = {
  owners: PublicIdentifier[];
  chainId: number;
};

type CreateChannelResult = {
  multisigAddress: Address;
  owners?: Address[];
};

////////////////////////////////////////

type DepositParams = PublicParams.Deposit;

type DepositResult = PublicResults.Deposit;

////////////////////////////////////////

type DeployStateDepositHolderParams = {
  multisigAddress: Address;
  retryCount?: number;
};

type DeployStateDepositHolderResult = {
  transactionHash: Bytes32;
};

////////////////////////////////////////

type GetChannelAddressesParams = {};

type GetChannelAddressesResult = {
  multisigAddresses: Address[];
};

////////////////////////////////////////

type GetAppInstanceDetailsParams = {
  appIdentityHash: Bytes32;
};

type GetAppInstanceDetailsResult = {
  appInstance: AppInstanceJson;
};

////////////////////////////////////////

type GetAppInstancesParams = {
  multisigAddress: Address;
};

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

////////////////////////////////////////

type GetStateDepositHolderAddressParams = {
  owners: Address[]; // [initiator, responder]
  chainId: number;
};

type GetStateDepositHolderAddressResult = {
  address: Address;
};

////////////////////////////////////////

type GetFreeBalanceStateParams = {
  multisigAddress: Address;
  assetId?: Address;
};

type GetFreeBalanceStateResult = {
  [signerAddress: string]: BigNumber;
};

////////////////////////////////////////

type GetTokenIndexedFreeBalanceStatesParams = {
  multisigAddress: Address;
};

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

////////////////////////////////////////

type GetProposedAppInstanceParams = {
  appIdentityHash: Bytes32;
};

type GetProposedAppInstanceResult = {
  appInstance: AppInstanceJson;
};

////////////////////////////////////////

type GetProposedAppInstancesParams = {
  multisigAddress: Address;
};

type GetProposedAppInstancesResult = {
  appInstances: AppInstanceJson[];
};

////////////////////////////////////////

type GetStateChannelParams = {
  multisigAddress: Address;
};

type GetStateChannelResult = {
  data: StateChannelJSON;
};

////////////////////////////////////////

type InstallParams = {
  appIdentityHash: Bytes32;
  multisigAddress: Address;
  protocolMeta?: any;
};

type InstallResult = {
  appInstance: AppInstanceJson;
};

////////////////////////////////////////

type RequestDepositRightsParams = {
  assetId?: Address;
  multisigAddress: Address;
};

type RequestDepositRightsResult = {
  appIdentityHash: Bytes32;
  multisigAddress: Address;
};

////////////////////////////////////////

type ProposeInstallParams = {
  abiEncodings: AppABIEncodings;
  appDefinition: Address;
  defaultTimeout: BigNumber;
  initialState: AppState;
  initiatorDeposit: BigNumber;
  initiatorDepositAssetId: AssetId;
  meta?: any;
  multisigAddress: Address;
  outcomeType: OutcomeType;
  responderIdentifier: PublicIdentifier;
  responderDeposit: BigNumber;
  responderDepositAssetId: AssetId;
  stateTimeout?: BigNumber;
  protocolMeta?: any;
};

type ProposeInstallResult = {
  appIdentityHash: Bytes32;
};

////////////////////////////////////////

type RejectInstallParams = {
  appIdentityHash: Bytes32;
  multisigAddress: Address;
  reason?: string;
};

type RejectInstallResult = {};

////////////////////////////////////////

type TakeActionParams = {
  appIdentityHash: Bytes32;
  action: SolidityValueType;
  multisigAddress: Address;
  stateTimeout?: BigNumber;
  protocolMeta?: any;
};

type TakeActionResult = {
  newState: SolidityValueType;
};

////////////////////////////////////////

type UninstallParams = {
  appIdentityHash: Bytes32;
  multisigAddress: Address;
  action?: SolidityValueType;
  protocolMeta?: any;
};

type UninstallResult = {
  appIdentityHash: Bytes32;
  multisigAddress: Address;
  uninstalledApp: AppInstanceJson;
  action?: SolidityValueType;
};

////////////////////////////////////////

type RescindDepositRightsParams = {
  assetId?: Address;
  appIdentityHash?: Bytes32;
  multisigAddress: Address;
};

type RescindDepositRightsResult = {
  freeBalance: {
    [s: string]: BigNumber;
  };
};

////////////////////////////////////////

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

type WithdrawResult = {
  recipient: Address;
  txHash: Bytes32;
};

////////////////////////////////////////

type WithdrawCommitmentParams = WithdrawParams;

type WithdrawCommitmentResult = {
  transaction: MinimalTransaction;
};

////////////////////////////////////////

type SyncParams = {
  multisigAddress: Address;
  protocolMeta?: any;
};

type SyncResult = {
  syncedChannel: StateChannelJSON;
};

////////////////////////////////////////
// exports

export const MethodNames = enumify({
  chan_create: "chan_create",
  chan_deployStateDepositHolder: "chan_deployStateDepositHolder",
  chan_getAppInstance: "chan_getAppInstance",
  chan_getAppInstances: "chan_getAppInstances",
  chan_getChannelAddresses: "chan_getChannelAddresses",
  chan_getFreeBalanceState: "chan_getFreeBalanceState",
  chan_getProposedAppInstance: "chan_getProposedAppInstance",
  chan_getProposedAppInstances: "chan_getProposedAppInstances",
  chan_getStateChannel: "chan_getStateChannel",
  chan_getStateDepositHolderAddress: "chan_getStateDepositHolderAddress",
  chan_getTokenIndexedFreeBalanceStates: "chan_getTokenIndexedFreeBalanceStates",
  chan_install: "chan_install",
  chan_proposeInstall: "chan_proposeInstall",
  chan_rejectInstall: "chan_rejectInstall",
  chan_sync: "chan_sync",
  chan_takeAction: "chan_takeAction",
  chan_uninstall: "chan_uninstall",
  chan_withdraw: "chan_withdraw",
  chan_withdrawCommitment: "chan_withdrawCommitment",
});
type MethodNames = typeof MethodNames[keyof typeof MethodNames];
export type MethodName = keyof typeof MethodNames;

export namespace MethodParams {
  export type CreateChannel = CreateChannelParams;
  export type DeployStateDepositHolder = DeployStateDepositHolderParams;
  export type Deposit = DepositParams;
  export type GetAppInstanceDetails = GetAppInstanceDetailsParams;
  export type GetAppInstances = GetAppInstancesParams;
  export type GetChannelAddresses = GetChannelAddressesParams;
  export type GetFreeBalanceState = GetFreeBalanceStateParams;
  export type GetProposedAppInstance = GetProposedAppInstanceParams;
  export type GetProposedAppInstances = GetProposedAppInstancesParams;
  export type GetStateChannel = GetStateChannelParams;
  export type GetStateDepositHolderAddress = GetStateDepositHolderAddressParams;
  export type GetTokenIndexedFreeBalanceStates = GetTokenIndexedFreeBalanceStatesParams;
  export type Install = InstallParams;
  export type ProposeInstall = ProposeInstallParams;
  export type RejectInstall = RejectInstallParams;
  export type RequestDepositRights = RequestDepositRightsParams;
  export type RescindDepositRights = RescindDepositRightsParams;
  export type TakeAction = TakeActionParams;
  export type Sync = SyncParams;
  export type Uninstall = UninstallParams;
  export type Withdraw = WithdrawParams;
  export type WithdrawCommitment = WithdrawCommitmentParams;
}

export type MethodParam =
  | CreateChannelParams
  | DeployStateDepositHolderParams
  | DepositParams
  | GetAppInstanceDetailsParams
  | GetAppInstancesParams
  | GetChannelAddressesParams
  | GetFreeBalanceStateParams
  | GetProposedAppInstanceParams
  | GetProposedAppInstancesParams
  | GetStateChannelParams
  | GetStateDepositHolderAddressParams
  | GetTokenIndexedFreeBalanceStatesParams
  | InstallParams
  | ProposeInstallParams
  | RejectInstallParams
  | RequestDepositRightsParams
  | RescindDepositRightsParams
  | SyncParams
  | TakeActionParams
  | UninstallParams
  | WithdrawParams
  | WithdrawCommitmentParams;

export namespace MethodResults {
  export type CreateChannel = CreateChannelResult;
  export type DeployStateDepositHolder = DeployStateDepositHolderResult;
  export type Deposit = DepositResult;
  export type GetAppInstanceDetails = GetAppInstanceDetailsResult;
  export type GetAppInstances = GetAppInstancesResult;
  export type GetChannelAddresses = GetChannelAddressesResult;
  export type GetFreeBalanceState = GetFreeBalanceStateResult;
  export type GetProposedAppInstance = GetProposedAppInstanceResult;
  export type GetProposedAppInstances = GetProposedAppInstancesResult;
  export type GetStateChannel = GetStateChannelResult;
  export type GetStateDepositHolderAddress = GetStateDepositHolderAddressResult;
  export type GetTokenIndexedFreeBalanceStates = GetTokenIndexedFreeBalanceStatesResult;
  export type Install = InstallResult;
  export type ProposeInstall = ProposeInstallResult;
  export type RejectInstall = RejectInstallResult;
  export type RequestDepositRights = RequestDepositRightsResult;
  export type RescindDepositRights = RescindDepositRightsResult;
  export type Sync = SyncResult;
  export type TakeAction = TakeActionResult;
  export type Uninstall = UninstallResult;
  export type Withdraw = WithdrawResult;
  export type WithdrawCommitment = WithdrawCommitmentResult;
}

export type MethodResult =
  | CreateChannelResult
  | DeployStateDepositHolderResult
  | DepositResult
  | GetAppInstanceDetailsResult
  | GetAppInstancesResult
  | GetChannelAddressesResult
  | GetFreeBalanceStateResult
  | GetProposedAppInstanceResult
  | GetProposedAppInstancesResult
  | GetStateChannelResult
  | GetStateDepositHolderAddressResult
  | GetTokenIndexedFreeBalanceStatesResult
  | InstallResult
  | ProposeInstallResult
  | RejectInstallResult
  | RequestDepositRightsResult
  | RescindDepositRightsResult
  | SyncResult
  | TakeActionResult
  | UninstallResult
  | WithdrawResult
  | WithdrawCommitmentResult;