refactor: improve string type safety

packages/blockfrost/src/blockfrostWalletProvider.ts

@@ -419,7 +419,7 @@ export const blockfrostWalletProvider = (options: Options, logger = dummyLogger)
         slotLeader: Cardano.PoolId(response.slot_leader),
         totalOutput: BigInt(response.output || '0'),
         txCount: response.tx_count,
-        vrf: response.block_vrf
+        vrf: Cardano.VrfVkBech32(response.block_vrf)
       };
     });
   };

packages/blockfrost/test/blockfrostWalletProvider.test.ts

@@ -545,7 +545,7 @@ describe('blockfrostWalletProvider', () => {
         slotLeader: Cardano.PoolId('pool1zuevzm3xlrhmwjw87ec38mzs02tlkwec9wxpgafcaykmwg7efhh'),
         totalOutput: 9_249_073_880n,
         txCount: 3,
-        vrf: 'vrf_vk19j362pkr4t9y0m3qxgmrv0365vd7c4ze03ny4jh84q8agjy4ep4s99zvg8'
+        vrf: Cardano.VrfVkBech32('vrf_vk19j362pkr4t9y0m3qxgmrv0365vd7c4ze03ny4jh84q8agjy4ep4s99zvg8')
       } as Cardano.Block
     ]);
   });

packages/cardano-graphql/src/Schema/types/core/Cardano/StakePool.ts

@@ -131,7 +131,7 @@ export class StakePoolMetadata implements Cardano.StakePoolMetadata {
   @Field({ nullable: true })
   extSigUrl?: string;
   @Field(() => String, { nullable: true })
-  extVkey?: Cardano.Hash32ByteBase16;
+  extVkey?: Cardano.VrfVkBech32;
   @Field(() => ExtendedStakePoolMetadata, { nullable: true })
   @Directive('@hasInverse(field: metadata)')
   ext?: Cardano.ExtendedStakePoolMetadata;

packages/cardano-graphql/src/StakePoolSearchProvider/CardanoGraphQLStakePoolSearchProvider.ts

@@ -35,7 +35,7 @@ const toCoreStakePool = (responseStakePool: GraphqlStakePool) => {
                 }
               }
             : undefined,
-          extVkey: stakePool.metadata.extVkey ? Cardano.Hash32ByteBase16(stakePool.metadata.extVkey) : undefined
+          extVkey: stakePool.metadata.extVkey ? Cardano.VrfVkBech32(stakePool.metadata.extVkey) : undefined
         }
       : undefined,
     metadataJson: stakePool.metadataJson

packages/cardano-graphql/test/StakePoolSearchProvider/CardanoGraphQLStakePoolSearchProvider.test.ts

@@ -41,7 +41,7 @@ describe('StakePoolSearchClient', () => {
               },
               extDataUrl: 'http://extdata',
               extSigUrl: 'http://extsig',
-              extVkey: '886206542d63b23a047864021fbfccf291d78e47c1e59bd4c75fbc67b248c5e8',
+              extVkey: 'poolmd_vk19j362pkr4t9y0m3qxgmrv0365vd7c4ze03ny4jh84q8agjy4ep4stmm43m',
               homepage: 'http://homepage',
               name: 'some pool',
               ticker: 'TICKR'

packages/core/src/Cardano/types/Block.ts

@@ -1,7 +1,7 @@
 import { BlockAlonzo, BlockNo, BlockSize, Slot } from '@cardano-ogmios/schema';
 import { Cardano } from '../..';
 import { Epoch, Lovelace, PoolId } from '.';
-import { Hash32ByteBase16 } from '../util';
+import { Hash32ByteBase16, OpaqueString, typedBech32 } from '../util';
 
 /**
  * block hash as hex string
@@ -21,7 +21,13 @@ export interface Tip {
 export const BlockId = (value: string): BlockId => Hash32ByteBase16<'BlockId'>(value);
 
 export { BlockSize };
-export type VrfVkBech32 = string;
+
+/**
+ * 32 byte ed25519 verification key as bech32 string.
+ * poolmd_vk prefix might be used in extended stake pool metadata (cip6).
+ */
+export type VrfVkBech32 = OpaqueString<'VrfVkBech32'>;
+export const VrfVkBech32 = (value: string) => typedBech32<VrfVkBech32>(value, ['vrf_vk', 'poolmd_vk'], 52);
 
 type OgmiosHeader = NonNullable<BlockAlonzo['header']>;
 export type PartialBlockHeader = Pick<OgmiosHeader, 'blockHeight' | 'slot'> & {

packages/core/src/Cardano/types/StakePool/StakePool.ts

@@ -1,5 +1,5 @@
 import { ExtendedStakePoolMetadata } from './ExtendedStakePoolMetadata';
-import { Hash32ByteBase16, Lovelace, TransactionId } from '..';
+import { Lovelace, TransactionId, VrfVkBech32 } from '..';
 import { PoolIdHex } from './primitives';
 import { PoolParameters } from './PoolParameters';
 
@@ -22,12 +22,11 @@ export interface Cip6MetadataFields {
    * 128 Characters Maximum, must be a valid URL
    */
   extSigUrl?: string;
-  // TODO: this is probably wrong, as CIP says it's 68 characters long. Find and validate the correct format.
   /**
    * the public Key for verification
    * optional, 68 Characters
    */
-  extVkey?: Hash32ByteBase16;
+  extVkey?: VrfVkBech32;
 }
 
 export interface StakePoolMetadataFields {

packages/core/src/Cardano/util/primitives.ts

@@ -44,6 +44,15 @@ export const assertIsBech32WithPrefix = (
   }
 };
 
+export const typedBech32 = <T>(
+  target: string,
+  prefix: string | string[],
+  expectedDecodedLength?: number | number[]
+) => {
+  assertIsBech32WithPrefix(target, prefix, expectedDecodedLength);
+  return target as unknown as T;
+};
+
 /**
  * @param {string} target bech32 string to decode
  * @param {string} expectedLength expected string length, >0

packages/core/test/Cardano/types/Block.test.ts

@@ -1,7 +1,12 @@
-import { BlockId } from '../../../src/Cardano';
+import { BlockId, VrfVkBech32 } from '../../../src/Cardano';
 
 describe('Cardano/types/Block', () => {
   it('BlockId() accepts a valid transaction hash', () => {
     expect(() => BlockId('0dbe461fb5f981c0d01615332b8666340eb1a692b3034f46bcb5f5ea4172b2ed')).not.toThrow();
   });
+
+  it('VrfVkBech32() accepts a valid vrf verification key bech32 string with vrf_vk or poolmd_vk prefix', () => {
+    expect(() => VrfVkBech32('vrf_vk19j362pkr4t9y0m3qxgmrv0365vd7c4ze03ny4jh84q8agjy4ep4s99zvg8')).not.toThrow();
+    expect(() => VrfVkBech32('poolmd_vk19j362pkr4t9y0m3qxgmrv0365vd7c4ze03ny4jh84q8agjy4ep4stmm43m')).not.toThrow();
+  });
 });