Merge pull request #767 from input-output-hk/feat/cip-67-utils

feat: cip 67 utils

packages/core/src/Asset/cip67.ts

@@ -0,0 +1,78 @@
+import { Cardano } from '..';
+import { InvalidArgumentError, OpaqueNumber } from '@cardano-sdk/util';
+import crc8 from './crc8';
+
+const ASSET_LABEL_LENGTH = 8;
+const ASSET_LABEL_BRACKET = '0';
+
+export enum AssetNameLabelNum {
+  ReferenceNFT = 100,
+  UserNFT = 222,
+  UserFT = 333,
+  UserRFT = 444
+}
+
+export type AssetNameLabel = OpaqueNumber<'AssetNameLabelNum'>;
+export const AssetNameLabel = (value: number): AssetNameLabel => value as AssetNameLabel;
+
+interface DecodedAssetName {
+  label: AssetNameLabel;
+  content: Cardano.AssetName;
+}
+
+const assertLabelNumInterval = (labelNum: number) => {
+  if (labelNum < 0 || labelNum > 65_535) {
+    throw new InvalidArgumentError('Label num', `Label ${labelNum} out of range 0 - 65535.`);
+  }
+};
+
+const checksum = (labelNumHex: string) =>
+  crc8(Uint8Array.from(Buffer.from(labelNumHex, 'hex')))
+    .toString(16)
+    .padStart(2, '0');
+
+const isInvalidChecksum = (labelNumHex: string, labelChecksum: string) => labelChecksum !== checksum(labelNumHex);
+
+const isInvalidLength = (label: string) => label.length !== ASSET_LABEL_LENGTH;
+
+const isInvalidBracket = (lead: string, end: string) => lead !== ASSET_LABEL_BRACKET || end !== ASSET_LABEL_BRACKET;
+
+const assetNameLabelHexToNum = (label: string): AssetNameLabel | null => {
+  const labelLeadBracket = label[0];
+  const labelEndBracket = label[7];
+  const labelNumHex = label.slice(1, 5);
+  const labelChecksum = label.slice(5, 7);
+
+  if (
+    isInvalidLength(label) ||
+    isInvalidBracket(labelLeadBracket, labelEndBracket) ||
+    isInvalidChecksum(labelNumHex, labelChecksum)
+  ) {
+    return null;
+  }
+
+  return AssetNameLabel(Number.parseInt(labelNumHex, 16));
+};
+
+AssetNameLabel.decode = (assetName: Cardano.AssetName): DecodedAssetName | null => {
+  const assetNameLabel = assetName.slice(0, ASSET_LABEL_LENGTH);
+  const assetNameContent = assetName.slice(ASSET_LABEL_LENGTH);
+  const assetNameLabelNum = assetNameLabelHexToNum(assetNameLabel);
+
+  if (assetNameLabelNum === null) {
+    return null;
+  }
+
+  return {
+    content: Cardano.AssetName(assetNameContent),
+    label: assetNameLabelNum
+  };
+};
+
+AssetNameLabel.encode = (assetName: Cardano.AssetName, labelNum: AssetNameLabelNum): Cardano.AssetName => {
+  assertLabelNumInterval(labelNum);
+  const labelNumHex = labelNum.toString(16).padStart(4, ASSET_LABEL_BRACKET);
+  return Cardano.AssetName(
+    `${ASSET_LABEL_BRACKET}${labelNumHex}${checksum(labelNumHex)}${ASSET_LABEL_BRACKET}${assetName}`
+  );
+};

packages/core/src/Asset/crc8.ts

