@aztec/pxe 0.0.1-commit.b9865e97 → 0.0.1-commit.be03c316

package/dest/contract_function_simulator/oracle/oracle_registry.js

@@ -2,8 +2,8 @@
 import { Fr } from '@aztec/foundation/curves/bn254';
 import { FieldReader } from '@aztec/foundation/serialize';
 import { toACVMField } from '@aztec/simulator/client';
-import { ARRAY, AZTEC_ADDRESS, BLOCK_HASH, BLOCK_HEADER, BLOCK_NUMBER, BOOL, BOUNDED_VEC, BUFFER, BYTE, CALL_PRIVATE_RESULT, CONTRACT_CLASS_LOG_INPUT, CONTRACT_INSTANCE, DELIVERY_MODE, EPHEMERAL_ARRAY, EVENT_VALIDATION_REQUEST, FIELD, FUNCTION_SELECTOR, KEY_VALIDATION_REQUEST, LOG_RETRIEVAL_REQUEST, LOG_RETRIEVAL_RESPONSE, MEMBERSHIP_WITNESS, MESSAGE_CONTEXT, MESSAGE_LOAD_ORACLE_INPUTS, NOTE, NOTE_SELECTOR, NOTE_VALIDATION_REQUEST, NULLIFIER_MEMBERSHIP_WITNESS, OPTION, PENDING_TAGGED_LOG, POINT, PROVIDED_SECRET, PUBLIC_DATA_WITNESS, PUBLIC_KEYS_AND_PARTIAL_ADDRESS, STR, TX_EFFECT, TX_HASH, U32, UTILITY_CONTEXT, assertReadersConsumed } from './oracle_type_mappings.js';
-export { ARRAY, AZTEC_ADDRESS, BIGINT, BLOCK_NUMBER, BOOL, BOUNDED_VEC, BUFFER, BYTE, DELIVERY_MODE, EPHEMERAL_ARRAY, EVENT_VALIDATION_REQUEST, FIELD, FUNCTION_SELECTOR, LOG_RETRIEVAL_REQUEST, LOG_RETRIEVAL_RESPONSE, MEMBERSHIP_WITNESS, MESSAGE_CONTEXT, NOTE_VALIDATION_REQUEST, OPTION, PENDING_TAGGED_LOG, POINT, PROVIDED_SECRET, STR, U32 } from './oracle_type_mappings.js';
+import { ARRAY, AZTEC_ADDRESS, BLOCK_HASH, BLOCK_HEADER, BLOCK_NUMBER, BOOL, BOUNDED_VEC, CALL_PRIVATE_RESULT, CONTRACT_CLASS_LOG, CONTRACT_INSTANCE, DELIVERY_MODE, EPHEMERAL_ARRAY, EVENT_VALIDATION_REQUEST, FACT_COLLECTION, FIELD, FIXED_ARRAY, FUNCTION_SELECTOR, KEY_VALIDATION_REQUEST, LOG_RETRIEVAL_REQUEST, LOG_RETRIEVAL_RESPONSE, MEMBERSHIP_WITNESS, MESSAGE_LOAD_ORACLE_INPUTS, NOTE, NOTE_SELECTOR, NOTE_VALIDATION_REQUEST, NULLIFIER_MEMBERSHIP_WITNESS, OPTION, ORIGIN_BLOCK, PENDING_TAGGED_LOG, POINT, PROVIDED_SECRET, PUBLIC_DATA_WITNESS, PUBLIC_KEYS_AND_PARTIAL_ADDRESS, RESOLVED_TAGGING_STRATEGY, RESOLVED_TX, STR, STRUCT, TX_EFFECT, TX_HASH, U8, U32, UTILITY_CONTEXT, assertReadersConsumed, slotsOf } from './oracle_type_mappings.js';
+export { ARRAY, AZTEC_ADDRESS, BIGINT, BLOCK_NUMBER, BOOL, BOUNDED_VEC, U8, CONTRACT_CLASS_LOG, DELIVERY_MODE, RESOLVED_TAGGING_STRATEGY, EPHEMERAL_ARRAY, EVENT_VALIDATION_REQUEST, FIELD, FUNCTION_SELECTOR, LOG_RETRIEVAL_REQUEST, LOG_RETRIEVAL_RESPONSE, MEMBERSHIP_WITNESS, NOTE_VALIDATION_REQUEST, OPTION, PENDING_TAGGED_LOG, POINT, PROVIDED_SECRET, RESOLVED_TX, STR, U32, slotsOf } from './oracle_type_mappings.js';
 export const ORACLE_REGISTRY = {
     aztec_misc_assertCompatibleOracleVersion: makeEntry({
         params: [
@@ -48,6 +48,10 @@ export const ORACLE_REGISTRY = {
             {
                 name: 'pkMHash',
                 type: FIELD
+            },
+            {
+                name: 'keyIndex',
+                type: FIELD
             }
         ],
         returnType: KEY_VALIDATION_REQUEST
@@ -87,6 +91,19 @@ export const ORACLE_REGISTRY = {
         ],
         returnType: OPTION(MEMBERSHIP_WITNESS(ARCHIVE_HEIGHT))
     }),
+    aztec_utl_areBlockHashesInArchive: makeEntry({
+        params: [
+            {
+                name: 'anchorBlockHash',
+                type: BLOCK_HASH
+            },
+            {
+                name: 'blockHashes',
+                type: EPHEMERAL_ARRAY(BLOCK_HASH)
+            }
+        ],
+        returnType: EPHEMERAL_ARRAY(BOOL)
+    }),
     aztec_utl_getNullifierMembershipWitness: makeEntry({
         params: [
             {
@@ -162,19 +179,24 @@ export const ORACLE_REGISTRY = {
         ],
         returnType: BOOL
     }),
-    aztec_utl_getL1ToL2MembershipWitness: makeEntry({
+    aztec_utl_getL1ToL2MembershipWitnessV2: makeEntry({
         params: [
-            {
-                name: 'contractAddress',
-                type: AZTEC_ADDRESS
-            },
             {
                 name: 'messageHash',
                 type: FIELD
             },
             {
-                name: 'secret',
-                type: FIELD
+                name: 'nullifier',
+                type: OPTION(STRUCT([
+                    {
+                        name: 'contractAddress',
+                        type: AZTEC_ADDRESS
+                    },
+                    {
+                        name: 'nullifier',
+                        type: FIELD
+                    }
+                ]))
             }
         ],
         returnType: MESSAGE_LOAD_ORACLE_INPUTS
@@ -273,7 +295,7 @@ export const ORACLE_REGISTRY = {
         ],
         returnType: BOUNDED_VEC(NOTE)
     }),
-    aztec_utl_getPendingTaggedLogs: makeEntry({
+    aztec_utl_getPendingTaggedLogsV2: makeEntry({
         params: [
             {
                 name: 'scope',
@@ -302,7 +324,7 @@ export const ORACLE_REGISTRY = {
             }
         ]
     }),
-    aztec_utl_getLogsByTag: makeEntry({
+    aztec_utl_getLogsByTagV2: makeEntry({
         params: [
             {
                 name: 'requests',
@@ -311,14 +333,14 @@ export const ORACLE_REGISTRY = {
         ],
         returnType: EPHEMERAL_ARRAY(EPHEMERAL_ARRAY(LOG_RETRIEVAL_RESPONSE))
     }),
-    aztec_utl_getMessageContextsByTxHash: makeEntry({
+    aztec_utl_getResolvedTxs: makeEntry({
         params: [
             {
                 name: 'requests',
                 type: EPHEMERAL_ARRAY(FIELD)
             }
         ],
-        returnType: EPHEMERAL_ARRAY(OPTION(MESSAGE_CONTEXT))
+        returnType: EPHEMERAL_ARRAY(OPTION(RESOLVED_TX))
     }),
     aztec_utl_getTxEffect: makeEntry({
         params: [
@@ -329,6 +351,15 @@ export const ORACLE_REGISTRY = {
         ],
         returnType: OPTION(TX_EFFECT)
     }),
+    aztec_utl_getTxEffects: makeEntry({
+        params: [
+            {
+                name: 'txHashes',
+                type: EPHEMERAL_ARRAY(TX_HASH)
+            }
+        ],
+        returnType: EPHEMERAL_ARRAY(OPTION(TX_EFFECT))
+    }),
     aztec_utl_setCapsule: makeEntry({
         params: [
             {
@@ -414,18 +445,18 @@ export const ORACLE_REGISTRY = {
         params: [
             {
                 name: 'ciphertext',
-                type: BOUNDED_VEC(BYTE)
+                type: BOUNDED_VEC(U8)
             },
             {
                 name: 'iv',
-                type: BUFFER(8)
+                type: FIXED_ARRAY(U8, 16)
             },
             {
                 name: 'symKey',
-                type: BUFFER(8)
+                type: FIXED_ARRAY(U8, 16)
             }
         ],
-        returnType: OPTION(BOUNDED_VEC(BYTE))
+        returnType: OPTION(BOUNDED_VEC(U8))
     }),
     aztec_utl_getSharedSecrets: makeEntry({
         params: [
@@ -464,6 +495,96 @@ export const ORACLE_REGISTRY = {
             }
         ]
     }),
+    aztec_utl_recordFact: makeEntry({
+        params: [
+            {
+                name: 'contractAddress',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'scope',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'factCollectionTypeId',
+                type: FIELD
+            },
+            {
+                name: 'factCollectionId',
+                type: FIELD
+            },
+            {
+                name: 'factTypeId',
+                type: FIELD
+            },
+            {
+                name: 'payload',
+                type: EPHEMERAL_ARRAY(FIELD)
+            },
+            {
+                name: 'originBlock',
+                type: OPTION(ORIGIN_BLOCK)
+            }
+        ]
+    }),
+    aztec_utl_deleteFactCollection: makeEntry({
+        params: [
+            {
+                name: 'contractAddress',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'scope',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'factCollectionTypeId',
+                type: FIELD
+            },
+            {
+                name: 'factCollectionId',
+                type: FIELD
+            }
+        ]
+    }),
+    aztec_utl_getFactCollection: makeEntry({
+        params: [
+            {
+                name: 'contractAddress',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'scope',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'factCollectionTypeId',
+                type: FIELD
+            },
+            {
+                name: 'factCollectionId',
+                type: FIELD
+            }
+        ],
+        returnType: OPTION(FACT_COLLECTION)
+    }),
+    aztec_utl_getFactCollectionsByType: makeEntry({
+        params: [
+            {
+                name: 'contractAddress',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'scope',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'factCollectionTypeId',
+                type: FIELD
+            }
+        ],
+        returnType: EPHEMERAL_ARRAY(FACT_COLLECTION)
+    }),
     aztec_utl_callUtilityFunction: makeEntry({
         params: [
             {
@@ -561,6 +682,86 @@ export const ORACLE_REGISTRY = {
             }
         ]
     }),
+    aztec_utl_pushTransient: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            },
+            {
+                name: 'elements',
+                type: ARRAY(FIELD)
+            }
+        ],
+        returnType: U32
+    }),
+    aztec_utl_popTransient: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            }
+        ],
+        returnType: ARRAY(FIELD)
+    }),
+    aztec_utl_getTransient: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            },
+            {
+                name: 'index',
+                type: U32
+            }
+        ],
+        returnType: ARRAY(FIELD)
+    }),
+    aztec_utl_setTransient: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            },
+            {
+                name: 'index',
+                type: U32
+            },
+            {
+                name: 'elements',
+                type: ARRAY(FIELD)
+            }
+        ]
+    }),
+    aztec_utl_getTransientLen: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            }
+        ],
+        returnType: U32
+    }),
+    aztec_utl_removeTransient: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            },
+            {
+                name: 'index',
+                type: U32
+            }
+        ]
+    }),
+    aztec_utl_clearTransient: makeEntry({
+        params: [
+            {
+                name: 'slot',
+                type: FIELD
+            }
+        ]
+    }),
     aztec_prv_setHashPreimage: makeEntry({
         params: [
             {
@@ -655,7 +856,7 @@ export const ORACLE_REGISTRY = {
         params: [
             {
                 name: 'log',
-                type: CONTRACT_CLASS_LOG_INPUT
+                type: CONTRACT_CLASS_LOG
             },
             {
                 name: 'counter',
@@ -741,29 +942,52 @@ export const ORACLE_REGISTRY = {
     }),
     aztec_prv_getSenderForTags: makeEntry({
         returnType: OPTION(AZTEC_ADDRESS)
+    }),
+    aztec_prv_resolveTaggingStrategy: makeEntry({
+        params: [
+            {
+                name: 'sender',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'recipient',
+                type: AZTEC_ADDRESS
+            },
+            {
+                name: 'deliveryMode',
+                type: DELIVERY_MODE
+            }
+        ],
+        returnType: RESOLVED_TAGGING_STRATEGY
+    }),
+    aztec_prv_resolveCustomRequest: makeEntry({
+        params: [
+            {
+                name: 'kind',
+                type: FIELD
+            },
+            {
+                name: 'payload',
+                type: ARRAY(FIELD)
+            }
+        ],
+        returnType: ARRAY(FIELD)
     })
 };
-/**
- * Deserializes oracle inputs, calls the handler with typed params, and serializes the result.
- */ export async function callHandler({ oracle, inputs, handler }) {
-    const entry = ORACLE_REGISTRY[oracle];
-    const named = entry.deserializeParams(inputs);
-    const positional = named.map((p)=>p.value);
-    const result = await handler(positional);
-    return entry.serializeReturn(result);
-}
 export function makeEntry({ params, returnType } = {}) {
     return {
+        params: params ?? [],
+        returnType,
         deserializeParams (inputs) {
             const resolvedParams = params ?? [];
             // Walk the input slots left-to-right, advancing by each param's slot count.
             let offset = 0;
-            return resolvedParams.map((param)=>{
+            const named = resolvedParams.map((param)=>{
                 if (!param.type.deserialization) {
                     throw new Error(`Param '${param.name}' has no deserialization defined`);
                 }
                 // Collect the slots for this param and wrap each in a FieldReader.
-                const slotCount = param.type.deserialization.slots;
+                const slotCount = slotsOf(param.type);
                 const readers = inputs.slice(offset, offset + slotCount).map((slot)=>new FieldReader(slot.map((hex)=>Fr.fromString(hex))));
                 offset += slotCount;
                 // Delegate to the TypeMapping's deserializer, assert the param's slots are fully consumed, and tag the
@@ -775,6 +999,12 @@ export function makeEntry({ params, returnType } = {}) {
                     value
                 };
             });
+            // Every input slot must be specified by a param: oracles whose Noir decl passes an extra field must declare it
+            // (the handler can ignore it). Otherwise an under-declared shape would silently drop a field into nothing.
+            if (offset !== inputs.length) {
+                throw new Error(`Oracle received ${inputs.length} input slot(s) but the registry specifies ${offset}`);
+            }
+            return named;
         },
         serializeReturn (result) {
             if (returnType?.serialization === undefined) {