@aeternity/aepp-sdk 13.0.0-alpha.0 → 13.0.0-beta.0

package/src/channel/handlers.ts

@@ -1,19 +1,3 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
 /* eslint-disable consistent-return */
 /* eslint-disable default-case */
 /* eslint-disable @typescript-eslint/no-use-before-define */
@@ -21,7 +5,6 @@ import {
   ChannelState,
   changeStatus,
   changeState,
-  call,
   notify,
   emit,
   disconnect,
@@ -29,9 +12,10 @@ import {
   ChannelFsm,
   SignTx,
   ChannelStatus,
+  ChannelEvents,
 } from './internal';
 import { unpackTx, buildTx } from '../tx/builder';
-import { encode, Encoded, Encoding } from '../utils/encoder';
+import { decode, Encoded } from '../utils/encoder';
 import {
   IllegalArgumentError,
   InsufficientBalanceError,
@@ -41,19 +25,22 @@ import {
 } from '../utils/errors';
 import type Channel from './Base';
 import { Tag } from '../tx/builder/constants';
+import { snakeToPascal } from '../utils/string';
 
 export async function appendSignature(
   tx: Encoded.Transaction,
   signFn: SignTx,
 ): Promise<Encoded.Transaction | number | null> {
-  const { signatures, encodedTx } = unpackTx(tx, Tag.SignedTx).tx;
-  const result = await signFn(encode(encodedTx.rlpEncoded, Encoding.Transaction));
+  const { signatures, encodedTx } = unpackTx(tx, Tag.SignedTx);
+  const payloadTx = buildTx(encodedTx);
+  const result = await signFn(payloadTx);
   if (typeof result === 'string') {
-    const { tx: signedTx } = unpackTx(result, Tag.SignedTx);
+    const { signatures: signatures2 } = unpackTx(result, Tag.SignedTx);
     return buildTx({
-      signatures: signatures.concat(signedTx.signatures),
-      encodedTx: signedTx.encodedTx.rlpEncoded,
-    }, Tag.SignedTx).tx;
+      tag: Tag.SignedTx,
+      signatures: signatures.concat(signatures2),
+      encodedTx: decode(payloadTx),
+    });
   }
   return result;
 }
@@ -164,7 +151,8 @@ export async function awaitingReconnection(
   if (message.method === 'channels.info') {
     if (message.params.data.event === 'fsm_up') {
       channel._fsmId = message.params.data.fsm_id;
-      changeState(channel, (await call(channel, 'channels.get.offchain_state', {})).signed_tx);
+      const { signedTx } = await channel.state();
+      changeState(channel, signedTx == null ? '' : buildTx(signedTx));
       return { handler: channelOpen };
     }
   }
@@ -269,7 +257,7 @@ export async function channelOpen(
           //
           //       We should enter intermediate state where offchain transactions
           //       are blocked until channel is reestablished.
-          emit(channel, message.params.data.event);
+          emit(channel, snakeToPascal(message.params.data.event) as keyof ChannelEvents);
           return { handler: channelOpen };
         case 'fsm_up':
           channel._fsmId = message.params.data.fsm_id;

package/src/channel/internal.ts

@@ -1,20 +1,3 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
 import { w3cwebsocket as W3CWebSocket } from 'websocket';
 import BigNumber from 'bignumber.js';
 import type Channel from './Base';
@@ -30,6 +13,23 @@ import {
   ChannelIncomingMessageError,
   ChannelError,
 } from '../utils/errors';
+import { encodeContractAddress } from '../utils/crypto';
+import { buildTx } from '../tx/builder';
+
+export interface ChannelEvents {
+  statusChanged: (status: ChannelStatus) => void;
+  stateChanged: (tx: Encoded.Transaction | '') => void;
+  depositLocked: () => void;
+  ownDepositLocked: () => void;
+  withdrawLocked: () => void;
+  ownWithdrawLocked: () => void;
+  peerDisconnected: () => void;
+  channelReestablished: () => void;
+  error: (error: Error) => void;
+  onChainTx: (tx: Encoded.Transaction, details: { info: string; type: string }) => void;
+  message: (message: string | Object) => void;
+  newContract: (contractAddress: Encoded.ContractAddress) => void;
+}
 
 export interface ChannelAction {
   guard: (channel: Channel, state?: ChannelFsm) => boolean;
@@ -139,7 +139,10 @@ const PING_TIMEOUT_MS = 10000;
 // Close connection if pong message is not received within 15 seconds
 const PONG_TIMEOUT_MS = 15000;
 
-export function emit(channel: Channel, ...args: any[]): void {
+export function emit<E extends keyof ChannelEvents>(
+  channel: Channel,
+  ...args: [E, ...Parameters<ChannelEvents[E]>]
+): void {
   const [eventName, ...rest] = args;
   channel._eventEmitter.emit(eventName, ...rest);
 }
@@ -166,7 +169,7 @@ export function changeStatus(channel: Channel, newStatus: ChannelStatus): void {
   emit(channel, 'statusChanged', newStatus);
 }
 
-export function changeState(channel: Channel, newState: Encoded.Transaction): void {
+export function changeState(channel: Channel, newState: Encoded.Transaction | ''): void {
   channel._state = newState;
   emit(channel, 'stateChanged', newState);
 }
@@ -211,9 +214,21 @@ export async function enqueueAction(
   return promise;
 }
 
-async function handleMessage(channel: Channel, message: object): Promise<void> {
+async function handleMessage(channel: Channel, message: ChannelMessage): Promise<void> {
   const { handler, state: st } = channel._fsm;
-  enterState(channel, await Promise.resolve(handler(channel, message, st)));
+  const nextState = await Promise.resolve(handler(channel, message, st));
+  enterState(channel, nextState);
+  // TODO: emit message and handler name (?) to move this code to Contract constructor
+  if (
+    message?.params?.data?.updates?.[0]?.op === 'OffChainNewContract'
+    // if name is channelOpen, the contract was created by other participant
+    && nextState?.handler.name === 'channelOpen'
+  ) {
+    const round = channel.round();
+    if (round == null) throw new UnexpectedTsError('Round is null');
+    const owner = message?.params?.data?.updates?.[0]?.owner;
+    emit(channel, 'newContract', encodeContractAddress(owner, round + 1));
+  }
 }
 
 async function dequeueMessage(channel: Channel): Promise<void> {
@@ -317,8 +332,11 @@ export async function initialize(
         changeStatus(channel, 'connected');
         if (channelOptions.reconnectTx != null) {
           enterState(channel, { handler: openHandler });
-          const signedTx = (await call(channel, 'channels.get.offchain_state', {})).signed_tx;
-          changeState(channel, signedTx);
+          const { signedTx } = await channel.state();
+          if (signedTx == null) {
+            throw new ChannelError('`signedTx` missed in state while reconnection');
+          }
+          changeState(channel, buildTx(signedTx));
         }
         ping(channel);
       },