@@ -0,0 +1,34 @@
+/* eslint-disable no-bitwise */
+/* eslint-disable unicorn/number-literal-case */
+let TABLE: Array<number> | Int32Array = [
+  0x00, 0x07, 0x0e, 0x09, 0x1c, 0x1b, 0x12, 0x15, 0x38, 0x3f, 0x36, 0x31, 0x24, 0x23, 0x2a, 0x2d, 0x70, 0x77, 0x7e,
+  0x79, 0x6c, 0x6b, 0x62, 0x65, 0x48, 0x4f, 0x46, 0x41, 0x54, 0x53, 0x5a, 0x5d, 0xe0, 0xe7, 0xee, 0xe9, 0xfc, 0xfb,
+  0xf2, 0xf5, 0xd8, 0xdf, 0xd6, 0xd1, 0xc4, 0xc3, 0xca, 0xcd, 0x90, 0x97, 0x9e, 0x99, 0x8c, 0x8b, 0x82, 0x85, 0xa8,
+  0xaf, 0xa6, 0xa1, 0xb4, 0xb3, 0xba, 0xbd, 0xc7, 0xc0, 0xc9, 0xce, 0xdb, 0xdc, 0xd5, 0xd2, 0xff, 0xf8, 0xf1, 0xf6,
+  0xe3, 0xe4, 0xed, 0xea, 0xb7, 0xb0, 0xb9, 0xbe, 0xab, 0xac, 0xa5, 0xa2, 0x8f, 0x88, 0x81, 0x86, 0x93, 0x94, 0x9d,
+  0x9a, 0x27, 0x20, 0x29, 0x2e, 0x3b, 0x3c, 0x35, 0x32, 0x1f, 0x18, 0x11, 0x16, 0x03, 0x04, 0x0d, 0x0a, 0x57, 0x50,
+  0x59, 0x5e, 0x4b, 0x4c, 0x45, 0x42, 0x6f, 0x68, 0x61, 0x66, 0x73, 0x74, 0x7d, 0x7a, 0x89, 0x8e, 0x87, 0x80, 0x95,
+  0x92, 0x9b, 0x9c, 0xb1, 0xb6, 0xbf, 0xb8, 0xad, 0xaa, 0xa3, 0xa4, 0xf9, 0xfe, 0xf7, 0xf0, 0xe5, 0xe2, 0xeb, 0xec,
+  0xc1, 0xc6, 0xcf, 0xc8, 0xdd, 0xda, 0xd3, 0xd4, 0x69, 0x6e, 0x67, 0x60, 0x75, 0x72, 0x7b, 0x7c, 0x51, 0x56, 0x5f,
+  0x58, 0x4d, 0x4a, 0x43, 0x44, 0x19, 0x1e, 0x17, 0x10, 0x05, 0x02, 0x0b, 0x0c, 0x21, 0x26, 0x2f, 0x28, 0x3d, 0x3a,
+  0x33, 0x34, 0x4e, 0x49, 0x40, 0x47, 0x52, 0x55, 0x5c, 0x5b, 0x76, 0x71, 0x78, 0x7f, 0x6a, 0x6d, 0x64, 0x63, 0x3e,
+  0x39, 0x30, 0x37, 0x22, 0x25, 0x2c, 0x2b, 0x06, 0x01, 0x08, 0x0f, 0x1a, 0x1d, 0x14, 0x13, 0xae, 0xa9, 0xa0, 0xa7,
+  0xb2, 0xb5, 0xbc, 0xbb, 0x96, 0x91, 0x98, 0x9f, 0x8a, 0x8d, 0x84, 0x83, 0xde, 0xd9, 0xd0, 0xd7, 0xc2, 0xc5, 0xcc,
+  0xcb, 0xe6, 0xe1, 0xe8, 0xef, 0xfa, 0xfd, 0xf4, 0xf3
+];
+
+if (typeof Int32Array !== 'undefined') {
+  TABLE = new Int32Array(TABLE);
+}
+
+const crc8 = (current: Uint8Array, previous = 0) => {
+  let crc = Math.trunc(previous);
+
+  for (const byte of current) {
+    crc = TABLE[(crc ^ byte) & 0xff] & 0xff;
+  }
+
+  return crc;
+};
+
+export default crc8;

packages/core/src/Asset/index.ts

@@ -1,2 +1,3 @@
 export * as util from './util';
 export * from './types';
+export * from './cip67';

packages/core/test/Asset/cip67.test.ts

@@ -0,0 +1,42 @@
+import { Asset } from '../../src';
+import { AssetName } from '../../src/Cardano';
+import { InvalidArgumentError } from '@cardano-sdk/util';
+
+const cases: [number, string][] = [
+  [0, '00000000'],
+  [1, '00001070'],
+  [23, '00017650'],
+  [99, '000632e0'],
+  [533, '00215410'],
+  [2000, '007d0550'],
+  [4567, '011d7690'],
+  [11_111, '02b670b0'],
+  [49_328, '0c0b0f40'],
+  [65_535, '0ffff240']
+];
+
+describe('Cardano.Asset.cip67', () => {
+  test('asset label is null for asset without label', () => {
+    const assetName = AssetName('4172b2ed');
+
+    expect(Asset.AssetNameLabel.decode(assetName)).toBe(null);
+  });
+  test.each(cases)('decode asset label %p from assetId', (assetLabelNum, assetLabel) => {
+    const assetName = AssetName(`${assetLabel}4172b2ed`);
+
+    expect(Asset.AssetNameLabel.decode(assetName)).toEqual({
+      content: AssetName('4172b2ed'),
+      label: assetLabelNum
+    });
+  });
+  test.each(cases)('encode asset label %p with assetName', (assetLabelNum, assetLabel) => {
+    const assetName = AssetName('4172b2ed');
+
+    expect(Asset.AssetNameLabel.encode(assetName, assetLabelNum)).toEqual(AssetName(`${assetLabel}${assetName}`));
+  });
+  test('encode asset label with out of range label number throws an error', () => {
+    const assetName = AssetName('4172b2ed');
+
+    expect(() => Asset.AssetNameLabel.encode(assetName, Asset.AssetNameLabel(65_536))).toThrow(InvalidArgumentError);
+  });
+});