@aztec/stdlib 0.0.1-commit.d1cd2107c → 0.0.1-commit.d1da697d6

package/dest/abi/function_signature_decoder.d.ts

@@ -0,0 +1,43 @@
+import type { ABIParameter } from './abi.js';
+/**
+ * Decodes the signature of a function from the name and parameters.
+ */
+export declare class FunctionSignatureDecoder {
+    private name;
+    private parameters;
+    private includeNames;
+    private separator;
+    constructor(name: string, parameters: ABIParameter[], includeNames?: boolean);
+    /**
+     * Decodes a single function parameter type for the function signature.
+     * @param param - The parameter type to decode.
+     * @returns A string representing the parameter type.
+     */
+    private getParameterType;
+    /**
+     * Decodes a single function parameter for the function signature.
+     * @param param - The parameter to decode.
+     * @returns A string representing the parameter type and optionally its name.
+     */
+    private decodeParameter;
+    /**
+     * Decodes all the parameters and build the function signature
+     * @returns The function signature.
+     */
+    decode(): string;
+}
+/**
+ * Decodes a function signature from the name and parameters.
+ * @param name - The name of the function.
+ * @param parameters - The parameters of the function.
+ * @returns - The function signature.
+ */
+export declare function decodeFunctionSignature(name: string, parameters: ABIParameter[]): string;
+/**
+ * Decodes a function signature from the name and parameters including parameter names.
+ * @param name - The name of the function.
+ * @param parameters - The parameters of the function.
+ * @returns - The user-friendly function signature.
+ */
+export declare function decodeFunctionSignatureWithParameterNames(name: string, parameters: ABIParameter[]): string;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZnVuY3Rpb25fc2lnbmF0dXJlX2RlY29kZXIuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hYmkvZnVuY3Rpb25fc2lnbmF0dXJlX2RlY29kZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUF3QixNQUFNLFVBQVUsQ0FBQztBQUVuRTs7R0FFRztBQUNILHFCQUFhLHdCQUF3QjtJQUdqQyxPQUFPLENBQUMsSUFBSTtJQUNaLE9BQU8sQ0FBQyxVQUFVO0lBQ2xCLE9BQU8sQ0FBQyxZQUFZO0lBSnRCLE9BQU8sQ0FBQyxTQUFTLENBQVM7SUFDMUIsWUFDVSxJQUFJLEVBQUUsTUFBTSxFQUNaLFVBQVUsRUFBRSxZQUFZLEVBQUUsRUFDMUIsWUFBWSxVQUFRLEVBRzdCO0lBRUQ7Ozs7T0FJRztJQUNILE9BQU8sQ0FBQyxnQkFBZ0I7SUFtQnhCOzs7O09BSUc7SUFDSCxPQUFPLENBQUMsZUFBZTtJQUt2Qjs7O09BR0c7SUFDSSxNQUFNLElBQUksTUFBTSxDQUV0QjtDQUNGO0FBRUQ7Ozs7O0dBS0c7QUFDSCx3QkFBZ0IsdUJBQXVCLENBQUMsSUFBSSxFQUFFLE1BQU0sRUFBRSxVQUFVLEVBQUUsWUFBWSxFQUFFLFVBRS9FO0FBRUQ7Ozs7O0dBS0c7QUFDSCx3QkFBZ0IseUNBQXlDLENBQUMsSUFBSSxFQUFFLE1BQU0sRUFBRSxVQUFVLEVBQUUsWUFBWSxFQUFFLFVBRWpHIn0=

package/dest/abi/function_signature_decoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function_signature_decoder.d.ts","sourceRoot":"","sources":["../../src/abi/function_signature_decoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAwB,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,qBAAa,wBAAwB;IAGjC,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,YAAY;IAJtB,OAAO,CAAC,SAAS,CAAS;IAC1B,YACU,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,YAAY,EAAE,EAC1B,YAAY,UAAQ,EAG7B;IAED;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAmBxB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAKvB;;;OAGG;IACI,MAAM,IAAI,MAAM,CAEtB;CACF;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,UAE/E;AAED;;;;;GAKG;AACH,wBAAgB,yCAAyC,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,UAEjG"}

package/dest/abi/function_signature_decoder.js

