UNPKG

@kyve/core-beta

Version:

🚀 The base KYVE node implementation.

874 lines (686 loc) • 25.1 kB
import { Logger } from "tslog"; import { ICompression, IStorageProvider, Node } from "../src/index"; import { runNode } from "../src/methods/main/runNode"; import { genesis_pool } from "./mocks/constants"; import { client } from "./mocks/client.mock"; import { lcd } from "./mocks/lcd.mock"; import { TestCacheProvider } from "./mocks/cache.mock"; import { setupMetrics } from "../src/methods"; import { register } from "prom-client"; import { TestRuntime } from "./mocks/runtime.mock"; import { TestNoStorageProvider } from "./mocks/storageProvider.mock"; import { TestNoCompression } from "./mocks/compression.mock"; import { VoteType } from "@kyve/proto-beta/client/kyve/bundles/v1beta1/tx"; /* TEST CASES - no storage tests * propose bundle with data * propose bundle with no data * vote valid because bundle was proposed correctly * vote invalid because data size is not zero * vote invalid because data hash is not empty * vote invalid because bundle size is invalid */ describe("no storage tests", () => { let core: Node; let processExit: jest.Mock<never, never>; let setTimeoutMock: jest.Mock; let storageProvider: IStorageProvider; let compression: ICompression; beforeEach(() => { core = new Node(new TestRuntime()); core["cacheProvider"] = new TestCacheProvider(); // mock storage provider storageProvider = new TestNoStorageProvider(); core["storageProviderFactory"] = jest .fn() .mockResolvedValue(storageProvider); // mock compression compression = new TestNoCompression(); core["compressionFactory"] = jest.fn().mockReturnValue(compression); // mock process.exit processExit = jest.fn<never, never>(); process.exit = processExit; // mock setTimeout setTimeoutMock = jest .fn() .mockImplementation( ( callback: (args: void) => void, ms?: number | undefined ): NodeJS.Timeout => { callback(); return null as any; } ); global.setTimeout = setTimeoutMock as any; // mock logger core.logger = new Logger(); core.logger.info = jest.fn(); core.logger.debug = jest.fn(); core.logger.warn = jest.fn(); core.logger.error = jest.fn(); core["poolId"] = 0; core["staker"] = "test_staker"; core.client = client(); core.lcd = lcd(); core["waitForNextBundleProposal"] = jest.fn(); core["continueRound"] = jest .fn() .mockReturnValueOnce(true) .mockReturnValue(false); setupMetrics.call(core); }); afterEach(() => { // reset prometheus register.clear(); }); test("propose bundle with data", async () => { // ARRANGE core["lcd"].kyve.query.v1beta1.canVote = jest.fn().mockResolvedValue({ possible: false, reason: "Already voted", }); core["syncPoolState"] = jest.fn().mockImplementation(() => { core.pool = { ...genesis_pool, data: { ...genesis_pool.data, current_index: "100", current_key: "99", }, bundle_proposal: { ...genesis_pool.bundle_proposal, storage_id: "another_test_storage_id", uploader: "another_test_staker", next_uploader: "test_staker", data_size: "123456789", data_hash: "previous_test_bundle_hash", bundle_size: "2", from_key: "100", to_key: "101", bundle_summary: "previous_test_value", updated_at: "0", voters_valid: ["test_staker"], }, } as any; }); const bundle = [ { key: "test_key_1", value: "test_value_1", }, { key: "test_key_2", value: "test_value_2", }, { key: "test_key_3", value: "test_value_3", }, { key: "test_key_4", value: "test_value_4", }, ]; await core["cacheProvider"].put("102", bundle[0]); await core["cacheProvider"].put("103", bundle[1]); await core["cacheProvider"].put("104", bundle[2]); await core["cacheProvider"].put("105", bundle[3]); // ACT await runNode.call(core); // ASSERT const txs = core["client"].kyve.bundles.v1beta1; const queries = core["lcd"].kyve.query.v1beta1; const cacheProvider = core["cacheProvider"]; const runtime = core["runtime"]; // ======================== // ASSERT CLIENT INTERFACES // ======================== expect(txs.claimUploaderRole).toHaveBeenCalledTimes(0); expect(txs.voteBundleProposal).toHaveBeenCalledTimes(0); expect(txs.submitBundleProposal).toHaveBeenCalledTimes(1); expect(txs.submitBundleProposal).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", storage_id: "test_storage_id", data_size: "0", data_hash: "", from_index: "102", bundle_size: "4", from_key: "test_key_1", to_key: "test_key_4", bundle_summary: JSON.stringify(bundle), }); expect(txs.skipUploaderRole).toHaveBeenCalledTimes(0); // ===================== // ASSERT LCD INTERFACES // ===================== expect(queries.canVote).toHaveBeenCalledTimes(1); expect(queries.canVote).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", voter: "test_valaddress", storage_id: "another_test_storage_id", }); expect(queries.canPropose).toHaveBeenCalledTimes(1); expect(queries.canPropose).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", proposer: "test_valaddress", from_index: "102", }); // ========================= // ASSERT STORAGE INTERFACES // ========================= expect(storageProvider.saveBundle).toHaveBeenCalledTimes(1); expect(storageProvider.saveBundle).toHaveBeenLastCalledWith( Buffer.from(JSON.stringify(bundle)), expect.any(Array) ); expect(storageProvider.retrieveBundle).toHaveBeenCalledTimes(0); // ======================= // ASSERT CACHE INTERFACES // ======================= expect(cacheProvider.get).toHaveBeenCalledTimes(5); expect(cacheProvider.get).toHaveBeenNthCalledWith(1, "102"); expect(cacheProvider.get).toHaveBeenNthCalledWith(2, "103"); expect(cacheProvider.get).toHaveBeenNthCalledWith(3, "104"); expect(cacheProvider.get).toHaveBeenNthCalledWith(4, "105"); expect(cacheProvider.get).toHaveBeenNthCalledWith(5, "106"); // ============================= // ASSERT COMPRESSION INTERFACES // ============================= expect(compression.compress).toHaveBeenCalledTimes(1); expect(compression.compress).toHaveBeenLastCalledWith( Buffer.from(JSON.stringify(bundle)) ); expect(compression.decompress).toHaveBeenCalledTimes(0); // ========================= // ASSERT RUNTIME INTERFACES // ========================= expect(runtime.summarizeDataBundle).toHaveBeenCalledTimes(1); expect(runtime.summarizeDataBundle).toHaveBeenLastCalledWith(bundle); expect(runtime.validateDataItem).toHaveBeenCalledTimes(0); expect(runtime.getDataItem).toHaveBeenCalledTimes(0); expect(runtime.nextKey).toHaveBeenCalledTimes(0); // ======================== // ASSERT NODEJS INTERFACES // ======================== // assert that only one round ran expect(core["waitForNextBundleProposal"]).toHaveBeenCalledTimes(1); // TODO: assert timeouts }); test("propose bundle with no data", async () => { // ARRANGE core["lcd"].kyve.query.v1beta1.canVote = jest.fn().mockResolvedValue({ possible: false, reason: "Already voted", }); core["syncPoolState"] = jest.fn().mockImplementation(() => { core.pool = { ...genesis_pool, data: { ...genesis_pool.data, current_index: "100", current_key: "99", }, bundle_proposal: { ...genesis_pool.bundle_proposal, storage_id: "another_test_storage_id", uploader: "another_test_staker", next_uploader: "test_staker", data_size: "123456789", data_hash: "previous_test_bundle_hash", bundle_size: "2", from_key: "100", to_key: "101", bundle_summary: "previous_test_value", updated_at: "0", voters_valid: ["test_staker"], }, } as any; }); const bundle = [ { key: "test_key_1", value: "test_value_1", }, { key: "test_key_2", value: "test_value_2", }, ]; // ACT await runNode.call(core); // ASSERT const txs = core["client"].kyve.bundles.v1beta1; const queries = core["lcd"].kyve.query.v1beta1; const cacheProvider = core["cacheProvider"]; const runtime = core["runtime"]; // ======================== // ASSERT CLIENT INTERFACES // ======================== expect(txs.claimUploaderRole).toHaveBeenCalledTimes(0); expect(txs.voteBundleProposal).toHaveBeenCalledTimes(0); expect(txs.submitBundleProposal).toHaveBeenCalledTimes(0); expect(txs.skipUploaderRole).toHaveBeenCalledTimes(1); expect(txs.skipUploaderRole).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", from_index: "102", }); // ===================== // ASSERT LCD INTERFACES // ===================== expect(queries.canVote).toHaveBeenCalledTimes(1); expect(queries.canVote).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", voter: "test_valaddress", storage_id: "another_test_storage_id", }); expect(queries.canPropose).toHaveBeenCalledTimes(1); expect(queries.canPropose).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", proposer: "test_valaddress", from_index: "102", }); // ========================= // ASSERT STORAGE INTERFACES // ========================= expect(storageProvider.saveBundle).toHaveBeenCalledTimes(0); expect(storageProvider.retrieveBundle).toHaveBeenCalledTimes(0); // ======================= // ASSERT CACHE INTERFACES // ======================= expect(cacheProvider.get).toHaveBeenCalledTimes(1); expect(cacheProvider.get).toHaveBeenLastCalledWith("102"); // ============================= // ASSERT COMPRESSION INTERFACES // ============================= expect(compression.compress).toHaveBeenCalledTimes(0); expect(compression.decompress).toHaveBeenCalledTimes(0); // ========================= // ASSERT RUNTIME INTERFACES // ========================= expect(runtime.summarizeDataBundle).toHaveBeenCalledTimes(0); expect(runtime.validateDataItem).toHaveBeenCalledTimes(0); expect(runtime.getDataItem).toHaveBeenCalledTimes(0); expect(runtime.nextKey).toHaveBeenCalledTimes(0); // ======================== // ASSERT NODEJS INTERFACES // ======================== // assert that only one round ran expect(core["waitForNextBundleProposal"]).toHaveBeenCalledTimes(1); // TODO: assert timeouts }); test("vote valid because bundle was proposed correctly", async () => { // ARRANGE const bundle = [ { key: "test_key_1", value: "test_value_1" }, { key: "test_key_2", value: "test_value_2" }, ]; core["syncPoolState"] = jest.fn().mockImplementation(() => { core.pool = { ...genesis_pool, bundle_proposal: { ...genesis_pool.bundle_proposal, storage_id: "another_test_storage_id", uploader: "another_test_staker", next_uploader: "another_test_staker", data_size: "0", data_hash: "", bundle_size: "2", from_key: "test_key_1", to_key: "test_key_2", bundle_summary: JSON.stringify(bundle), updated_at: "0", voters_valid: ["another_test_staker"], }, } as any; }); core["cacheProvider"].get = jest .fn() .mockResolvedValueOnce({ key: "test_key_1", value: "test_value_1", }) .mockResolvedValueOnce({ key: "test_key_2", value: "test_value_2", }); // ACT await runNode.call(core); // ASSERT const txs = core["client"].kyve.bundles.v1beta1; const queries = core["lcd"].kyve.query.v1beta1; const cacheProvider = core["cacheProvider"]; const runtime = core["runtime"]; // ======================== // ASSERT CLIENT INTERFACES // ======================== expect(txs.claimUploaderRole).toHaveBeenCalledTimes(0); expect(txs.voteBundleProposal).toHaveBeenCalledTimes(1); expect(txs.voteBundleProposal).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", storage_id: "another_test_storage_id", vote: VoteType.VOTE_TYPE_VALID, }); expect(txs.submitBundleProposal).toHaveBeenCalledTimes(0); expect(txs.skipUploaderRole).toHaveBeenCalledTimes(0); // ===================== // ASSERT LCD INTERFACES // ===================== expect(queries.canVote).toHaveBeenCalledTimes(1); expect(queries.canVote).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", voter: "test_valaddress", storage_id: "another_test_storage_id", }); expect(queries.canPropose).toHaveBeenCalledTimes(0); // ========================= // ASSERT STORAGE INTERFACES // ========================= expect(storageProvider.saveBundle).toHaveBeenCalledTimes(0); expect(storageProvider.retrieveBundle).toHaveBeenCalledTimes(1); expect(storageProvider.retrieveBundle).toHaveBeenLastCalledWith( "another_test_storage_id", (120 - 20) * 1000 ); // ======================= // ASSERT CACHE INTERFACES // ======================= expect(cacheProvider.get).toHaveBeenCalledTimes(2); expect(cacheProvider.get).toHaveBeenNthCalledWith(1, "0"); expect(cacheProvider.get).toHaveBeenNthCalledWith(2, "1"); // ============================= // ASSERT COMPRESSION INTERFACES // ============================= expect(compression.compress).toHaveBeenCalledTimes(0); expect(compression.decompress).toHaveBeenCalledTimes(0); // ============================= // ASSERT INTEGRATION INTERFACES // ============================= expect(runtime.summarizeDataBundle).toHaveBeenCalledTimes(1); expect(runtime.summarizeDataBundle).toHaveBeenLastCalledWith(bundle); expect(runtime.validateDataItem).toHaveBeenCalledTimes(0); // ======================== // ASSERT NODEJS INTERFACES // ======================== // assert that only one round ran expect(core["waitForNextBundleProposal"]).toHaveBeenCalledTimes(1); // TODO: assert timeouts }); test("vote invalid because data size is not zero", async () => { // ARRANGE const bundle = [ { key: "test_key_1", value: "test_value_1" }, { key: "test_key_2", value: "test_value_2" }, ]; core["syncPoolState"] = jest.fn().mockImplementation(() => { core.pool = { ...genesis_pool, bundle_proposal: { ...genesis_pool.bundle_proposal, storage_id: "another_test_storage_id", uploader: "another_test_staker", next_uploader: "another_test_staker", data_size: "123456", data_hash: "", bundle_size: "2", from_key: "test_key_1", to_key: "test_key_2", bundle_summary: JSON.stringify(bundle), updated_at: "0", voters_valid: ["another_test_staker"], }, } as any; }); // ACT await runNode.call(core); // ASSERT const txs = core["client"].kyve.bundles.v1beta1; const queries = core["lcd"].kyve.query.v1beta1; const cacheProvider = core["cacheProvider"]; const runtime = core["runtime"]; // ======================== // ASSERT CLIENT INTERFACES // ======================== expect(txs.claimUploaderRole).toHaveBeenCalledTimes(0); expect(txs.voteBundleProposal).toHaveBeenCalledTimes(1); expect(txs.voteBundleProposal).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", storage_id: "another_test_storage_id", vote: VoteType.VOTE_TYPE_INVALID, }); expect(txs.submitBundleProposal).toHaveBeenCalledTimes(0); expect(txs.skipUploaderRole).toHaveBeenCalledTimes(0); // ===================== // ASSERT LCD INTERFACES // ===================== expect(queries.canVote).toHaveBeenCalledTimes(1); expect(queries.canVote).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", voter: "test_valaddress", storage_id: "another_test_storage_id", }); expect(queries.canPropose).toHaveBeenCalledTimes(0); // ========================= // ASSERT STORAGE INTERFACES // ========================= expect(storageProvider.saveBundle).toHaveBeenCalledTimes(0); expect(storageProvider.retrieveBundle).toHaveBeenCalledTimes(1); expect(storageProvider.retrieveBundle).toHaveBeenLastCalledWith( "another_test_storage_id", (120 - 20) * 1000 ); // ======================= // ASSERT CACHE INTERFACES // ======================= expect(cacheProvider.get).toHaveBeenCalledTimes(0); // ============================= // ASSERT COMPRESSION INTERFACES // ============================= expect(compression.compress).toHaveBeenCalledTimes(0); expect(compression.decompress).toHaveBeenCalledTimes(0); // ============================= // ASSERT INTEGRATION INTERFACES // ============================= expect(runtime.summarizeDataBundle).toHaveBeenCalledTimes(0); expect(runtime.validateDataItem).toHaveBeenCalledTimes(0); // ======================== // ASSERT NODEJS INTERFACES // ======================== // assert that only one round ran expect(core["waitForNextBundleProposal"]).toHaveBeenCalledTimes(1); // TODO: assert timeouts }); test("vote invalid because data hash is not empty", async () => { // ARRANGE const bundle = [ { key: "test_key_1", value: "test_value_1" }, { key: "test_key_2", value: "test_value_2" }, ]; core["syncPoolState"] = jest.fn().mockImplementation(() => { core.pool = { ...genesis_pool, bundle_proposal: { ...genesis_pool.bundle_proposal, storage_id: "another_test_storage_id", uploader: "another_test_staker", next_uploader: "another_test_staker", data_size: "0", data_hash: "test_hash", bundle_size: "2", from_key: "test_key_1", to_key: "test_key_2", bundle_summary: JSON.stringify(bundle), updated_at: "0", voters_valid: ["another_test_staker"], }, } as any; }); // ACT await runNode.call(core); // ASSERT const txs = core["client"].kyve.bundles.v1beta1; const queries = core["lcd"].kyve.query.v1beta1; const cacheProvider = core["cacheProvider"]; const runtime = core["runtime"]; // ======================== // ASSERT CLIENT INTERFACES // ======================== expect(txs.claimUploaderRole).toHaveBeenCalledTimes(0); expect(txs.voteBundleProposal).toHaveBeenCalledTimes(1); expect(txs.voteBundleProposal).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", storage_id: "another_test_storage_id", vote: VoteType.VOTE_TYPE_INVALID, }); expect(txs.submitBundleProposal).toHaveBeenCalledTimes(0); expect(txs.skipUploaderRole).toHaveBeenCalledTimes(0); // ===================== // ASSERT LCD INTERFACES // ===================== expect(queries.canVote).toHaveBeenCalledTimes(1); expect(queries.canVote).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", voter: "test_valaddress", storage_id: "another_test_storage_id", }); expect(queries.canPropose).toHaveBeenCalledTimes(0); // ========================= // ASSERT STORAGE INTERFACES // ========================= expect(storageProvider.saveBundle).toHaveBeenCalledTimes(0); expect(storageProvider.retrieveBundle).toHaveBeenCalledTimes(1); expect(storageProvider.retrieveBundle).toHaveBeenLastCalledWith( "another_test_storage_id", (120 - 20) * 1000 ); // ======================= // ASSERT CACHE INTERFACES // ======================= expect(cacheProvider.get).toHaveBeenCalledTimes(0); // ============================= // ASSERT COMPRESSION INTERFACES // ============================= expect(compression.compress).toHaveBeenCalledTimes(0); expect(compression.decompress).toHaveBeenCalledTimes(0); // ============================= // ASSERT INTEGRATION INTERFACES // ============================= expect(runtime.summarizeDataBundle).toHaveBeenCalledTimes(0); expect(runtime.validateDataItem).toHaveBeenCalledTimes(0); // ======================== // ASSERT NODEJS INTERFACES // ======================== // assert that only one round ran expect(core["waitForNextBundleProposal"]).toHaveBeenCalledTimes(1); // TODO: assert timeouts }); test("vote invalid because bundle size is invalid", async () => { // ARRANGE const bundle = [ { key: "test_key_1", value: "test_value_1" }, { key: "test_key_2", value: "test_value_2" }, ]; core["syncPoolState"] = jest.fn().mockImplementation(() => { core.pool = { ...genesis_pool, bundle_proposal: { ...genesis_pool.bundle_proposal, storage_id: "another_test_storage_id", uploader: "another_test_staker", next_uploader: "another_test_staker", data_size: "0", data_hash: "", bundle_size: "1", from_key: "test_key_1", to_key: "test_key_2", bundle_summary: JSON.stringify(bundle), updated_at: "0", voters_valid: ["another_test_staker"], }, } as any; }); core["cacheProvider"].get = jest .fn() .mockResolvedValueOnce({ key: "test_key_1", value: "test_value_1", }) .mockResolvedValueOnce({ key: "test_key_2", value: "test_value_2", }); // ACT await runNode.call(core); // ASSERT const txs = core["client"].kyve.bundles.v1beta1; const queries = core["lcd"].kyve.query.v1beta1; const cacheProvider = core["cacheProvider"]; const runtime = core["runtime"]; // ======================== // ASSERT CLIENT INTERFACES // ======================== expect(txs.claimUploaderRole).toHaveBeenCalledTimes(0); expect(txs.voteBundleProposal).toHaveBeenCalledTimes(1); expect(txs.voteBundleProposal).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", storage_id: "another_test_storage_id", vote: VoteType.VOTE_TYPE_INVALID, }); expect(txs.submitBundleProposal).toHaveBeenCalledTimes(0); expect(txs.skipUploaderRole).toHaveBeenCalledTimes(0); // ===================== // ASSERT LCD INTERFACES // ===================== expect(queries.canVote).toHaveBeenCalledTimes(1); expect(queries.canVote).toHaveBeenLastCalledWith({ staker: "test_staker", pool_id: "0", voter: "test_valaddress", storage_id: "another_test_storage_id", }); expect(queries.canPropose).toHaveBeenCalledTimes(0); // ========================= // ASSERT STORAGE INTERFACES // ========================= expect(storageProvider.saveBundle).toHaveBeenCalledTimes(0); expect(storageProvider.retrieveBundle).toHaveBeenCalledTimes(1); expect(storageProvider.retrieveBundle).toHaveBeenLastCalledWith( "another_test_storage_id", (120 - 20) * 1000 ); // ======================= // ASSERT CACHE INTERFACES // ======================= expect(cacheProvider.get).toHaveBeenCalledTimes(1); expect(cacheProvider.get).toHaveBeenNthCalledWith(1, "0"); // ============================= // ASSERT COMPRESSION INTERFACES // ============================= expect(compression.compress).toHaveBeenCalledTimes(0); expect(compression.decompress).toHaveBeenCalledTimes(0); // ============================= // ASSERT INTEGRATION INTERFACES // ============================= expect(runtime.summarizeDataBundle).toHaveBeenCalledTimes(0); expect(runtime.validateDataItem).toHaveBeenCalledTimes(0); // ======================== // ASSERT NODEJS INTERFACES // ======================== // assert that only one round ran expect(core["waitForNextBundleProposal"]).toHaveBeenCalledTimes(1); // TODO: assert timeouts }); });