Key changes to CropXYZ function calls and events

src/contextualizers/contextualizer.spec.ts

@@ -44,6 +44,10 @@ import ens0xdb203e93 from './test/transactions/ens-0xdb203e93.json';
 import ens0xea1b4ab6 from './test/transactions/ens-0xea1b4ab6.json';
 import ensRegistrar0xb14b4771 from './test/transactions/ensRegistrar-0xb14b4771.json';
 import ensBulkRenew0x25add712 from './test/transactions/ensBulkRenew-0x25add712.json';
+// CropXyz
+import cropXyzPlotAction0x9436b659 from './test/transactions/cropXyzPlotAction-0x9436b659.json';
+import cropXyzPlotAction0x9bb5a737 from './test/transactions/cropXyzPlotAction-0x9bb5a737.json';
+import cropXyzPlotAction0x496c6309 from './test/transactions/cropXyzPlotAction-0x496c6309.json';
 
 describe('ContextualizerService', () => {
   describe('Detect transactions correctly', () => {
@@ -234,5 +238,22 @@ describe('ContextualizerService', () => {
       );
       expect(bulkRenew.context?.summaries?.en.title).toBe('ENS');
     });
+
+    it('Should detect CropXYZ', () => {
+      const plotAction1 = contextualizer.contextualize(
+        cropXyzPlotAction0x9436b659 as unknown as Transaction,
+      );
+      expect(plotAction1.context?.summaries?.en.title).toBe('CropXYZ');
+
+      const plotAction2 = contextualizer.contextualize(
+        cropXyzPlotAction0x9bb5a737 as unknown as Transaction,
+      );
+      expect(plotAction2.context?.summaries?.en.title).toBe('CropXYZ');
+
+      const plotAction3 = contextualizer.contextualize(
+        cropXyzPlotAction0x496c6309 as unknown as Transaction,
+      );
+      expect(plotAction3.context?.summaries?.en.title).toBe('CropXYZ');
+    });
   });
 });

src/contextualizers/protocol/gold/README.md → src/contextualizers/protocol/cropXyz/README.md

