feat: 🎸 validate new ticker length against live chain TickerConfig

Author: prashantasdeveloper

src/api/procedures/createAsset.ts

@@ -42,6 +42,7 @@ import {
   stringToTicker,
 } from '~/utils/conversion';
 import {
+  assertTickerLengthValid,
   checkTxType,
   isAllowedCharacters,
   optionize,
@@ -272,6 +273,7 @@ export async function prepareCreateAsset(
   let rawTicker: PolymeshPrimitivesTicker | undefined;
 
   if (ticker) {
+    await assertTickerLengthValid(ticker, context);
     rawTicker = stringToTicker(ticker, context);
   }
 

src/api/procedures/createNftCollection.ts

@@ -45,6 +45,7 @@ import {
   stringToTicker,
 } from '~/utils/conversion';
 import {
+  assertTickerLengthValid,
   checkTxType,
   isAllowedCharacters,
   optionize,
@@ -190,6 +191,7 @@ export async function prepareCreateNftCollection(
 
   if (ticker) {
     assertTickerOk(ticker);
+    await assertTickerLengthValid(ticker, context);
   }
 
   const internalNftType = getInternalNftType(customTypeData, nftType);

src/api/procedures/reserveTicker.ts

@@ -4,7 +4,7 @@ import { Context, PolymeshError, Procedure, TickerReservation } from '~/internal
 import { ErrorCode, ReserveTickerParams, RoleType, TickerReservationStatus, TxTags } from '~/types';
 import { ExtrinsicParams, ProcedureAuthorization, TransactionSpec } from '~/types/internal';
 import { stringToTicker, tickerToString } from '~/utils/conversion';
-import { filterEventRecords, isAllowedCharacters } from '~/utils/internal';
+import { assertTickerLengthValid, filterEventRecords, isAllowedCharacters } from '~/utils/internal';
 
 /**
  * @hidden
@@ -43,6 +43,8 @@ export async function prepareReserveTicker(
     });
   }
 
+  await assertTickerLengthValid(ticker, context);
+
   const rawTicker = stringToTicker(ticker, context);
 
   const reservation = new TickerReservation({ ticker }, context);

src/utils/__tests__/internal.ts

@@ -98,6 +98,7 @@ import {
   assertMetaLength,
   assertNoPendingAuthorizationExists,
   assertStatIsSet,
+  assertTickerLengthValid,
   assertTickerValid,
   calculateNextKey,
   calculateRawStakingPayee,
@@ -1792,6 +1793,52 @@ describe('assertTickerValid', () => {
   });
 });
 
+describe('assertTickerLengthValid', () => {
+  it('should throw an error if the ticker length exceeds the chain configured max ticker length', async () => {
+    const context = dsMockUtils.getContextInstance();
+    const maxTickerLength = new BigNumber(6);
+
+    dsMockUtils.createQueryMock('asset', 'tickerConfig', {
+      returnValue: dsMockUtils.createMockTickerRegistrationConfig({
+        maxTickerLength: dsMockUtils.createMockU8(maxTickerLength),
+        registrationLength: dsMockUtils.createMockOption(),
+      }),
+    });
+
+    await expect(assertTickerLengthValid('TOO_LONG', context)).rejects.toThrow(
+      `Ticker length must be between 1 and ${maxTickerLength.toString()} characters`
+    );
+  });
+
+  it('should throw an error if the ticker is empty', async () => {
+    const context = dsMockUtils.getContextInstance();
+
+    dsMockUtils.createQueryMock('asset', 'tickerConfig', {
+      returnValue: dsMockUtils.createMockTickerRegistrationConfig({
+        maxTickerLength: dsMockUtils.createMockU8(new BigNumber(12)),
+        registrationLength: dsMockUtils.createMockOption(),
+      }),
+    });
+
+    await expect(assertTickerLengthValid('', context)).rejects.toThrow(
+      'Ticker length must be between 1 and 12 characters'
+    );
+  });
+
+  it('should not throw an error if the ticker length is within the chain configured max ticker length', async () => {
+    const context = dsMockUtils.getContextInstance();
+
+    dsMockUtils.createQueryMock('asset', 'tickerConfig', {
+      returnValue: dsMockUtils.createMockTickerRegistrationConfig({
+        maxTickerLength: dsMockUtils.createMockU8(new BigNumber(12)),
+        registrationLength: dsMockUtils.createMockOption(),
+      }),
+    });
+
+    await expect(assertTickerLengthValid('FAKE_TICKER', context)).resolves.not.toThrow();
+  });
+});
+
 describe('neededStatTypeForRestrictionInput', () => {
   beforeAll(() => {
     dsMockUtils.initMocks();

src/utils/internal.ts

@@ -134,6 +134,7 @@ import {
   stringToTicker,
   tickerToString,
   transferRestrictionTypeToStatOpType,
+  u8ToBigNumber,
   u32ToBigNumber,
   u64ToBigNumber,
 } from '~/utils/conversion';
@@ -1001,6 +1002,36 @@ export function assertTickerValid(ticker: string): void {
   }
 }
 
+/**
+ * @hidden
+ *
+ * Validates a ticker's length against the chain's current ticker registration rules.
+ *
+ * @note this is distinct from {@link assertTickerValid}, which enforces the fixed 12 byte
+ *   width of the on chain `Ticker` type. `maxTickerLength` is a separate, governance
+ *   configurable ceiling (never greater than 12) used to validate new ticker registrations
+ */
+export async function assertTickerLengthValid(ticker: string, context: Context): Promise<void> {
+  const {
+    polymeshApi: {
+      query: {
+        asset: { tickerConfig },
+      },
+    },
+  } = context;
+
+  const { maxTickerLength: rawMaxTickerLength } = await tickerConfig();
+  const maxTickerLength = u8ToBigNumber(rawMaxTickerLength);
+
+  if (!ticker.length || maxTickerLength.lt(ticker.length)) {
+    throw new PolymeshError({
+      code: ErrorCode.ValidationError,
+      message: `Ticker length must be between 1 and ${maxTickerLength.toString()} characters`,
+      data: { maxTickerLength },
+    });
+  }
+}
+
 /**
  * @hidden
  */