Merge pull request #2074 from aeternity/hc-poll-interval

Set correct poll interval on hyperchain

Author: davidyuk

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   node:
     # TODO: switch to master after merging https://github.com/aeternity/aeternity/pull/4303
-    image: aeternity/aeternity:v7.3.0-rc2-bundle
+    image: aeternity/aeternity:v7.3.0-rc5-bundle
     # TODO: remove 3313 port after merging https://github.com/aeternity/aeternity/pull/4303
     ports: [3013:3013, 3113:3113, 3014:3014, 3313:3313]
     # TODO: remove after releasing https://github.com/aeternity/aeternity/pull/4292

src/Node.ts

@@ -91,6 +91,22 @@ export default class Node extends NodeApi {
     return promise;
   }
 
+  #isHyperchainPromise?: Promise<boolean>;
+
+  async _isHyperchain(): Promise<boolean> {
+    if (this.#isHyperchainPromise != null) return this.#isHyperchainPromise;
+    this.#isHyperchainPromise = this.getHyperchainContractPubkeys({
+      requestOptions: { customHeaders: { '__no-retry': 'true' } },
+    }).then(
+      () => true,
+      (error) => {
+        if (error.message !== 'v3/hyperchain/contracts error: 404 status code') throw error;
+        return false;
+      },
+    );
+    return this.#isHyperchainPromise;
+  }
+
   /**
    * Returns network ID provided by node.
    * This method won't do extra requests on subsequent calls.

src/chain.ts

@@ -15,37 +15,35 @@ import Node from './Node.js';
 import { DryRunResult, DryRunResults, SignedTx } from './apis/node/index.js';
 import { decode, encode, Encoded, Encoding } from './utils/encoder.js';
 
-/**
- * @category chain
- * @param type - Type
- * @param options - Options
- */
-export async function _getPollInterval(
+async function getEventInterval(
   type: 'key-block' | 'micro-block',
   {
     _expectedMineRate,
     _microBlockCycle,
     onNode,
   }: { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
 ): Promise<number> {
-  const getVal = async (
-    t: string,
-    val: number | undefined,
-    devModeDef: number,
-    def: number,
-  ): Promise<number | null> => {
-    if (t !== type) return null;
-    if (val != null) return val;
-    return (await onNode?.getNetworkId()) === 'ae_dev' ? devModeDef : def;
-  };
+  if (_expectedMineRate != null && type === 'key-block') return _expectedMineRate;
+  if (_microBlockCycle != null && type === 'micro-block') return _microBlockCycle;
+
+  const networkId = await onNode.getNetworkId();
+  if (networkId === 'ae_dev') return 0;
+  if (!['ae_mainnet', 'ae_uat'].includes(networkId) && (await onNode._isHyperchain())) return 3000;
+
+  if (type === 'key-block') return 180000;
+  else return 3000;
+}
 
-  const base =
-    (await getVal('key-block', _expectedMineRate, 0, 180000)) ??
-    (await getVal('micro-block', _microBlockCycle, 0, 3000)) ??
-    (() => {
-      throw new InternalError(`Unknown type: ${type}`);
-    })();
-  return Math.floor(base / 3);
+/**
+ * @category chain
+ * @param type - Type
+ * @param options - Options
+ */
+export async function _getPollInterval(
+  type: Parameters<typeof getEventInterval>[0],
+  options: Parameters<typeof getEventInterval>[1],
+): Promise<number> {
+  return Math.floor((await getEventInterval(type, options)) / 3);
 }
 
 const heightCache: WeakMap<Node, { time: number; height: number }> = new WeakMap();

src/utils/autorest.ts

@@ -220,6 +220,11 @@ export const genRetryOnFailurePolicy = (
   policy: {
     name: 'retry-on-failure',
     async sendRequest(request, next) {
+      if (request.headers.get('__no-retry') != null) {
+        request.headers.delete('__no-retry');
+        return next(request);
+      }
+
       const retryCode = request.headers.get('__retry-code') ?? NaN;
       request.headers.delete('__retry-code');
       const statusesToNotRetry = [200, 400, 403, 410, 500].filter((c) => c !== +retryCode);

test/integration/AeSdk.ts

@@ -1,6 +1,7 @@
 import { describe, it } from 'mocha';
 import { expect } from 'chai';
-import { getSdk, networkId } from '.';
+import { getSdk } from '.';
+import { Node } from '../../src';
 
 describe('AeSdk', () => {
   describe('_getPollInterval', () => {
@@ -12,13 +13,50 @@ describe('AeSdk', () => {
       expect(await aeSdk._getPollInterval('micro-block')).to.equal(100);
     });
 
-    it('returns correct value', async () => {
-      const aeSdk = await getSdk(0);
-      delete aeSdk._options._expectedMineRate;
-      delete aeSdk._options._microBlockCycle;
-      const [kb, mb] = networkId === 'ae_dev' ? [0, 0] : [60000, 1000];
-      expect(await aeSdk._getPollInterval('key-block')).to.equal(kb);
-      expect(await aeSdk._getPollInterval('micro-block')).to.equal(mb);
-    });
+    (
+      [
+        [
+          'devnet',
+          0,
+          0,
+          (node: Node) => (node.getNetworkId = async () => Promise.resolve('ae_dev')),
+        ],
+        [
+          'hyperchains',
+          1000,
+          1000,
+          (node: Node) => {
+            node.getNetworkId = async () => Promise.resolve('ae_random');
+            node._isHyperchain = async () => Promise.resolve(true);
+          },
+        ],
+        [
+          'mainnet',
+          60000,
+          1000,
+          (node: Node) => {
+            node.getNetworkId = async () => Promise.resolve('ae_mainnet');
+            node._isHyperchain = () => {
+              throw new Error("Shouldn't be called");
+            };
+          },
+        ],
+        [
+          'default case',
+          60000,
+          1000,
+          (node: Node) => (node.getNetworkId = async () => Promise.resolve('ae_random')),
+        ],
+      ] as const
+    ).forEach(([name, kb, mb, cb]) =>
+      it(`handles ${name}`, async () => {
+        const aeSdk = await getSdk(0);
+        cb(aeSdk.api);
+        delete aeSdk._options._expectedMineRate;
+        delete aeSdk._options._microBlockCycle;
+        expect(await aeSdk._getPollInterval('key-block')).to.equal(kb);
+        expect(await aeSdk._getPollInterval('micro-block')).to.equal(mb);
+      }),
+    );
   });
 });

tooling/autorest/node.yaml

@@ -134,14 +134,6 @@ directive:
       Convert time as milliseconds to dates
       https://github.com/aeternity/aeternity/issues/4386
 
-  - from: openapi-document
-    where: $.components.schemas.AuctionEntry
-    transform: >
-      $.required.push('started_at');
-    reason: >
-      marks additional fields as required
-      remove after fixing https://github.com/aeternity/aeternity/pull/4537
-
   - from: openapi-document
     where: $.components.schemas
     transform: >
@@ -160,7 +152,7 @@ version: ^3.7.1
 use-extension:
   '@autorest/typescript': ^6.0.23
   '@autorest/modelerfour': ^4.27.0
-input-file: https://raw.githubusercontent.com/aeternity/aeternity/v7.3.0-rc2/apps/aehttp/priv/oas3.yaml
+input-file: https://raw.githubusercontent.com/aeternity/aeternity/v7.3.0-rc5/apps/aehttp/priv/oas3.yaml
 output-folder: ../../src/apis/node
 source-code-folder-path: .
 generator: typescript