fix: implement includeAllTxLogs in Streams models

.changeset/seven-dolls-dream.md

@@ -0,0 +1,6 @@
+---
+'@moralisweb3/common-streams-utils': patch
+'@moralisweb3/streams': patch
+---
+
+Add `includeAllTxLogs` in all relevant Streams models

packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.mock.ts

@@ -9,6 +9,7 @@ const simple: EvmStreamInput = {
   includeNativeTxs: false,
   includeContractLogs: false,
   includeInternalTxs: false,
+  includeAllTxLogs: false,
   abi: null,
   chainIds: ['0x3', '0x4'],
   status: 'active',
@@ -34,6 +35,7 @@ const advancedOptions: EvmStreamInput = {
   includeNativeTxs: false,
   includeContractLogs: false,
   includeInternalTxs: false,
+  includeAllTxLogs: false,
   abi: [
     {
       anonymous: false,
@@ -70,6 +72,7 @@ const getNativeBalances: EvmStreamInput = {
   includeNativeTxs: false,
   includeContractLogs: false,
   includeInternalTxs: false,
+  includeAllTxLogs: false,
   abi: null,
   chainIds: ['0x3', '0x4'],
   status: 'active',

packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.test.ts

@@ -37,6 +37,7 @@ describe('EvmStream', () => {
       expect(stream.includeNativeTxs).toBe(false);
       expect(stream.includeContractLogs).toBe(false);
       expect(stream.includeInternalTxs).toBe(false);
+      expect(stream.includeAllTxLogs).toBe(false);
       expect(stream.abi).toBeUndefined();
       expect(stream.advancedOptions).toBeUndefined();
       expect(stream.id).toBe('3fa85f64-5717-4562-b3fc-2c963f66afa6');
@@ -67,6 +68,7 @@ describe('EvmStream', () => {
         id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
         includeContractLogs: false,
         includeInternalTxs: false,
+        includeAllTxLogs: false,
         includeNativeTxs: false,
         getNativeBalances: undefined,
         status: 'active',
@@ -98,6 +100,7 @@ describe('EvmStream', () => {
         id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
         includeContractLogs: false,
         includeInternalTxs: false,
+        includeAllTxLogs: false,
         includeNativeTxs: false,
         status: 'active',
         statusMessage: 'Stream is active',

packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.ts

@@ -44,6 +44,7 @@ export class EvmStream implements MoralisDataObject {
       allAddresses: data.allAddresses ?? false,
       includeContractLogs: data.includeContractLogs ?? false,
       includeInternalTxs: data.includeInternalTxs ?? false,
+      includeAllTxLogs: data.includeAllTxLogs ?? false,
       includeNativeTxs: data.includeNativeTxs ?? false,
       advancedOptions: maybe(data.advancedOptions),
       abi: maybe(data.abi),
@@ -157,6 +158,10 @@ export class EvmStream implements MoralisDataObject {
     return this._data.includeInternalTxs;
   }
 
+  get includeAllTxLogs() {
+    return this._data.includeAllTxLogs;
+  }
+
   get abi() {
     return this._data.abi;
   }

packages/common/streamsUtils/src/dataTypes/EvmStream/types.ts

@@ -21,6 +21,7 @@ export interface EvmStreamInput {
   includeNativeTxs?: boolean;
   includeContractLogs?: boolean;
   includeInternalTxs?: boolean;
+  includeAllTxLogs?: boolean;
   abi?: EvmAbi | null;
   advancedOptions?: EvmStreamAdvancedOptions[] | null;
   chainIds: EvmChainish[];
@@ -44,6 +45,7 @@ export interface EvmStreamData {
   includeNativeTxs: boolean;
   includeContractLogs: boolean;
   includeInternalTxs: boolean;
+  includeAllTxLogs: boolean;
   abi?: EvmAbi;
   advancedOptions?: EvmStreamAdvancedOptions[];
   chains: EvmChain[];
@@ -66,6 +68,7 @@ export type EvmStreamJSON = {
   includeNativeTxs: boolean;
   includeContractLogs: boolean;
   includeInternalTxs: boolean;
+  includeAllTxLogs: boolean;
   abi?: EvmAbi;
   advancedOptions?: EvmStreamAdvancedOptions[];
   chainIds: (string | number)[];

packages/common/streamsUtils/src/operations/evmStreams/createStreamEvmOperation.test.ts

@@ -44,6 +44,7 @@ describe('createStreamEvmOperation', () => {
       includeNativeTxs: true,
       includeContractLogs: true,
       includeInternalTxs: true,
+      includeAllTxLogs: true,
       getNativeBalances: [
         {
           selectors: ['$fromAddress', '$toAddress'],
@@ -77,6 +78,7 @@ describe('createStreamEvmOperation', () => {
     expect(serializedRequest.includeNativeTxs).toBe(true);
     expect(serializedRequest.includeContractLogs).toBe(true);
     expect(serializedRequest.includeInternalTxs).toBe(true);
+    expect(serializedRequest.includeAllTxLogs).toBe(true);
     expect(serializedRequest.chainIds).toContain('0x1');
     expect(serializedRequest.abi).toBe(null);
     expect(serializedRequest.advancedOptions).toBe(null);
@@ -98,6 +100,7 @@ describe('createStreamEvmOperation', () => {
     expect(deserializedRequest.includeNativeTxs).toBe(true);
     expect(deserializedRequest.includeContractLogs).toBe(true);
     expect(deserializedRequest.includeInternalTxs).toBe(true);
+    expect(deserializedRequest.includeAllTxLogs).toBe(true);
     expect((deserializedRequest.chains[0] as EvmChain).apiHex).toContain('0x1');
     expect(deserializedRequest.abi).toBe(null);
     expect(deserializedRequest.advancedOptions).toBe(null);

packages/common/streamsUtils/src/operations/evmStreams/createStreamEvmOperation.ts

@@ -46,6 +46,7 @@ export const createStreamEvmOperation: Operation<
     'includeNativeTxs',
     'includeContractLogs',
     'includeInternalTxs',
+    'includeAllTxLogs',
     'getNativeBalances',
     'chains',
     'abi',
@@ -78,6 +79,7 @@ function getRequestBody(request: CreateStreamEvmRequest, core: Core) {
     includeNativeTxs: request.includeNativeTxs,
     includeContractLogs: request.includeContractLogs,
     includeInternalTxs: request.includeInternalTxs,
+    includeAllTxLogs: request.includeAllTxLogs,
     getNativeBalances: request.getNativeBalances,
     chainIds: request.chains.map((chain) => EvmChain.create(chain, core).apiHex),
     abi: request.abi,
@@ -101,6 +103,7 @@ function serializeRequest(request: CreateStreamEvmRequest, core: Core) {
     includeNativeTxs: request.includeNativeTxs,
     includeContractLogs: request.includeContractLogs,
     includeInternalTxs: request.includeInternalTxs,
+    includeAllTxLogs: request.includeAllTxLogs,
     chainIds: request.chains.map((chain) => EvmChain.create(chain, core).apiHex),
     abi: request.abi,
     advancedOptions: request.advancedOptions,
@@ -119,6 +122,7 @@ function deserializeRequest(jsonRequest: CreateStreamEvmJSONRequest, core: Core)
     includeNativeTxs: jsonRequest.includeNativeTxs,
     includeContractLogs: jsonRequest.includeContractLogs,
     includeInternalTxs: jsonRequest.includeInternalTxs,
+    includeAllTxLogs: jsonRequest.includeAllTxLogs,
     chains: jsonRequest.chainIds.map((chainId) => EvmChain.create(chainId, core)),
     abi: jsonRequest.abi,
     advancedOptions: jsonRequest.advancedOptions,

packages/common/streamsUtils/src/operations/evmStreams/updateStreamEvmOperation.test.ts

@@ -45,6 +45,7 @@ describe('updateStreamEvmOperation', () => {
       includeNativeTxs: true,
       includeContractLogs: true,
       includeInternalTxs: true,
+      includeAllTxLogs: true,
       getNativeBalances: [
         {
           selectors: ['$fromAddress', '$toAddress'],
@@ -79,6 +80,7 @@ describe('updateStreamEvmOperation', () => {
     expect(serializedRequest.includeNativeTxs).toBe(true);
     expect(serializedRequest.includeContractLogs).toBe(true);
     expect(serializedRequest.includeInternalTxs).toBe(true);
+    expect(serializedRequest.includeAllTxLogs).toBe(true);
     expect(serializedRequest.chainIds).toContain('0x1');
     expect(serializedRequest.abi).toBe(null);
     expect(serializedRequest.advancedOptions).toBe(null);

packages/common/streamsUtils/src/operations/evmStreams/updateStreamEvmOperation.ts

@@ -48,6 +48,7 @@ export const updateStreamEvmOperation: Operation<
     'includeNativeTxs',
     'includeContractLogs',
     'includeInternalTxs',
+    'includeAllTxLogs',
     'getNativeBalances',
     'chains',
     'abi',
@@ -82,6 +83,7 @@ function getRequestBody(request: UpdateStreamEvmRequest, core: Core) {
     includeNativeTxs: request.includeNativeTxs,
     includeContractLogs: request.includeContractLogs,
     includeInternalTxs: request.includeInternalTxs,
+    includeAllTxLogs: request.includeAllTxLogs,
     getNativeBalances: request.getNativeBalances,
     chainIds: request.chains?.map((chain) => EvmChain.create(chain, core).apiHex),
     abi: request.abi,
@@ -106,6 +108,7 @@ function serializeRequest(request: UpdateStreamEvmRequest, core: Core) {
     includeNativeTxs: request.includeNativeTxs,
     includeContractLogs: request.includeContractLogs,
     includeInternalTxs: request.includeInternalTxs,
+    includeAllTxLogs: request.includeAllTxLogs,
     chainIds: request.chains?.map((chain) => EvmChain.create(chain, core).apiHex),
     abi: request.abi,
     advancedOptions: request.advancedOptions,
@@ -125,6 +128,7 @@ function deserializeRequest(jsonRequest: UpdateStreamEvmJSONRequest, core: Core)
     includeNativeTxs: jsonRequest.includeNativeTxs,
     includeContractLogs: jsonRequest.includeContractLogs,
     includeInternalTxs: jsonRequest.includeInternalTxs,
+    includeAllTxLogs: jsonRequest.includeAllTxLogs,
     chains: jsonRequest.chainIds?.map((chainId) => EvmChain.create(chainId, core)),
     abi: jsonRequest.abi,
     advancedOptions: jsonRequest.advancedOptions,

packages/common/streamsUtils/src/operations/openapi.ts

@@ -438,6 +438,8 @@ export interface components {
       includeContractLogs?: boolean;
       /** @description Include or not include internal transactions defaults to false */
       includeInternalTxs?: boolean;
+      /** @description Include all logs if atleast one value in tx or log matches stream config */
+      includeAllTxLogs?: boolean;
       /** @description Include native balances for each address in the webhook */
       getNativeBalances?: components["schemas"]["getNativeBalances"][];
       abi?: components["schemas"]["AbiItem"][] | null;
@@ -483,6 +485,8 @@ export interface components {
       includeContractLogs?: boolean;
       /** @description Include or not include internal transactions defaults to false */
       includeInternalTxs?: boolean;
+      /** @description Include all logs if atleast one value in tx or log matches stream config */
+      includeAllTxLogs?: boolean;
       /** @description Include native balances for each address in the webhook */
       getNativeBalances?: components["schemas"]["getNativeBalances"][];
       abi?: components["schemas"]["AbiItem"][] | null;
@@ -517,6 +521,8 @@ export interface components {
       includeContractLogs?: boolean;
       /** @description Include or not include internal transactions defaults to false */
       includeInternalTxs?: boolean;
+      /** @description Include all logs if atleast one value in tx or log matches stream config */
+      includeAllTxLogs?: boolean;
       /** @description Include native balances for each address in the webhook */
       getNativeBalances?: components["schemas"]["getNativeBalances"][];
       abi?: components["schemas"]["AbiItem"][] | null;
@@ -546,6 +552,8 @@ export interface components {
       includeContractLogs?: boolean;
       /** @description Include or not include internal transactions defaults to false */
       includeInternalTxs?: boolean;
+      /** @description Include all logs if atleast one value in tx or log matches stream config */
+      includeAllTxLogs?: boolean;
       /** @description Include native balances for each address in the webhook */
       getNativeBalances?: components["schemas"]["getNativeBalances"][];
       abi?: components["schemas"]["AbiItem"][] | null;

packages/streams/integration/mocks/endpoints/evm/createStream.ts

@@ -20,6 +20,7 @@ export const mockCreateStreamEvm = MockScenarios.create(
         allAddresses: reqBody?.allAddresses,
         includeContractLogs: reqBody?.includeContractLogs,
         includeInternalTxs: reqBody?.includeInternalTxs,
+        includeAllTxLogs: reqBody?.includeAllTxLogs,
         getNativeBalances: reqBody?.getNativeBalances,
       };
     },
@@ -70,6 +71,7 @@ export const mockCreateStreamEvm = MockScenarios.create(
         allAddresses: true,
         includeContractLogs: true,
         includeInternalTxs: true,
+        includeAllTxLogs: false,
         includeNativeTxs: true,
       },
       response: createEvmStreamResponse('test-3'),

packages/streams/integration/mocks/endpoints/evm/updateStream.ts

@@ -22,6 +22,7 @@ export const mockUpdateStreamEvm = MockScenarios.create(
         allAddresses: reqBody?.allAddresses,
         includeContractLogs: reqBody?.includeContractLogs,
         includeInternalTxs: reqBody?.includeInternalTxs,
+        includeAllTxLogs: reqBody?.includeAllTxLogs
       };
     },
   },
@@ -65,6 +66,7 @@ export const mockUpdateStreamEvm = MockScenarios.create(
         allAddresses: true,
         includeContractLogs: true,
         includeInternalTxs: true,
+        includeAllTxLogs: false,
         includeNativeTxs: true,
       },
       response: createEvmStreamResponse('test-2'),

packages/streams/integration/mocks/response/evmStreamResponse.ts

@@ -7,6 +7,7 @@ const defaultMockStream = {
   includeNativeTxs: false,
   includeContractLogs: false,
   includeInternalTxs: false,
+  includeAllTxLogs: false,
   abi: null,
   chainIds: ['0x3', '0x4'],
   status: 'active',

packages/streams/integration/test/createStream.test.ts

@@ -161,6 +161,7 @@ describe('Create stream', () => {
         allAddresses: true,
         includeContractLogs: true,
         includeInternalTxs: true,
+        includeAllTxLogs: false,
         includeNativeTxs: true,
       })) as CreateStreamEvmResponseAdapter;
 

packages/streams/integration/test/getStreams.test.ts

@@ -80,6 +80,7 @@ describe('Get streams', () => {
       expect(item.includeNativeTxs).toBe(false);
       expect(item.includeContractLogs).toBe(false);
       expect(item.includeInternalTxs).toBe(false);
+      expect(item.includeAllTxLogs).toBe(false);
       expect(item.abi).toBeUndefined();
       expect(item.advancedOptions).toBeUndefined();
       expect(item.id).toBe('3fa85f64-5717-4562-b3fc-2c963f66afa6');

packages/streams/integration/test/updateStream.test.ts

@@ -177,6 +177,7 @@ describe('Update stream', () => {
         allAddresses: true,
         includeContractLogs: true,
         includeInternalTxs: true,
+        includeAllTxLogs:false,
         includeNativeTxs: true,
       })) as UpdateStreamEvmResponseAdapter;