Merge pull request #129 from kaleido-io/pooldata

Encode the values passed in "poolData"
hyperledger · Apr 27, 2023 · a989283 · a989283
2 parents 1cb1d6c + 1ff6ab1
commit a989283
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 9 deletions.
diff --git a/src/tokens/tokens.interfaces.ts b/src/tokens/tokens.interfaces.ts
@@ -400,6 +400,9 @@ export class TokenPoolEvent extends tokenEventBase {
   @ApiProperty({ type: 'integer' })
   decimals: number;
 
+  @ApiProperty()
+  poolData?: string;
+
   @ApiProperty()
   info: TokenPoolEventInfo;
 }

diff --git a/src/tokens/tokens.listener.ts b/src/tokens/tokens.listener.ts
@@ -56,17 +56,13 @@ const approvalForAllEventSignature = 'ApprovalForAll(address,address,bool)';
 export class TokenListener implements EventListener {
   private readonly logger = new Logger(TokenListener.name);
 
-  constructor(
-    private service: TokensService,
-    private mapper: AbiMapperService,
-    private blockchain: BlockchainConnectorService,
-  ) {}
+  constructor(private mapper: AbiMapperService, private blockchain: BlockchainConnectorService) {}
 
   async onEvent(subName: string, event: Event, process: EventProcessor) {
     const signature = this.trimEventSignature(event.signature);
     switch (signature) {
       case tokenCreateEventSignature:
-        process(await this.transformTokenPoolCreationEvent(event));
+        process(await this.transformTokenPoolCreationEvent(subName, event));
         break;
       case transferEventSignature:
         process(await this.transformTransferEvent(subName, event));
@@ -124,10 +120,12 @@ export class TokenListener implements EventListener {
   }
 
   private async transformTokenPoolCreationEvent(
+    subName: string,
     event: TokenPoolCreationEvent,
   ): Promise<WebSocketMessage | undefined> {
     const ctx = newContext();
     const { data: output } = event;
+    const unpackedSub = unpackSubscriptionName(subName);
     const decodedData = decodeHex(output.data ?? '');
 
     const type = output.is_fungible ? TokenType.FUNGIBLE : TokenType.NONFUNGIBLE;
@@ -146,6 +144,7 @@ export class TokenListener implements EventListener {
       data: <TokenPoolEvent>{
         standard: type === TokenType.FUNGIBLE ? 'ERC20' : 'ERC721',
         interfaceFormat: InterfaceFormat.ABI,
+        poolData: unpackedSub.poolData,
         poolLocator: packPoolLocator(poolLocator),
         type,
         signer: event.inputSigner,

diff --git a/src/tokens/tokens.service.spec.ts b/src/tokens/tokens.service.spec.ts
@@ -306,6 +306,7 @@ describe('TokensService', () => {
       };
 
       const response: TokenPoolEvent = {
+        poolData: 'ns1',
         poolLocator: ERC20_NO_DATA_POOL_ID,
         standard: 'ERC20',
         interfaceFormat: InterfaceFormat.ABI,
@@ -530,6 +531,7 @@ describe('TokensService', () => {
       };
 
       const response: TokenPoolEvent = {
+        poolData: 'ns1',
         poolLocator: ERC20_WITH_DATA_POOL_ID,
         standard: 'ERC20',
         interfaceFormat: InterfaceFormat.ABI,
@@ -723,6 +725,7 @@ describe('TokensService', () => {
       };
 
       const response: TokenPoolEvent = {
+        poolData: 'ns1',
         poolLocator: ERC721_NO_DATA_POOL_ID,
         standard: 'ERC721',
         interfaceFormat: InterfaceFormat.ABI,
@@ -931,6 +934,7 @@ describe('TokensService', () => {
       };
 
       const response: TokenPoolEvent = {
+        poolData: 'ns1',
         poolLocator: ERC721_WITH_DATA_POOL_ID,
         standard: 'ERC721',
         interfaceFormat: InterfaceFormat.ABI,

diff --git a/src/tokens/tokens.service.ts b/src/tokens/tokens.service.ts
@@ -85,7 +85,7 @@ export class TokensService {
     this.topic = topic;
     this.factoryAddress = factoryAddress.toLowerCase();
     this.proxy.addConnectionListener(this);
-    this.proxy.addEventListener(new TokenListener(this, this.mapper, this.blockchain));
+    this.proxy.addEventListener(new TokenListener(this.mapper, this.blockchain));
   }
 
   async onConnect() {
@@ -380,6 +380,7 @@ export class TokensService {
 
     const poolInfo = await this.queryPool(ctx, poolLocator);
     const tokenPoolEvent: TokenPoolEvent = {
+      poolData: dto.poolData,
       poolLocator: dto.poolLocator,
       standard: poolLocator.type === TokenType.FUNGIBLE ? 'ERC20' : 'ERC721',
       interfaceFormat: InterfaceFormat.ABI,

diff --git a/src/tokens/tokens.util.spec.ts b/src/tokens/tokens.util.spec.ts
@@ -49,6 +49,9 @@ describe('Util', () => {
     ).toEqual(
       'fft:address=0x5bb034ca2fd1ac18e46978a7bbdbe4923e158d83&standard=ERC20WithData&type=fungible:mintWithData:ns1',
     );
+    expect(packSubscriptionName('0x123', 'create', 'ns1:test')).toEqual(
+      'fft:0x123:create:ns1%3Atest',
+    );
   });
 
   it('unpackSubscriptionName', () => {
@@ -67,6 +70,11 @@ describe('Util', () => {
       poolLocator: '0x123456',
       event: undefined,
     });
+    expect(unpackSubscriptionName('fft:0x123:create:ns1%3Atest')).toEqual({
+      poolData: 'ns1:test',
+      poolLocator: '0x123',
+      event: 'create',
+    });
   });
 
   it('packPoolLocator', () => {

diff --git a/src/tokens/tokens.util.ts b/src/tokens/tokens.util.ts
@@ -44,7 +44,7 @@ export function decodeHex(data: string) {
 
 export function packSubscriptionName(poolLocator: string, event: string, poolData?: string) {
   if (poolData !== undefined) {
-    return [SUBSCRIPTION_PREFIX, poolLocator, event, poolData].join(':');
+    return [SUBSCRIPTION_PREFIX, poolLocator, event, encodeURIComponent(poolData)].join(':');
   }
   return [SUBSCRIPTION_PREFIX, poolLocator, event].join(':');
 }
@@ -55,7 +55,7 @@ export function unpackSubscriptionName(data: string) {
     return {
       poolLocator: parts[1],
       event: parts[2],
-      poolData: parts[3],
+      poolData: decodeURIComponent(parts[3]),
     };
   } else if (parts.length === 3) {
     return {