update

src/options.ts

@@ -1,14 +1,11 @@
 // MerkleTree building options
 export type MerkleTreeOptions = Partial<{
+  // Enable or disable sorted leaves. Sorting is strongly recommended for multiproofs.
   sortLeaves: boolean;
 }>;
 
-// For backward compatibility reasons, leaves are sorted by default.
-// This can be disabled for usecases where leaves ordering needs to be preserved
+// Recommended (default) options.
+// - leaves are sorted by default to facilitate onchain verification of multiproofs.
 export const defaultOptions: Required<MerkleTreeOptions> = {
   sortLeaves: true,
 };
-
-export function withDefault(options: MerkleTreeOptions) : Required<MerkleTreeOptions> {
-  return { ...defaultOptions, ...options };
-}

src/standard.ts

@@ -1,7 +1,7 @@
 import { equalsBytes, hexToBytes } from 'ethereum-cryptography/utils';
 import { Bytes, compareBytes, hex } from './bytes';
 import { getProof, isValidMerkleTree, makeMerkleTree, processProof, renderMerkleTree, MultiProof, getMultiProof, processMultiProof } from './core';
-import { MerkleTreeOptions, withDefault } from './options';
+import { MerkleTreeOptions, defaultOptions } from './options';
 import { checkBounds } from './utils/check-bounds';
 import { throwError } from './utils/throw-error';
 import { standardLeafHash } from './utils/standard-leaf-hash';
@@ -32,7 +32,7 @@ export class StandardMerkleTree<T extends any[]> {
   }
 
   static of<T extends any[]>(values: T[], leafEncoding: string[], options: MerkleTreeOptions = {}) {
-    const { sortLeaves } = withDefault(options);
+    const sortLeaves = options.sortLeaves ?? defaultOptions.sortLeaves;
 
     const hashedValues = values.map((value, valueIndex) => ({ value, valueIndex, hash: standardLeafHash(value, leafEncoding) }));