move batch functionality to main

Author: erhant

src/base/sdk.ts

@@ -5,9 +5,11 @@ import type {
   ContractMode,
   ContractState,
   GetInput,
+  GetManyInput,
   GetKVMapInput,
   GetKeysInput,
   PutInput,
+  PutManyInput,
   RemoveInput,
   UpdateInput,
 } from '../contracts/types';
@@ -54,18 +56,6 @@ export class SDK<V = unknown, M extends ContractMode = ContractMode> {
     return await this.base.readState().then(s => s.cachedValue.state);
   }
 
-  /**
-   * Gets the values at the given keys as an array.
-   *
-   * If a value does not exist, it is returned as `null`.
-   *
-   * @param keys an array of keys
-   * @returns an array of corresponding values
-   */
-  async getMany(keys: string[]): Promise<(V | null)[]> {
-    return await Promise.all(keys.map(key => this.get(key)));
-  }
-
   /**
    * Alternative method of getting key values. Uses the underlying `getStorageValues`
    * function, returns a Map instead of an array.
@@ -133,8 +123,30 @@ export class SDK<V = unknown, M extends ContractMode = ContractMode> {
     });
   }
 
+  /**
+   * Gets the values at the given keys as an array.
+   *
+   * If a value does not exist, it is returned as `null`.
+   *
+   * Note that the transaction limit may become a problem for too many keys.
+   *
+   * @param keys an array of keys
+   * @returns an array of corresponding values
+   */
+  async getMany(keys: string[]): Promise<(V | null)[]> {
+    return await this.base.safeReadInteraction<GetManyInput, (V | null)[]>({
+      function: 'getMany',
+      value: {
+        keys,
+      },
+    });
+  }
+
   /**
    * Inserts the given value into database.
+   *
+   * There must not be a value at the given key.
+   *
    * @param key the key of the value to be inserted
    * @param value the value to be inserted
    */
@@ -148,6 +160,24 @@ export class SDK<V = unknown, M extends ContractMode = ContractMode> {
     });
   }
 
+  /**
+   * Inserts an array of value into database.
+   *
+   * There must not be a value at the given key.
+   *
+   * @param keys the keys of the values to be inserted
+   * @param values the values to be inserted
+   */
+  async putMany(keys: string[], values: V[]): Promise<void> {
+    await this.base.dryWriteInteraction<PutManyInput<V>>({
+      function: 'putMany',
+      value: {
+        keys,
+        values,
+      },
+    });
+  }
+
   /**
    * Updates the value of given key.
    * @param key key of the value to be updated

src/contracts/build/hollowdb-htx.contract.js

@@ -11,6 +11,7 @@
   var NullValueError = new ContractError("Value cant be null, use remove instead.");
   var NotOwnerError = new ContractError("Not contract owner.");
   var InvalidFunctionError = new ContractError("Invalid function.");
+  var ArrayLengthMismatchError = new ContractError("Key and value counts mismatch.");
 
   // src/contracts/utils/index.ts
   var verifyProof = async (proof, psignals, verificationKey) => {
@@ -36,6 +37,12 @@
     }
     return input;
   };
+  var onlyNonNullValues = (_, input) => {
+    if (input.values.some((val) => val === null)) {
+      throw NullValueError;
+    }
+    return input;
+  };
   var onlyWhitelisted = (list) => {
     return (caller, input, state) => {
       if (!state.isWhitelistRequired[list]) {
@@ -70,6 +77,11 @@
         const { options } = await apply(caller, input.value, state);
         return { result: await SmartWeave.kv.kvMap(options) };
       }
+      case "getMany": {
+        const { keys } = await apply(caller, input.value, state);
+        const values = await Promise.all(keys.map((key) => SmartWeave.kv.get(key)));
+        return { result: values };
+      }
       case "put": {
         const { key, value } = await apply(caller, input.value, state, onlyNonNullValue, onlyWhitelisted("put"));
         if (await SmartWeave.kv.get(key) !== null) {
@@ -78,6 +90,17 @@
         await SmartWeave.kv.put(key, value);
         return { state };
       }
+      case "putMany": {
+        const { keys, values } = await apply(caller, input.value, state, onlyWhitelisted("put"), onlyNonNullValues);
+        if (keys.length !== values.length) {
+          throw new ContractError("Key and value counts mismatch");
+        }
+        if (await Promise.all(keys.map((key) => SmartWeave.kv.get(key))).then((values2) => values2.some((val) => val !== null))) {
+          throw KeyExistsError;
+        }
+        await Promise.all(keys.map((key, i) => SmartWeave.kv.put(key, values[i])));
+        return { state };
+      }
       case "update": {
         const { key, value } = await apply(
           caller,

src/contracts/build/hollowdb.contract.js

@@ -11,6 +11,7 @@
   var NullValueError = new ContractError("Value cant be null, use remove instead.");
   var NotOwnerError = new ContractError("Not contract owner.");
   var InvalidFunctionError = new ContractError("Invalid function.");
+  var ArrayLengthMismatchError = new ContractError("Key and value counts mismatch.");
 
   // src/contracts/utils/index.ts
   var verifyProof = async (proof, psignals, verificationKey) => {
@@ -43,6 +44,12 @@
     }
     return input;
   };
+  var onlyNonNullValues = (_, input) => {
+    if (input.values.some((val) => val === null)) {
+      throw NullValueError;
+    }
+    return input;
+  };
   var onlyWhitelisted = (list) => {
     return (caller, input, state) => {
       if (!state.isWhitelistRequired[list]) {
@@ -88,6 +95,11 @@
         const { key } = await apply(caller, input.value, state);
         return { result: await SmartWeave.kv.get(key) };
       }
+      case "getMany": {
+        const { keys } = await apply(caller, input.value, state);
+        const values = await Promise.all(keys.map((key) => SmartWeave.kv.get(key)));
+        return { result: values };
+      }
       case "getKeys": {
         const { options } = await apply(caller, input.value, state);
         return { result: await SmartWeave.kv.keys(options) };
@@ -97,13 +109,24 @@
         return { result: await SmartWeave.kv.kvMap(options) };
       }
       case "put": {
-        const { key, value } = await apply(caller, input.value, state, onlyNonNullValue, onlyWhitelisted("put"));
+        const { key, value } = await apply(caller, input.value, state, onlyWhitelisted("put"), onlyNonNullValue);
         if (await SmartWeave.kv.get(key) !== null) {
           throw KeyExistsError;
         }
         await SmartWeave.kv.put(key, value);
         return { state };
       }
+      case "putMany": {
+        const { keys, values } = await apply(caller, input.value, state, onlyWhitelisted("put"), onlyNonNullValues);
+        if (keys.length !== values.length) {
+          throw new ContractError("Key and value counts mismatch");
+        }
+        if (await Promise.all(keys.map((key) => SmartWeave.kv.get(key))).then((values2) => values2.some((val) => val !== null))) {
+          throw KeyExistsError;
+        }
+        await Promise.all(keys.map((key, i) => SmartWeave.kv.put(key, values[i])));
+        return { state };
+      }
       case "update": {
         const { key, value } = await apply(
           caller,

src/contracts/errors/index.ts

@@ -9,3 +9,4 @@ export const ExpectedProofError = new ContractError('Expected a proof.');
 export const NullValueError = new ContractError('Value cant be null, use remove instead.');
 export const NotOwnerError = new ContractError('Not contract owner.');
 export const InvalidFunctionError = new ContractError('Invalid function.');
+export const ArrayLengthMismatchError = new ContractError('Key and value counts mismatch.');