Merge pull request #154 from LiskHQ/153-update-supportedtokenssubstor…

…e-entry Update supportedTokensSubstore entry in addTokenModuleEntry
LiskArchive · Sep 15, 2023 · ee0dc3d · ee0dc3d
2 parents 8ab3875 + 326d739
commit ee0dc3d
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 41 deletions.
diff --git a/src/assets/pos.ts b/src/assets/pos.ts
@@ -77,13 +77,13 @@ export const formatInt = (num: number | bigint): string => {
 export const getValidatorKeys = async (
  accounts: Account[],
  snapshotHeight: number,
- snapshotHeightPrevious: number,
+ prevSnapshotBlockHeight: number,
  db: Database,
 ): Promise<Record<string, string>> => {
  const keys: Record<string, string> = {};
 
  const blocksStream = db.createReadStream({
- gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeightPrevious + 1)}`),
+ gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(prevSnapshotBlockHeight + 1)}`),
  lte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeight)}`),
  });
 

diff --git a/src/constants.ts b/src/constants.ts
@@ -40,7 +40,6 @@ export const MAX_BFT_WEIGHT_CAP = 1000;
 
 export const SNAPSHOT_BLOCK_VERSION = 0;
 export const SNAPSHOT_TIME_GAP = 0; // TODO: Update once decided
-export const ALL_SUPPORTED_TOKENS_KEY = Buffer.alloc(0);
 
 export const ADDRESS_LEGACY_RESERVE = hash(Buffer.from('legacyReserve', 'utf8')).slice(0, 20);
 export const INVALID_BLS_KEY = Buffer.alloc(48, 0).toString('hex');
@@ -65,12 +64,12 @@ export const NETWORK_CONSTANT: { [key: string]: NetworkConfigLocal } = {
  '4c09e6a781fc4c7bdb936ee815de8f94190f8a7519becd9de2081832be309a99': {
  name: 'mainnet',
  tokenID: TOKEN_ID_LSK.MAINNET,
- snapshotHeightPrevious: HEIGHT_PREVIOUS_SNAPSHOT_BLOCK.MAINNET,
+ prevSnapshotBlockHeight: HEIGHT_PREVIOUS_SNAPSHOT_BLOCK.MAINNET,
  },
  '15f0dacc1060e91818224a94286b13aa04279c640bd5d6f193182031d133df7c': {
  name: 'testnet',
  tokenID: TOKEN_ID_LSK.TESTNET,
- snapshotHeightPrevious: HEIGHT_PREVIOUS_SNAPSHOT_BLOCK.TESTNET,
+ prevSnapshotBlockHeight: HEIGHT_PREVIOUS_SNAPSHOT_BLOCK.TESTNET,
  },
 };
 

diff --git a/src/createAsset.ts b/src/createAsset.ts
@@ -22,7 +22,6 @@ import {
  DB_KEY_ACCOUNTS_ADDRESS,
  BINARY_ADDRESS_LENGTH,
  ADDRESS_LEGACY_RESERVE,
- ALL_SUPPORTED_TOKENS_KEY,
 } from './constants';
 import { accountSchema, voteWeightsSchema } from './schemas';
 import {
@@ -76,7 +75,7 @@ export class CreateAsset {
 
  public init = async (
  snapshotHeight: number,
- snapshotHeightPrevious: number,
+ prevSnapshotBlockHeight: number,
  tokenID: string,
  ): Promise<GenesisAssetEntry[]> => {
  const authSubstoreEntries: AuthStoreEntryBuffer[] = [];
@@ -130,7 +129,7 @@ export class CreateAsset {
  const validatorKeys = await getValidatorKeys(
  accounts,
  snapshotHeight,
- snapshotHeightPrevious,
+ prevSnapshotBlockHeight,
  this._db,
  );
 
@@ -140,11 +139,11 @@ export class CreateAsset {
  authSubstoreEntries.push(authModuleAsset);
 
  // genesis asset for token module
- // Create user subtore entries
+ // Create user substore entries
  const userSubstoreEntry = await createUserSubstoreArrayEntry(account, tokenID);
  if (userSubstoreEntry) userSubstoreEntries.push(userSubstoreEntry);
 
- // Create total lisk supply for supply subtore
+ // Create total lisk supply for supply substore
  totalLSKSupply += BigInt(account.token.balance);
  const lockedBalances = await getLockedBalances(account);
  totalLSKSupply = lockedBalances.reduce(
@@ -187,12 +186,6 @@ export class CreateAsset {
  totalSupply: String(totalLSKSupply + legacyReserveAmount),
  });
 
- // Update supported tokens substore to support all tokens by default
- supportedTokensSubstoreEntries.push({
- chainID: ALL_SUPPORTED_TOKENS_KEY,
- supportedTokenIDs: [],
- });
-
  // Sort validators substore entries in lexicographical order
  const sortedValidators = validators.sort(addressComparator).map(({ address, ...entry }) => ({
  ...entry,

diff --git a/src/index.ts b/src/index.ts
@@ -41,9 +41,9 @@ import {
 import {
  observeChainHeight,
  getTokenIDLsk,
- getHeightPrevSnapshotBlock,
+ getPrevSnapshotBlockHeight,
  setTokenIDLskByNetID,
- setHeightPrevSnapshotBlockByNetID,
+ setPrevSnapshotBlockHeightByNetID,
 } from './utils/chain';
 import { createGenesisBlock, writeGenesisAssets } from './utils/genesis_block';
 import { CreateAsset } from './createAsset';
@@ -168,7 +168,7 @@ class LiskMigrator extends Command {
  : await getConfig(liskCoreV3DataPath);
 
  await setTokenIDLskByNetID(networkIdentifier);
- await setHeightPrevSnapshotBlockByNetID(networkIdentifier);
+ await setPrevSnapshotBlockHeightByNetID(networkIdentifier);
 
  await observeChainHeight({
  label: 'Waiting for snapshot height to be finalized',
@@ -188,8 +188,12 @@ class LiskMigrator extends Command {
  cli.action.start('Creating genesis assets');
  const createAsset = new CreateAsset(db);
  const tokenID = getTokenIDLsk();
- const snapshotHeightPrevious = getHeightPrevSnapshotBlock();
- const genesisAssets = await createAsset.init(snapshotHeight, snapshotHeightPrevious, tokenID);
+ const prevSnapshotBlockHeight = getPrevSnapshotBlockHeight();
+ const genesisAssets = await createAsset.init(
+ snapshotHeight,
+ prevSnapshotBlockHeight,
+ tokenID,
+ );
  cli.action.stop();
 
  // Create an app instance for creating genesis block

diff --git a/src/types.ts b/src/types.ts
@@ -361,7 +361,7 @@ export interface GenesisInteroperability {
 export interface NetworkConfigLocal {
  name: string;
  tokenID: string;
- snapshotHeightPrevious: number;
+ prevSnapshotBlockHeight: number;
 }
 
 export interface RegisteredModule {

diff --git a/src/utils/chain.ts b/src/utils/chain.ts
@@ -16,7 +16,7 @@ import { getAPIClient } from '../client';
 import { NETWORK_CONSTANT } from '../constants';
 
 let tokenIDLsk: string;
-let heightPreviousSnapshotBlock: number;
+let prevSnapshotBlockHeight: number;
 
 interface ObserveParams {
  readonly label: string;
@@ -32,13 +32,12 @@ export const setTokenIDLskByNetID = async (networkIdentifier: string): Promise<v
  tokenIDLsk = NETWORK_CONSTANT[networkIdentifier].tokenID as string;
 };
 
-export const getHeightPrevSnapshotBlock = (): number => heightPreviousSnapshotBlock;
+export const getPrevSnapshotBlockHeight = (): number => prevSnapshotBlockHeight;
 
-export const setHeightPrevSnapshotBlockByNetID = async (
+export const setPrevSnapshotBlockHeightByNetID = async (
  networkIdentifier: string,
 ): Promise<void> => {
- heightPreviousSnapshotBlock = NETWORK_CONSTANT[networkIdentifier]
- .snapshotHeightPrevious as number;
+ prevSnapshotBlockHeight = NETWORK_CONSTANT[networkIdentifier].prevSnapshotBlockHeight as number;
 };
 
 export const getNodeInfo = async (

diff --git a/test/unit/assets/pos.spec.ts b/test/unit/assets/pos.spec.ts
@@ -51,7 +51,7 @@ describe('Build assets/pos', () => {
  let blockIDsStream: { value: Buffer }[];
  let delegates: VoteWeightsWrapper;
  const snapshotHeight = 10815;
- const snapshotHeightPrevious = 5000;
+ const prevSnapshotBlockHeight = 5000;
 
  beforeAll(async () => {
  db = new Database('testDB');
@@ -150,7 +150,7 @@ describe('Build assets/pos', () => {
  it('should create createValidatorsArrayEntry', async () => {
  when(db.createReadStream)
  .calledWith({
- gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeightPrevious + 1)}`),
+ gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(prevSnapshotBlockHeight + 1)}`),
  lte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeight)}`),
  })
  .mockReturnValue(Readable.from(blockIDsStream));
