Merge pull request #1982 from aeternity/channel-tests

Improve channel tests and fixes

.mocharc.js

@@ -2,7 +2,6 @@ module.exports = {
   require: 'tooling/babel-register.js',
   recursive: true,
   extension: '.js,.ts',
-  timeout: process.env.NETWORK ? '500s' : '8s',
+  timeout: process.env.NETWORK ? '500s' : '6s',
   ignore: 'test/environment/**',
-  exit: true // TODO: fix in state channel tests
 }

docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3'
 services:
   node:
     # TODO: switch to master after merging https://github.com/aeternity/aeternity/pull/4303

src/channel/Base.ts

@@ -260,7 +260,7 @@ export default class Channel {
    * })
    * ```
    */
-  async leave(): Promise<{ channelId: Encoded.Bytearray; signedTx: Encoded.Transaction }> {
+  async leave(): Promise<{ channelId: Encoded.Channel; signedTx: Encoded.Transaction }> {
     return this.enqueueAction(() => {
       notify(this, 'channels.leave');
       return { handler: handlers.awaitingLeave };

src/channel/internal.ts

@@ -52,7 +52,7 @@ export type SignTx = (tx: Encoded.Transaction, options?: SignOptions) => (
 /**
  * @see {@link https://github.com/aeternity/protocol/blob/6734de2e4c7cce7e5e626caa8305fb535785131d/node/api/channels_api_usage.md#channel-establishing-parameters}
  */
-export interface ChannelOptions {
+interface CommonChannelOptions {
   existingFsmId?: Encoded.Bytearray;
   /**
    * Channel url (for example: "ws://localhost:3001")
@@ -74,7 +74,7 @@ export interface ChannelOptions {
   /**
    * Initial deposit in favour of the responder by the initiator
    */
-  pushAmount: number;
+  pushAmount: BigNumber | number;
   /**
    * Amount of coins the initiator has committed to the channel
    */
@@ -92,17 +92,9 @@ export interface ChannelOptions {
    */
   ttl?: number;
   /**
-   * Host of the responder's node
-   */
-  host: string;
-  /**
-   * The port of the responders node
+   * The port of the responder's node
    */
   port: number;
-  /**
-   * Participant role
-   */
-  role: 'initiator' | 'responder';
   /**
    * How to calculate minimum depth (default: txfee)
    */
@@ -120,16 +112,16 @@ export interface ChannelOptions {
    */
   gasPrice?: BigNumber | number;
 
-  signedTx?: string;
+  signedTx?: Encoded.Transaction;
   /**
    * Existing channel id (required if reestablishing a channel)
    */
-  existingChannelId?: string;
+  existingChannelId?: Encoded.Channel;
   /**
    * Offchain transaction (required if reestablishing a channel)
    */
-  offChainTx?: string;
-  reconnectTx?: string;
+  offChainTx?: Encoded.Transaction;
+  reconnectTx?: Encoded.Transaction;
   /**
    * The time waiting for a new event to be initiated (default: 600000)
    */
@@ -174,7 +166,6 @@ export interface ChannelOptions {
    * Applicable only for responder (default: timeout_idle's value)
    */
   timeoutAwaitingOpen?: number;
-  statePassword?: string;
   /**
    * Log websocket communication and state changes
    */
@@ -183,9 +174,25 @@ export interface ChannelOptions {
    * Function which verifies and signs transactions
    */
   sign: SignTxWithTag;
-  offchainTx?: string;
+  offchainTx?: Encoded.Transaction;
 }
 
+export type ChannelOptions = CommonChannelOptions & ({
+  /**
+   * Participant role
+   */
+  role: 'initiator';
+  /**
+   * Host of the responder's node
+   */
+  host: string;
+} | {
+  /**
+   * Participant role
+   */
+  role: 'responder';
+});
+
 export interface ChannelHandler extends Function {
   enter?: Function;
 }

test/integration/MiddlewareSubscriber.ts

@@ -45,13 +45,16 @@ describe('MiddlewareSubscriber', () => {
   });
 
   it('fails to subscribe to invalid address', async () => {
+    let unsubscribe: (() => void) | undefined;
     const promise = new Promise((resolve, reject) => {
-      middleware.subscribeObject('ak_test', (payload, error) => {
+      unsubscribe = middleware.subscribeObject('ak_test', (payload, error) => {
         if (error != null) reject(error);
         else resolve(payload);
       });
     });
     await expect(promise).to.be.rejectedWith(_MiddlewareSubscriberError, 'invalid target: ak_test');
+    assertNotNull(unsubscribe);
+    unsubscribe();
   });
 
   async function ensureConnected(ms: _MiddlewareSubscriber): Promise<void> {