@@ -0,0 +1,66 @@
+/**
+ * Decodes the signature of a function from the name and parameters.
+ */ export class FunctionSignatureDecoder {
+    name;
+    parameters;
+    includeNames;
+    separator;
+    constructor(name, parameters, includeNames = false){
+        this.name = name;
+        this.parameters = parameters;
+        this.includeNames = includeNames;
+        this.separator = includeNames ? ', ' : ',';
+    }
+    /**
+   * Decodes a single function parameter type for the function signature.
+   * @param param - The parameter type to decode.
+   * @returns A string representing the parameter type.
+   */ getParameterType(param) {
+        switch(param.kind){
+            case 'field':
+                return 'Field';
+            case 'integer':
+                return param.sign === 'signed' ? `i${param.width}` : `u${param.width}`;
+            case 'boolean':
+                return 'bool';
+            case 'array':
+                return `[${this.getParameterType(param.type)};${param.length}]`;
+            case 'string':
+                return `str<${param.length}>`;
+            case 'struct':
+                return `(${param.fields.map((field)=>`${this.decodeParameter(field)}`).join(this.separator)})`;
+            default:
+                throw new Error(`Unsupported type: ${param.kind}`);
+        }
+    }
+    /**
+   * Decodes a single function parameter for the function signature.
+   * @param param - The parameter to decode.
+   * @returns A string representing the parameter type and optionally its name.
+   */ decodeParameter(param) {
+        const type = this.getParameterType(param.type);
+        return this.includeNames ? `${param.name}: ${type}` : type;
+    }
+    /**
+   * Decodes all the parameters and build the function signature
+   * @returns The function signature.
+   */ decode() {
+        return `${this.name}(${this.parameters.map((param)=>this.decodeParameter(param)).join(this.separator)})`;
+    }
+}
+/**
+ * Decodes a function signature from the name and parameters.
+ * @param name - The name of the function.
+ * @param parameters - The parameters of the function.
+ * @returns - The function signature.
+ */ export function decodeFunctionSignature(name, parameters) {
+    return new FunctionSignatureDecoder(name, parameters).decode();
+}
+/**
+ * Decodes a function signature from the name and parameters including parameter names.
+ * @param name - The name of the function.
+ * @param parameters - The parameters of the function.
+ * @returns - The user-friendly function signature.
+ */ export function decodeFunctionSignatureWithParameterNames(name, parameters) {
+    return new FunctionSignatureDecoder(name, parameters, true).decode();
+}

package/dest/abi/index.d.ts

@@ -1,6 +1,7 @@
 export * from './abi.js';
 export * from './buffer.js';
 export * from './decoder.js';
+export * from './function_signature_decoder.js';
 export * from './encoder.js';
 export * from './authorization_selector.js';
 export * from './event_metadata_definition.js';
@@ -10,4 +11,4 @@ export * from './note_selector.js';
 export * from './utils.js';
 export * from './contract_artifact.js';
 export * from './function_call.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hYmkvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLGdDQUFnQyxDQUFDO0FBQy9DLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyx3QkFBd0IsQ0FBQztBQUN2QyxjQUFjLG9CQUFvQixDQUFDO0FBQ25DLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsd0JBQXdCLENBQUM7QUFDdkMsY0FBYyxvQkFBb0IsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hYmkvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxpQ0FBaUMsQ0FBQztBQUNoRCxjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLDZCQUE2QixDQUFDO0FBQzVDLGNBQWMsZ0NBQWdDLENBQUM7QUFDL0MsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLHdCQUF3QixDQUFDO0FBQ3ZDLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxZQUFZLENBQUM7QUFDM0IsY0FBYyx3QkFBd0IsQ0FBQztBQUN2QyxjQUFjLG9CQUFvQixDQUFDIn0=

package/dest/abi/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/abi/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/abi/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,iCAAiC,CAAC;AAChD,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC"}

package/dest/abi/index.js

@@ -1,6 +1,7 @@
 export * from './abi.js';
 export * from './buffer.js';
 export * from './decoder.js';
+export * from './function_signature_decoder.js';
 export * from './encoder.js';
 export * from './authorization_selector.js';
 export * from './event_metadata_definition.js';

package/dest/abi/selector.d.ts

@@ -1,6 +1,6 @@
 import { Fr } from '@aztec/foundation/curves/bn254';
 import { inspect } from 'util';
