Merge pull request #1997 from o1-labs/feature/merkle-list-pop-option

Add important MerkleList method

Author: Trivo25

CHANGELOG.md

@@ -20,6 +20,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Added
 - `setFee` and `setFeePerSnarkCost` for `Transaction` and `PendingTransaction` https://github.com/o1-labs/o1js/pull/1968
 - Doc comments for various ZkProgram methods https://github.com/o1-labs/o1js/pull/1974
+- `MerkleList.popOption()` for popping the last element and also learning if there was one https://github.com/o1-labs/o1js/pull/1997
 
 ### Changed
 - Sort order for actions now includes the transaction sequence number and the exact account id sequence https://github.com/o1-labs/o1js/pull/1917

src/lib/provable/merkle-list.ts

@@ -6,6 +6,7 @@ import { provableFromClass } from './types/provable-derivers.js';
 import { Poseidon, packToFields, ProvableHashable } from './crypto/poseidon.js';
 import { Unconstrained } from './types/unconstrained.js';
 import { ProvableType, WithProvable } from './types/provable-intf.js';
+import { Option } from './option.js';
 
 export {
   MerkleListBase,
@@ -166,6 +167,27 @@ class MerkleList<T> implements MerkleListBase<T> {
     return Provable.if(isEmpty, provable, provable.empty(), element);
   }
 
+  /**
+   * Remove the last element from the list and return it as an option:
+   * Some(element) if the list is non-empty, None if the list is empty.
+   *
+   * **Warning**: If the list is empty, the the option's .value is entirely unconstrained.
+   */
+  popOption(): Option<T> {
+    let { previousHash, element } = this.popWitness();
+    let isEmpty = this.isEmpty();
+    let emptyHash = this.Constructor.emptyHash;
+
+    let currentHash = this.nextHash(previousHash, element);
+    currentHash = Provable.if(isEmpty, emptyHash, currentHash);
+    this.hash.assertEquals(currentHash);
+
+    this.hash = Provable.if(isEmpty, emptyHash, previousHash);
+    let provable = this.innerProvable;
+    const OptionT = Option(provable);
+    return new OptionT({ isSome: isEmpty.not(), value: element });
+  }
+
   /**
    * Return the last element, but only remove it if `condition` is true.
    *