feat: read state in batches

warp-contracts · Dec 14, 2023 · 00514f1 · 00514f1
1 parent eb044fe
commit 00514f1
Show file tree

Hide file tree

Showing 16 changed files with 296 additions and 63 deletions.
diff --git a/src/__tests__/unit/evaluation-options.test.ts b/src/__tests__/unit/evaluation-options.test.ts
@@ -27,6 +27,7 @@ describe('Evaluation options evaluator', () => {
         saveState: false
       },
       throwOnInternalWriteError: true,
+      transactionsPagesPerBatch: null,
       unsafeClient: 'throw',
       updateCacheForEachInteraction: false,
       useKVStorage: false,
@@ -65,6 +66,7 @@ describe('Evaluation options evaluator', () => {
         saveState: false
       },
       throwOnInternalWriteError: true,
+      transactionsPagesPerBatch: null,
       unsafeClient: 'throw',
       updateCacheForEachInteraction: false,
       useKVStorage: false,
@@ -98,6 +100,7 @@ describe('Evaluation options evaluator', () => {
         saveState: false
       },
       throwOnInternalWriteError: true,
+      transactionsPagesPerBatch: null,
       unsafeClient: 'allow',
       updateCacheForEachInteraction: false,
       useKVStorage: false,
@@ -128,6 +131,7 @@ describe('Evaluation options evaluator', () => {
         saveState: false
       },
       throwOnInternalWriteError: true,
+      transactionsPagesPerBatch: null,
       unsafeClient: 'allow',
       updateCacheForEachInteraction: false,
       useKVStorage: false,
@@ -158,6 +162,7 @@ describe('Evaluation options evaluator', () => {
         saveState: false
       },
       throwOnInternalWriteError: true,
+      transactionsPagesPerBatch: null,
       unsafeClient: 'throw',
       updateCacheForEachInteraction: false,
       useKVStorage: false,
@@ -188,6 +193,7 @@ describe('Evaluation options evaluator', () => {
         saveState: false
       },
       throwOnInternalWriteError: true,
+      transactionsPagesPerBatch: null,
       unsafeClient: 'skip',
       updateCacheForEachInteraction: false,
       useKVStorage: false,

diff --git a/src/contract/Contract.ts b/src/contract/Contract.ts
@@ -112,11 +112,22 @@ export interface Contract<State = unknown> {
    */
   readState(
     sortKeyOrBlockHeight?: string | number,
-    caller?: string,
-    interactions?: GQLNodeInterface[]
+    interactions?: GQLNodeInterface[],
+    signal?: AbortSignal
   ): Promise<SortKeyCacheResult<EvalStateResult<State>>>;
 
-  readStateFor(sortKey: string, interactions: GQLNodeInterface[]): Promise<SortKeyCacheResult<EvalStateResult<State>>>;
+  /**
+   * Reads state in batches - i.e. it first loads max. 5k interactions, evaluates them, then reads another 5k..and so on.
+   *
+   * Consider this as an experimental feature
+   */
+  readStateBatch(pagesPerBatch: number, signal: AbortSignal): Promise<SortKeyCacheResult<EvalStateResult<State>>>;
+
+  readStateFor(
+    sortKey: string,
+    interactions: GQLNodeInterface[],
+    signal?: AbortSignal
+  ): Promise<SortKeyCacheResult<EvalStateResult<State>>>;
 
   /**
    * Returns the "view" of the state, computed by the SWC -
@@ -138,7 +149,8 @@ export interface Contract<State = unknown> {
     input: Input,
     tags?: Tags,
     transfer?: ArTransfer,
-    caller?: string
+    caller?: string,
+    signal?: AbortSignal
   ): Promise<InteractionResult<State, View>>;
 
   /**
@@ -155,7 +167,8 @@ export interface Contract<State = unknown> {
    */
   viewStateForTx<Input = unknown, View = unknown>(
     input: Input,
-    transaction: GQLNodeInterface
+    transaction: GQLNodeInterface,
+    signal?: AbortSignal
   ): Promise<InteractionResult<State, View>>;
 
   /**
@@ -177,7 +190,11 @@ export interface Contract<State = unknown> {
     vrf?: boolean
   ): Promise<InteractionResult<State, unknown>>;
 
-  applyInput<Input>(input: Input, transaction: GQLNodeInterface): Promise<InteractionResult<State, unknown>>;
+  applyInput<Input>(
+    input: Input,
+    transaction: GQLNodeInterface,
+    signal?: AbortSignal
+  ): Promise<InteractionResult<State, unknown>>;
 
   /**
    * Writes a new "interaction" transaction - i.e. such transaction that stores input for the contract.
@@ -189,7 +206,7 @@ export interface Contract<State = unknown> {
 
   /**
    * Returns the full call tree report the last
-   * interaction with contract (eg. after reading state)
+   * interaction with contract (e.g. after reading state)
    */
   getCallStack(): ContractCallRecord;
 

diff --git a/src/contract/EvaluationOptionsEvaluator.ts b/src/contract/EvaluationOptionsEvaluator.ts
@@ -107,13 +107,15 @@ export class EvaluationOptionsEvaluator {
     remoteStateSyncSource: () => this.rootOptions['remoteStateSyncSource'],
     useKVStorage: (foreignOptions) => foreignOptions['useKVStorage'],
     useConstructor: (foreignOptions) => foreignOptions['useConstructor'],
-    whitelistSources: () => this.rootOptions['whitelistSources']
+    whitelistSources: () => this.rootOptions['whitelistSources'],
+    transactionsPagesPerBatch: () => this.rootOptions['transactionsPagesPerBatch']
   };
 
   private readonly notConflictingEvaluationOptions: (keyof EvaluationOptions)[] = [
     'useKVStorage',
     'sourceType',
-    'useConstructor'
+    'useConstructor',
+    'transactionsPagesPerBatch'
   ];
 
   /**