@@ -4,3 +4,4 @@
 | ------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------- |
 | PackActivationSource      | [0xde1bc6e9164af5a48c45111b811c61f11ce58d91](https://www.onceupon.xyz/0xde1bc6e9164af5a48c45111b811c61f11ce58d91:8453) | Base     |
 | PackActivationDestination | [0x21170f8bd35d0afa8ad55719ce29d6489a8585db](https://www.onceupon.xyz/0x21170f8bd35d0afa8ad55719ce29d6489a8585db:4653) | Gold     |
+| PlotAction                | [0xb45805566a842efb6329c11e092158f3e0eddaa2](https://www.onceupon.xyz/0xb45805566a842efb6329c11e092158f3e0eddaa2:4653) | Gold     |

src/contextualizers/protocol/gold/abis/PackActivationDestination.ts → src/contextualizers/protocol/cropXyz/abis/PackActivationDestination.ts

@@ -1,6 +1,11 @@
 const abi = [
   {
     inputs: [
+      {
+        internalType: 'address[]',
+        name: 'addressListing',
+        type: 'address[]',
+      },
       {
         internalType: 'uint256',
         name: 'activationSourceNonce',
@@ -26,11 +31,6 @@ const abi = [
         name: 'randomListingYield',
         type: 'uint8[]',
       },
-      {
-        internalType: 'address',
-        name: 'activator',
-        type: 'address',
-      },
       {
         internalType: 'uint8',
         name: 'season',
@@ -70,6 +70,12 @@ const abi = [
   {
     anonymous: false,
     inputs: [
+      {
+        indexed: false,
+        internalType: 'address[]',
+        name: 'addressListing',
+        type: 'address[]',
+      },
       {
         indexed: false,
         internalType: 'uint256[]',
@@ -94,10 +100,16 @@ const abi = [
         name: 'admin',
         type: 'address',
       },
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'sugarcaneId',
+        type: 'bytes32',
+      },
       {
         indexed: true,
         internalType: 'address',
-        name: 'activator',
+        name: 'assetDestination',
         type: 'address',
       },
       {

src/contextualizers/protocol/gold/abis/PackActivationSource.ts → src/contextualizers/protocol/cropXyz/abis/PackActivationSource.ts

@@ -2,6 +2,12 @@ const abi = [
   {
     anonymous: false,
     inputs: [
+      {
+        indexed: false,
+        internalType: 'address[]',
+        name: 'addressListing',
+        type: 'address[]',
+      },
       {
         indexed: false,
         internalType: 'bytes32',
@@ -27,7 +33,7 @@ const abi = [
         type: 'uint256',
       },
       {
-        indexed: false,
+        indexed: true,
         internalType: 'uint256',
         name: 'sizeSpecificTokenId',
         type: 'uint256',
@@ -50,12 +56,6 @@ const abi = [
         name: 'tokenURI',
         type: 'string',
       },
-      {
-        indexed: true,
-        internalType: 'address',
-        name: 'activator',
-        type: 'address',
-      },
     ],
     name: 'ActivatedStarterPackOnSource',
     type: 'event',

src/contextualizers/protocol/cropXyz/abis/PlotAction.ts

@@ -0,0 +1,188 @@
+const abi = [
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'player',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'plotId',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'stakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'newStakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint16',
+        name: 'harvestableAmount',
+        type: 'uint16',
+      },
+      {
+        indexed: false,
+        internalType: 'uint16',
+        name: 'actuallyProducedAmount',
+        type: 'uint16',
+      },
+      {
+        indexed: false,
+        internalType: 'uint24',
+        name: 'plotHarvests',
+        type: 'uint24',
+      },
+    ],
+    name: 'HarvestedPlot',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'player',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'plotId',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'diedStakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'newStakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint16',
+        name: 'diedAmount',
+        type: 'uint16',
+      },
+      {
+        indexed: false,
+        internalType: 'uint24',
+        name: 'plotDeaths',
+        type: 'uint24',
+      },
+    ],
+    name: 'ClearedDiedHarvest',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'player',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'plotId',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'clearedStakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'newStakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint16',
+        name: 'clearedAmount',
+        type: 'uint16',
+      },
+      {
+        indexed: false,
+        internalType: 'uint24',
+        name: 'plotClears',
+        type: 'uint24',
+      },
+    ],
+    name: 'ClearedHarvest',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'player',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'plotId',
+        type: 'uint256',
+      },
+      {
+        indexed: true,
+        internalType: 'uint256',
+        name: 'stakedElement',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint16',
+        name: 'stakedAmount',
+        type: 'uint16',
+      },
+      {
+        indexed: false,
+        internalType: 'uint64',
+        name: 'timeStartStaked',
+        type: 'uint64',
+      },
+      {
+        indexed: false,
+        internalType: 'uint64',
+        name: 'timeReadyDelta',
+        type: 'uint64',
+      },
+      {
+        indexed: false,
+        internalType: 'uint64',
+        name: 'timeExpiredDelta',
+        type: 'uint64',
+      },
+    ],
+    name: 'StakedCrop',
+    type: 'event',
+  },
+] as const;
+
+export default abi;

src/contextualizers/protocol/gold/constants.ts → src/contextualizers/protocol/cropXyz/constants.ts

@@ -1,5 +1,6 @@
 import packActivationDestinationAbi from './abis/PackActivationDestination';
 import packActivationSourceAbi from './abis/PackActivationSource';
+import plotActionAbi from './abis/PlotAction';
 
 export const PACK_ACTIVATION_DESTINATION_CONTRACT =
   '0x21170f8bd35d0afa8ad55719ce29d6489a8585db';
@@ -9,6 +10,9 @@ export const PLOT_ERC721_CONTRACT =
   '0xe2f275b2a5c376fd10006b67a9be0cc3bd5488e8';
 export const Z_GOLD_CONTRACT_ADDRESS =
   '0x387d73bd8682dceb3327b940213d5de50ee2bba2';
+export const PLOT_ACTION_CONTRACT_ADDRESS =
+  '0xb45805566a842efb6329c11e092158f3e0eddaa2';
 
 export const PACK_ACTIVATION_SOURCE_ABI = packActivationSourceAbi;
 export const PACK_ACTIVATION_DESTINATION_ABI = packActivationDestinationAbi;
+export const PLOT_ACTION_ABI = plotActionAbi;

src/contextualizers/protocol/cropXyz/destination.spec.ts

@@ -0,0 +1,26 @@
+import { Transaction } from '../../../types';
+import { detect, generate } from './destination';
+import { containsBigInt, contextSummary } from '../../../helpers/utils';
+import goldDestination0x2b1c6528 from '../../test/transactions/goldDestination-0x2b1c6528.json';
+
+describe('CropXYZ Destination', () => {
+  it('Should detect transaction', () => {
+    const isCropXYZDestination1 = detect(
+      goldDestination0x2b1c6528 as unknown as Transaction,
+    );
+    expect(isCropXYZDestination1).toBe(true);
+  });
+
+  describe('Should generate context', () => {
+    it('Should generate context for one tx', () => {
+      const transaction1 = generate(
+        goldDestination0x2b1c6528 as unknown as Transaction,
+      );
+      expect(transaction1.context?.summaries?.en.title).toBe('CropXYZ');
+      expect(contextSummary(transaction1.context)).toBe(
+        '0x9a37e57d177c5ff8817b55da36f2a2b3532cde3f RECEIVED plots 0xe2f275b2a5c376fd10006b67a9be0cc3bd5488e8 #4 and 0xe2f275b2a5c376fd10006b67a9be0cc3bd5488e8 #5 and 9 0xf4a785a80d91cadc149f778ee17d35cd008203f7 and 202816 0x387d73bd8682dceb3327b940213d5de50ee2bba2',
+      );
+      expect(containsBigInt(transaction1.context)).toBe(false);
+    });
+  });
+});