@@ -169,7 +169,7 @@ describe('Build assets/pos', () => {
  const validatorKeys = await getValidatorKeys(
  accounts,
  snapshotHeight,
- snapshotHeightPrevious,
+ prevSnapshotBlockHeight,
  db,
  );
 
@@ -243,20 +243,20 @@ describe('Build assets/pos', () => {
  it('should throw error when creating stream with invalid file path', async () => {
  when(db.createReadStream)
  .calledWith({
- gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeightPrevious + 1)}`),
+ gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(prevSnapshotBlockHeight + 1)}`),
  lte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeight)}`),
  })
  .mockReturnValue(createReadStream('test.txt') as never);
 
  await expect(
- getValidatorKeys(accounts, snapshotHeight, snapshotHeightPrevious, db),
+ getValidatorKeys(accounts, snapshotHeight, prevSnapshotBlockHeight, db),
  ).rejects.toThrow();
  });
 
  it('should create PoS module asset', async () => {
  when(db.createReadStream)
  .calledWith({
- gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeightPrevious + 1)}`),
+ gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(prevSnapshotBlockHeight + 1)}`),
  lte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeight)}`),
  })
  .mockReturnValue(Readable.from(blockIDsStream));
@@ -275,7 +275,7 @@ describe('Build assets/pos', () => {
  const validatorKeys = await getValidatorKeys(
  accounts,
  snapshotHeight,
- snapshotHeightPrevious,
+ prevSnapshotBlockHeight,
  db,
  );
 

diff --git a/test/unit/createAsset.spec.ts b/test/unit/createAsset.spec.ts
@@ -59,7 +59,7 @@ describe('Build assets/legacy', () => {
  let delegates: VoteWeightsWrapper;
  let encodedVoteWeights: Buffer;
  const snapshotHeight = 10815;
- const snapshotHeightPrevious = 5000;
+ const prevSnapshotBlockHeight = 5000;
  const tokenID = '0400000000000000';
 
  interface Accounts {
@@ -209,7 +209,7 @@ describe('Build assets/legacy', () => {
 
  when(db.createReadStream)
  .calledWith({
- gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeightPrevious + 1)}`),
+ gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(prevSnapshotBlockHeight + 1)}`),
  lte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeight)}`),
  })
  .mockReturnValue(Readable.from([]));
@@ -218,7 +218,7 @@ describe('Build assets/legacy', () => {
  .calledWith(Buffer.from(`${DB_KEY_CHAIN_STATE}:${CHAIN_STATE_DELEGATE_VOTE_WEIGHTS}`))
  .mockResolvedValue(encodedVoteWeights as never);
 
- const response = await createAsset.init(snapshotHeight, snapshotHeightPrevious, tokenID);
+ const response = await createAsset.init(snapshotHeight, prevSnapshotBlockHeight, tokenID);
 
  const moduleList = [
  MODULE_NAME_LEGACY,
@@ -246,20 +246,20 @@ describe('Build assets/legacy', () => {
  .mockReturnValue(undefined);
 
  await expect(
- createAsset.init(snapshotHeight, snapshotHeightPrevious, tokenID),
+ createAsset.init(snapshotHeight, prevSnapshotBlockHeight, tokenID),
  ).rejects.toThrow();
  });
 
  it('should throw error when block stream is undefined', async () => {
  when(db.createReadStream)
  .calledWith({
- gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeightPrevious + 1)}`),
+ gte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(prevSnapshotBlockHeight + 1)}`),
  lte: Buffer.from(`${DB_KEY_BLOCKS_HEIGHT}:${formatInt(snapshotHeight)}`),
  })
  .mockReturnValue(undefined);
 
  await expect(
- createAsset.init(snapshotHeight, snapshotHeightPrevious, tokenID),
+ createAsset.init(snapshotHeight, prevSnapshotBlockHeight, tokenID),
  ).rejects.toThrow();
  });
 
@@ -278,7 +278,7 @@ describe('Build assets/legacy', () => {
  .mockReturnValue(createReadStream('test.txt') as never);
 
  await expect(
- createAsset.init(snapshotHeight, snapshotHeightPrevious, tokenID),
+ createAsset.init(snapshotHeight, prevSnapshotBlockHeight, tokenID),
  ).rejects.toThrow();
  });
  });