jsonld-signatures-merkleproof2019/tests/utils/ensureExplorerAPIValidity.test.ts

A jsonld signature implementation to support MerkleProof2019 verification in Verifiable Credential context

import { describe, it, expect } from 'vitest';
import { type ExplorerAPI, type TransactionData } from '@blockcerts/explorer-lookup';
import ensureExplorerAPIValidity from '../../src/utils/ensureExplorerAPIValidity';

describe('ensureExplorerAPIValidity test suite', function () {
  describe('given at least one custom explorer has a priority value under 0', function () {
    const fixtureExplorerAPIs: ExplorerAPI[] = [{
      serviceURL: 'https://fixture-url.tld',
      priority: -1,
      parsingFunction: (): TransactionData => {
        return {
          remoteHash: 'a',
          issuingAddress: 'b',
          time: 'c',
          revokedAddresses: ['d']
        };
      }
    }];

    it('should throw the right error', function () {
      expect(() => {
        ensureExplorerAPIValidity(fixtureExplorerAPIs);
      }).toThrow('One or more of your custom explorer APIs has a priority set below zero');
    });
  });

  describe('given at least one custom explorer\'s parsing function is missing', function () {
    const fixtureExplorerAPIs: ExplorerAPI[] = [{
      serviceURL: 'https://fixture-url.tld',
      priority: 0,
      parsingFunction: undefined
    }];

    it('should throw the right error', function () {
      expect(() => {
        ensureExplorerAPIValidity(fixtureExplorerAPIs);
      }).toThrow('One or more of your custom explorer APIs does not have a parsing function');
    });
  });

  describe('given everything is as expected', function () {
    const fixtureExplorerAPIs: ExplorerAPI[] = [{
      serviceURL: 'https://fixture-url.tld',
      priority: 0,
      parsingFunction: (): TransactionData => {
        return {
          remoteHash: 'a',
          issuingAddress: 'b',
          time: 'c',
          revokedAddresses: ['d']
        };
      }
    }];

    it('should return true', function () {
      const test = ensureExplorerAPIValidity(fixtureExplorerAPIs);
      expect(test).toBe(true);
    });
  });
});