-/** A selector is the first 4 bytes of the hash of a signature. */
+/** A selector is the low 4 bytes of the poseidon2 hash of a signature. */
 export declare abstract class Selector {
     value: number;
     /** The size of the selector in bytes. */
@@ -36,4 +36,4 @@ export declare abstract class Selector {
      */
     toField(): Fr;
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsZWN0b3IuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hYmkvc2VsZWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBR3BELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxNQUFNLENBQUM7QUFFL0Isa0VBQWtFO0FBQ2xFLDhCQUFzQixRQUFRO0lBSW9CLEtBQUssRUFBRSxNQUFNO0lBSDdELHlDQUF5QztJQUN6QyxPQUFjLElBQUksU0FBSztJQUV2QixZQUFZLDRCQUE0QixDQUFRLEtBQUssRUFBRSxNQUFNLEVBSTVEO0lBRUQ7OztPQUdHO0lBQ0ksT0FBTyxJQUFJLE9BQU8sQ0FFeEI7SUFFRDs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLFVBQVUsU0FBZ0IsR0FBRyxNQUFNLENBRTNDO0lBRUQ7OztPQUdHO0lBQ0gsUUFBUSxJQUFJLE1BQU0sQ0FFakI7SUFFRCxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsV0FFZjtJQUVEOzs7O09BSUc7SUFDSCxNQUFNLENBQUMsS0FBSyxFQUFFLFFBQVEsR0FBRyxPQUFPLENBRS9CO0lBRUQ7Ozs7T0FJRztJQUNJLE9BQU8sT0FFYjtDQUNGIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsZWN0b3IuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hYmkvc2VsZWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBR3BELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxNQUFNLENBQUM7QUFFL0IsMEVBQTBFO0FBQzFFLDhCQUFzQixRQUFRO0lBSW9CLEtBQUssRUFBRSxNQUFNO0lBSDdELHlDQUF5QztJQUN6QyxPQUFjLElBQUksU0FBSztJQUV2QixZQUFZLDRCQUE0QixDQUFRLEtBQUssRUFBRSxNQUFNLEVBSTVEO0lBRUQ7OztPQUdHO0lBQ0ksT0FBTyxJQUFJLE9BQU8sQ0FFeEI7SUFFRDs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLFVBQVUsU0FBZ0IsR0FBRyxNQUFNLENBRTNDO0lBRUQ7OztPQUdHO0lBQ0gsUUFBUSxJQUFJLE1BQU0sQ0FFakI7SUFFRCxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsV0FFZjtJQUVEOzs7O09BSUc7SUFDSCxNQUFNLENBQUMsS0FBSyxFQUFFLFFBQVEsR0FBRyxPQUFPLENBRS9CO0lBRUQ7Ozs7T0FJRztJQUNJLE9BQU8sT0FFYjtDQUNGIn0=

package/dest/abi/selector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"selector.d.ts","sourceRoot":"","sources":["../../src/abi/selector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AAGpD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,kEAAkE;AAClE,8BAAsB,QAAQ;IAIoB,KAAK,EAAE,MAAM;IAH7D,yCAAyC;IACzC,OAAc,IAAI,SAAK;IAEvB,YAAY,4BAA4B,CAAQ,KAAK,EAAE,MAAM,EAI5D;IAED;;;OAGG;IACI,OAAO,IAAI,OAAO,CAExB;IAED;;;;OAIG;IACH,QAAQ,CAAC,UAAU,SAAgB,GAAG,MAAM,CAE3C;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAEjB;IAED,CAAC,OAAO,CAAC,MAAM,CAAC,WAEf;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAE/B;IAED;;;;OAIG;IACI,OAAO,OAEb;CACF"}
+{"version":3,"file":"selector.d.ts","sourceRoot":"","sources":["../../src/abi/selector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AAGpD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,0EAA0E;AAC1E,8BAAsB,QAAQ;IAIoB,KAAK,EAAE,MAAM;IAH7D,yCAAyC;IACzC,OAAc,IAAI,SAAK;IAEvB,YAAY,4BAA4B,CAAQ,KAAK,EAAE,MAAM,EAI5D;IAED;;;OAGG;IACI,OAAO,IAAI,OAAO,CAExB;IAED;;;;OAIG;IACH,QAAQ,CAAC,UAAU,SAAgB,GAAG,MAAM,CAE3C;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAEjB;IAED,CAAC,OAAO,CAAC,MAAM,CAAC,WAEf;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAE/B;IAED;;;;OAIG;IACI,OAAO,OAEb;CACF"}

package/dest/abi/selector.js

@@ -4,7 +4,7 @@ import { Fr } from '@aztec/foundation/curves/bn254';
 import { bufferToHex } from '@aztec/foundation/string';
 import { inspect } from 'util';
 _computedKey = inspect.custom;
-/** A selector is the first 4 bytes of the hash of a signature. */ export class Selector {
+/** A selector is the low 4 bytes of the poseidon2 hash of a signature. */ export class Selector {
     value;
     /** The size of the selector in bytes. */ static SIZE = 4;
     constructor(/** Value of the selector */ value){