feat: add connection events and subscription to multiple addresses, t…

[yoxira]

feat: add connection events and subscription to multiple addresses, types

Added

• Reconnecting behavior on disconnection and on connection errors, controlled by options.maxTries and options.reconnectionDelay

• onConnection(connectedNode: string) and onReconnectoin(connectedNode: string) methods

• Error on disconnection with reason code and message:

  socket.catch((error: unknown) => {
    if (error instanceof AdamantWsConnectionError) {
      console.log(error.reason, error.message)
    }
  })

• admAddresses, types and assetChatTypes options to subscribe to the corresponding transactions

• connect() and disconnect() methods

simple test script

const nodes = [
  'https://endless.adamant.im',
  'https://clown.adamant.im',
  'http://23.226.231.225:36666',
  'http://88.198.156.44:36666',
  'https://lake.adamant.im',
];

const admAddresses = ['U8084717991279447871'];

const socket = new WebSocketClient({
  // try out adding `types` or `assetChatTypes`! 
  admAddresses,
});

// socket.onReconnection(node => console.log('successfully reconnected'))

socket.onConnection(node => {
  console.log(`We connected to ${node}...`);
  console.log('...to disconnect from it');

  // disconnect to test reconnection
  socket.connection.disconnect();

  // // Uncomment to block following reconnections:
  // socket.nodes = [{wsType: 'ws', ip: '127.0.0.1'}];
});

socket.catch(err => {
  if (err.name === 'AdamantWsConnectionError') {
   if (err.reason === 'connection_error' || err.reason === 'disconnection') {
      console.log('We gave up on reconnecting! Reason: ', err.reason);
    }
  }
});

// We can use socket.reviseConnection(nodes) instead but then we need manually check the nodes
new AdamantApi({
  nodes,
  socket,
});

[yoxira]

Updated documentation:

WebSocket Connections
https://github.com/Adamant-im/adamant-api-jsclient/wiki/WebSocket-Connections

[bludnic]

After pnpm install the pnpm-lock.yaml changed.

Can you upgrade to the latest version and commit the pnpm-lock.yaml? @yoxira

[adamant-al]

@bludnic
Review

@yoxira
What's min ADM node version works with this?
If it's higher than 0.8.3, we better filter nodes in health check?

[bludnic]

Firstly, we can prioritize WS connections for nodes with higher versions.

In the case a node with old version (<0.8.4) is chosen for WS subscription:

1. If multiple ADM addresses are provided for subscription (options.admAddresses), only the first one will be selected, and a warning will be emitted:
   The [NODE:PORT] does not support subscription for multiple addresses. Only the U123456 address will be watched.

2. Other options, such as filtering by options.types and options.assetChatTypes will be ignored. A warning should also be shown, indicating that these options have no effect.

[adamant-al]

Firstly, we can prioritize WS connections for nodes with higher versions.

In the case a node with old version (<0.8.4) is chosen for WS subscription:

1. If multiple ADM addresses are provided for subscription (options.admAddresses), only the first one will be selected, and a warning will be emitted:
   The [NODE:PORT] does not support subscription for multiple addresses. Only the U123456 address will be watched.
2. Other options, such as filtering by options.types and options.assetChatTypes will be ignored. A warning should also be shown, indicating that these options have no effect.

I suppose ignore nodes with old version (<0.8.4).
Soon users update most nodes, and we'll not support legacy.

[bludnic]

@adamant-al I agree. Let's do as you suggested.