@aztec/aztec.js 0.7.2 → 0.7.3

package/dest/contract/checker.js

@@ -0,0 +1,98 @@
+/**
+ * Validates the given ContractAbi object by checking its functions and their parameters.
+ * Ensures that the ABI has at least one function, a constructor, valid bytecode, and correct parameter types.
+ * Throws an error if any inconsistency is detected during the validation process.
+ *
+ * @param abi - The ContractAbi object to be validated.
+ * @returns A boolean value indicating whether the ABI is valid or not.
+ */
+export function abiChecker(abi) {
+    if (!abi.functions || abi.functions.length === 0) {
+        throw new Error('ABI has no functions');
+    }
+    abi.functions.forEach(func => {
+        if (!('name' in func && typeof func.name === 'string' && func.name.length > 0)) {
+            throw new Error('ABI function has no name');
+        }
+        // TODO: implement a better check for bytecode (right now only checks if it's > 0)
+        if (!('bytecode' in func && typeof func.bytecode === 'string' && func.bytecode.length > 0)) {
+            throw new Error('ABI function parameter has incorrect bytecode');
+        }
+        func.parameters.forEach(param => {
+            if (!param.type) {
+                throw new Error('ABI function parameter has no type');
+            }
+            abiParameterTypeChecker(param.type);
+        });
+    });
+    // TODO: implement a better check for constructor (right now only checks if it has it or not)
+    if (!abi.functions.find(func => func.name === 'constructor')) {
+        throw new Error('ABI has no constructor');
+    }
+    return true;
+}
+/**
+ * Validates the ABI function parameter's type by checking its kind and attributes.
+ * Throws an error if the type has an unrecognized kind or incorrectly formed attributes.
+ * Additionally, checks nested types for array and struct kinds.
+ *
+ * @param type - The ABIType object representing the type of the ABI function parameter.
+ * @returns A boolean value indicating whether the type is valid or not.
+ */
+function abiParameterTypeChecker(type) {
+    switch (type.kind) {
+        case 'field':
+        case 'boolean':
+            return checkAttributes(type, {});
+        case 'integer':
+            return checkAttributes(type, { sign: 'string', width: 'number' });
+        case 'string':
+            return checkAttributes(type, { length: 'number' });
+        case 'array':
+            return checkAttributes(type, { length: 'number', type: 'object' }) && abiParameterTypeChecker(type.type);
+        case 'struct':
+            return checkAttributes(type, { fields: 'object' }) && checkStruct(type);
+        default:
+            throw new Error('ABI function parameter has an unrecognised type');
+    }
+}
+/**
+ * Check if the structure of the ABIType 'struct' is valid by ensuring field names are strings
+ * and their type attribute passes the abiParameterTypeChecker. Returns true on successful validation,
+ * otherwise throws an error providing insight into the incorrect formation in the struct.
+ *
+ * @param type - The StructType object containing an array of fields to validate.
+ * @returns A boolean value indicating successful validation of the struct's fields.
+ */
+function checkStruct(type) {
+    return type.fields.reduce((acc, field) => {
+        if (!('name' in field && typeof field.name === 'string')) {
+            throw new Error('ABI function parameter has an incorrectly formed struct');
+        }
+        return acc && abiParameterTypeChecker(field.type);
+    }, true);
+}
+/**
+ * Check if a provided ABI type has the correct attributes and their associated types.
+ * This function compares the given 'type' object's keys with the expected attribute types
+ * specified in 'incompleteAttributes', as well as the required 'kind' property.
+ * Throws an error if there are any unrecognised attributes or incorrect attribute types.
+ *
+ * @param type - The ABI type object to be checked for correct attributes.
+ * @param incompleteAttributes - An object representing the expected attribute types without the 'kind' property.
+ * @returns Returns true if the provided ABI type has the correct attributes and their associated types, otherwise throws an error.
+ */
+function checkAttributes(type, incompleteAttributes) {
+    const typeKeys = Object.keys(type);
+    const attributes = { ...incompleteAttributes, kind: 'string' };
+    if (typeKeys.length !== Object.keys(attributes).length) {
+        throw new Error(`Unrecognised attribute on type ${type.kind}`);
+    }
+    typeKeys.forEach(element => {
+        if (!(element in type && typeof type[element] === attributes[element])) {
+            throw new Error(`ABI function parameter has an incorrectly formed ${type.kind}`);
+        }
+    });
+    return true;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hlY2tlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdC9jaGVja2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQVFBOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLFVBQVUsVUFBVSxDQUFDLEdBQWdCO0lBQ3pDLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxJQUFJLEdBQUcsQ0FBQyxTQUFTLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRTtRQUNoRCxNQUFNLElBQUksS0FBSyxDQUFDLHNCQUFzQixDQUFDLENBQUM7S0FDekM7SUFFRCxHQUFHLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUMzQixJQUFJLENBQUMsQ0FBQyxNQUFNLElBQUksSUFBSSxJQUFJLE9BQU8sSUFBSSxDQUFDLElBQUksS0FBSyxRQUFRLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLEVBQUU7WUFDOUUsTUFBTSxJQUFJLEtBQUssQ0FBQywwQkFBMEIsQ0FBQyxDQUFDO1NBQzdDO1FBRUQsa0ZBQWtGO1FBQ2xGLElBQUksQ0FBQyxDQUFDLFVBQVUsSUFBSSxJQUFJLElBQUksT0FBTyxJQUFJLENBQUMsUUFBUSxLQUFLLFFBQVEsSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsRUFBRTtZQUMxRixNQUFNLElBQUksS0FBSyxDQUFDLCtDQUErQyxDQUFDLENBQUM7U0FDbEU7UUFFRCxJQUFJLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsRUFBRTtZQUM5QixJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksRUFBRTtnQkFDZixNQUFNLElBQUksS0FBSyxDQUFDLG9DQUFvQyxDQUFDLENBQUM7YUFDdkQ7WUFFRCx1QkFBdUIsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDdEMsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDLENBQUMsQ0FBQztJQUVILDZGQUE2RjtJQUM3RixJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxLQUFLLGFBQWEsQ0FBQyxFQUFFO1FBQzVELE1BQU0sSUFBSSxLQUFLLENBQUMsd0JBQXdCLENBQUMsQ0FBQztLQUMzQztJQUVELE9BQU8sSUFBSSxDQUFDO0FBQ2QsQ0FBQztBQUVEOzs7Ozs7O0dBT0c7QUFDSCxTQUFTLHVCQUF1QixDQUFDLElBQWE7SUFDNUMsUUFBUSxJQUFJLENBQUMsSUFBSSxFQUFFO1FBQ2pCLEtBQUssT0FBTyxDQUFDO1FBQ2IsS0FBSyxTQUFTO1lBQ1osT0FBTyxlQUFlLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ25DLEtBQUssU0FBUztZQUNaLE9BQU8sZUFBZSxDQUFDLElBQUksRUFBRSxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDcEUsS0FBSyxRQUFRO1lBQ1gsT0FBTyxlQUFlLENBQUMsSUFBSSxFQUFFLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDckQsS0FBSyxPQUFPO1lBQ1YsT0FBTyxlQUFlLENBQUMsSUFBSSxFQUFFLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsUUFBUSxFQUFFLENBQUMsSUFBSSx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDM0csS0FBSyxRQUFRO1lBQ1gsT0FBTyxlQUFlLENBQUMsSUFBSSxFQUFFLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxDQUFDLElBQUksV0FBVyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzFFO1lBQ0UsTUFBTSxJQUFJLEtBQUssQ0FBQyxpREFBaUQsQ0FBQyxDQUFDO0tBQ3RFO0FBQ0gsQ0FBQztBQUVEOzs7Ozs7O0dBT0c7QUFDSCxTQUFTLFdBQVcsQ0FBQyxJQUFnQjtJQUNuQyxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsR0FBRyxFQUFFLEtBQUssRUFBRSxFQUFFO1FBQ3ZDLElBQUksQ0FBQyxDQUFDLE1BQU0sSUFBSSxLQUFLLElBQUksT0FBTyxLQUFLLENBQUMsSUFBSSxLQUFLLFFBQVEsQ0FBQyxFQUFFO1lBQ3hELE1BQU0sSUFBSSxLQUFLLENBQUMseURBQXlELENBQUMsQ0FBQztTQUM1RTtRQUNELE9BQU8sR0FBRyxJQUFJLHVCQUF1QixDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNwRCxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7QUFDWCxDQUFDO0FBRUQ7Ozs7Ozs7OztHQVNHO0FBQ0gsU0FBUyxlQUFlLENBQThCLElBQU8sRUFBRSxvQkFBd0M7SUFDckcsTUFBTSxRQUFRLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNuQyxNQUFNLFVBQVUsR0FBRyxFQUFFLEdBQUcsb0JBQW9CLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxDQUFDO0lBRS9ELElBQUksUUFBUSxDQUFDLE1BQU0sS0FBSyxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDLE1BQU0sRUFBRTtRQUN0RCxNQUFNLElBQUksS0FBSyxDQUFDLGtDQUFrQyxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQztLQUNoRTtJQUVELFFBQVEsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDekIsSUFBSSxDQUFDLENBQUMsT0FBTyxJQUFJLElBQUksSUFBSSxPQUFRLElBQVksQ0FBQyxPQUFPLENBQUMsS0FBTSxVQUFrQixDQUFDLE9BQU8sQ0FBQyxDQUFDLEVBQUU7WUFDeEYsTUFBTSxJQUFJLEtBQUssQ0FBQyxvREFBb0QsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUM7U0FDbEY7SUFDSCxDQUFDLENBQUMsQ0FBQztJQUVILE9BQU8sSUFBSSxDQUFDO0FBQ2QsQ0FBQyJ9

package/dest/contract/checker.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=checker.test.d.ts.map

package/dest/contract/checker.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checker.test.d.ts","sourceRoot":"","sources":["../../src/contract/checker.test.ts"],"names":[],"mappings":""}

package/dest/contract/checker.test.js

@@ -0,0 +1,168 @@
+import { abiChecker } from './checker.js';
+describe('abiChecker', () => {
+    let abi;
+    it('should throw an error if it has no functions', () => {
+        abi = {
+            name: 'TEST_ABI',
+        };
+        expect(() => abiChecker(abi)).toThrowError('ABI has no functions');
+        abi = {
+            name: 'TEST_ABI',
+            functions: [],
+        };
+        expect(() => abiChecker(abi)).toThrowError('ABI has no functions');
+    });
+    it('should error if ABI has no names', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [{ bytecode: '0af', parameters: [{ type: { kind: 'test' } }] }],
+        };
+        expect(() => abiChecker(abi)).toThrowError('ABI function has no name');
+    });
+    it('should error if ABI function has unrecognised type', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'Function name',
+                    bytecode: '0af',
+                    parameters: [{ type: { kind: 'test' } }],
+                },
+            ],
+        };
+        expect(() => abiChecker(abi)).toThrowError('ABI function parameter has an unrecognised type');
+    });
+    it('should error if integer is incorrectly formed', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'constructor',
+                    bytecode: '0af',
+                    parameters: [{ type: { kind: 'integer', sign: 5 } }],
+                },
+            ],
+        };
+        expect(() => abiChecker(abi)).toThrowError('Unrecognised attribute on type integer');
+    });
+    it('should error if string is incorrectly formed', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'constructor',
+                    bytecode: '0af',
+                    parameters: [{ type: { kind: 'string', sign: 5, additionalParam: true } }],
+                },
+            ],
+        };
+        expect(() => abiChecker(abi)).toThrowError('Unrecognised attribute on type string');
+    });
+    it('should error if struct is incorrectly formed', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'constructor',
+                    bytecode: '0af',
+                    parameters: [
+                        {
+                            type: {
+                                kind: 'struct',
+                            },
+                        },
+                    ],
+                },
+            ],
+        };
+        expect(() => abiChecker(abi)).toThrowError('Unrecognised attribute on type struct');
+    });
+    it('should error if array is incorrectly formed', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'constructor',
+                    bytecode: '0af',
+                    parameters: [
+                        {
+                            type: {
+                                kind: 'array',
+                                length: 5,
+                                type: {
+                                    kind: 'array',
+                                    length: '5',
+                                    type: {
+                                        sign: 'value',
+                                        width: 5,
+                                        kind: 'integer',
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                },
+            ],
+        };
+        expect(() => abiChecker(abi)).toThrowError('ABI function parameter has an incorrectly formed array');
+    });
+    it('valid matrix should pass checker', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'constructor',
+                    bytecode: '0af',
+                    parameters: [
+                        {
+                            type: {
+                                kind: 'array',
+                                length: 5,
+                                type: {
+                                    kind: 'array',
+                                    length: 5,
+                                    type: {
+                                        sign: 'value',
+                                        width: 5,
+                                        kind: 'integer',
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                },
+            ],
+        };
+        expect(abiChecker(abi)).toBe(true);
+    });
+    it('valid struct should pass checker', () => {
+        abi = {
+            name: 'TEST_ABI',
+            functions: [
+                {
+                    name: 'constructor',
+                    bytecode: '0af',
+                    parameters: [
+                        {
+                            type: {
+                                kind: 'struct',
+                                fields: [
+                                    {
+                                        name: 'name',
+                                        type: {
+                                            sign: 'value',
+                                            width: 5,
+                                            kind: 'integer',
+                                        },
+                                    },
+                                ],
+                            },
+                        },
+                    ],
+                },
+            ],
+        };
+        expect(abiChecker(abi)).toBe(true);
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hlY2tlci50ZXN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0L2NoZWNrZXIudGVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBRTFDLFFBQVEsQ0FBQyxZQUFZLEVBQUUsR0FBRyxFQUFFO0lBQzFCLElBQUksR0FBUSxDQUFDO0lBRWIsRUFBRSxDQUFDLDhDQUE4QyxFQUFFLEdBQUcsRUFBRTtRQUN0RCxHQUFHLEdBQUc7WUFDSixJQUFJLEVBQUUsVUFBVTtTQUNqQixDQUFDO1FBQ0YsTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLFlBQVksQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO1FBQ25FLEdBQUcsR0FBRztZQUNKLElBQUksRUFBRSxVQUFVO1lBQ2hCLFNBQVMsRUFBRSxFQUFFO1NBQ2QsQ0FBQztRQUNGLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxZQUFZLENBQUMsc0JBQXNCLENBQUMsQ0FBQztJQUNyRSxDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyxrQ0FBa0MsRUFBRSxHQUFHLEVBQUU7UUFDMUMsR0FBRyxHQUFHO1lBQ0osSUFBSSxFQUFFLFVBQVU7WUFDaEIsU0FBUyxFQUFFLENBQUMsRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRSxDQUFDLEVBQUUsSUFBSSxFQUFFLEVBQUUsSUFBSSxFQUFFLE1BQU0sRUFBRSxFQUFFLENBQUMsRUFBRSxDQUFDO1NBQzNFLENBQUM7UUFDRixNQUFNLENBQUMsR0FBRyxFQUFFLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDLDBCQUEwQixDQUFDLENBQUM7SUFDekUsQ0FBQyxDQUFDLENBQUM7SUFFSCxFQUFFLENBQUMsb0RBQW9ELEVBQUUsR0FBRyxFQUFFO1FBQzVELEdBQUcsR0FBRztZQUNKLElBQUksRUFBRSxVQUFVO1lBQ2hCLFNBQVMsRUFBRTtnQkFDVDtvQkFDRSxJQUFJLEVBQUUsZUFBZTtvQkFDckIsUUFBUSxFQUFFLEtBQUs7b0JBQ2YsVUFBVSxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUUsRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLEVBQUUsQ0FBQztpQkFDekM7YUFDRjtTQUNGLENBQUM7UUFDRixNQUFNLENBQUMsR0FBRyxFQUFFLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDLGlEQUFpRCxDQUFDLENBQUM7SUFDaEcsQ0FBQyxDQUFDLENBQUM7SUFFSCxFQUFFLENBQUMsK0NBQStDLEVBQUUsR0FBRyxFQUFFO1FBQ3ZELEdBQUcsR0FBRztZQUNKLElBQUksRUFBRSxVQUFVO1lBQ2hCLFNBQVMsRUFBRTtnQkFDVDtvQkFDRSxJQUFJLEVBQUUsYUFBYTtvQkFDbkIsUUFBUSxFQUFFLEtBQUs7b0JBQ2YsVUFBVSxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUUsRUFBRSxJQUFJLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDO2lCQUNyRDthQUNGO1NBQ0YsQ0FBQztRQUNGLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxZQUFZLENBQUMsd0NBQXdDLENBQUMsQ0FBQztJQUN2RixDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyw4Q0FBOEMsRUFBRSxHQUFHLEVBQUU7UUFDdEQsR0FBRyxHQUFHO1lBQ0osSUFBSSxFQUFFLFVBQVU7WUFDaEIsU0FBUyxFQUFFO2dCQUNUO29CQUNFLElBQUksRUFBRSxhQUFhO29CQUNuQixRQUFRLEVBQUUsS0FBSztvQkFDZixVQUFVLEVBQUUsQ0FBQyxFQUFFLElBQUksRUFBRSxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLENBQUMsRUFBRSxlQUFlLEVBQUUsSUFBSSxFQUFFLEVBQUUsQ0FBQztpQkFDM0U7YUFDRjtTQUNGLENBQUM7UUFDRixNQUFNLENBQUMsR0FBRyxFQUFFLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDLHVDQUF1QyxDQUFDLENBQUM7SUFDdEYsQ0FBQyxDQUFDLENBQUM7SUFFSCxFQUFFLENBQUMsOENBQThDLEVBQUUsR0FBRyxFQUFFO1FBQ3RELEdBQUcsR0FBRztZQUNKLElBQUksRUFBRSxVQUFVO1lBQ2hCLFNBQVMsRUFBRTtnQkFDVDtvQkFDRSxJQUFJLEVBQUUsYUFBYTtvQkFDbkIsUUFBUSxFQUFFLEtBQUs7b0JBQ2YsVUFBVSxFQUFFO3dCQUNWOzRCQUNFLElBQUksRUFBRTtnQ0FDSixJQUFJLEVBQUUsUUFBUTs2QkFDZjt5QkFDRjtxQkFDRjtpQkFDRjthQUNGO1NBQ0YsQ0FBQztRQUNGLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxZQUFZLENBQUMsdUNBQXVDLENBQUMsQ0FBQztJQUN0RixDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyw2Q0FBNkMsRUFBRSxHQUFHLEVBQUU7UUFDckQsR0FBRyxHQUFHO1lBQ0osSUFBSSxFQUFFLFVBQVU7WUFDaEIsU0FBUyxFQUFFO2dCQUNUO29CQUNFLElBQUksRUFBRSxhQUFhO29CQUNuQixRQUFRLEVBQUUsS0FBSztvQkFDZixVQUFVLEVBQUU7d0JBQ1Y7NEJBQ0UsSUFBSSxFQUFFO2dDQUNKLElBQUksRUFBRSxPQUFPO2dDQUNiLE1BQU0sRUFBRSxDQUFDO2dDQUNULElBQUksRUFBRTtvQ0FDSixJQUFJLEVBQUUsT0FBTztvQ0FDYixNQUFNLEVBQUUsR0FBRztvQ0FDWCxJQUFJLEVBQUU7d0NBQ0osSUFBSSxFQUFFLE9BQU87d0NBQ2IsS0FBSyxFQUFFLENBQUM7d0NBQ1IsSUFBSSxFQUFFLFNBQVM7cUNBQ2hCO2lDQUNGOzZCQUNGO3lCQUNGO3FCQUNGO2lCQUNGO2FBQ0Y7U0FDRixDQUFDO1FBQ0YsTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLFlBQVksQ0FBQyx3REFBd0QsQ0FBQyxDQUFDO0lBQ3ZHLENBQUMsQ0FBQyxDQUFDO0lBRUgsRUFBRSxDQUFDLGtDQUFrQyxFQUFFLEdBQUcsRUFBRTtRQUMxQyxHQUFHLEdBQUc7WUFDSixJQUFJLEVBQUUsVUFBVTtZQUNoQixTQUFTLEVBQUU7Z0JBQ1Q7b0JBQ0UsSUFBSSxFQUFFLGFBQWE7b0JBQ25CLFFBQVEsRUFBRSxLQUFLO29CQUNmLFVBQVUsRUFBRTt3QkFDVjs0QkFDRSxJQUFJLEVBQUU7Z0NBQ0osSUFBSSxFQUFFLE9BQU87Z0NBQ2IsTUFBTSxFQUFFLENBQUM7Z0NBQ1QsSUFBSSxFQUFFO29DQUNKLElBQUksRUFBRSxPQUFPO29DQUNiLE1BQU0sRUFBRSxDQUFDO29DQUNULElBQUksRUFBRTt3Q0FDSixJQUFJLEVBQUUsT0FBTzt3Q0FDYixLQUFLLEVBQUUsQ0FBQzt3Q0FDUixJQUFJLEVBQUUsU0FBUztxQ0FDaEI7aUNBQ0Y7NkJBQ0Y7eUJBQ0Y7cUJBQ0Y7aUJBQ0Y7YUFDRjtTQUNGLENBQUM7UUFDRixNQUFNLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3JDLENBQUMsQ0FBQyxDQUFDO0lBRUgsRUFBRSxDQUFDLGtDQUFrQyxFQUFFLEdBQUcsRUFBRTtRQUMxQyxHQUFHLEdBQUc7WUFDSixJQUFJLEVBQUUsVUFBVTtZQUNoQixTQUFTLEVBQUU7Z0JBQ1Q7b0JBQ0UsSUFBSSxFQUFFLGFBQWE7b0JBQ25CLFFBQVEsRUFBRSxLQUFLO29CQUNmLFVBQVUsRUFBRTt3QkFDVjs0QkFDRSxJQUFJLEVBQUU7Z0NBQ0osSUFBSSxFQUFFLFFBQVE7Z0NBQ2QsTUFBTSxFQUFFO29DQUNOO3dDQUNFLElBQUksRUFBRSxNQUFNO3dDQUNaLElBQUksRUFBRTs0Q0FDSixJQUFJLEVBQUUsT0FBTzs0Q0FDYixLQUFLLEVBQUUsQ0FBQzs0Q0FDUixJQUFJLEVBQUUsU0FBUzt5Q0FDaEI7cUNBQ0Y7aUNBQ0Y7NkJBQ0Y7eUJBQ0Y7cUJBQ0Y7aUJBQ0Y7YUFDRjtTQUNGLENBQUM7UUFDRixNQUFNLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3JDLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDLENBQUMifQ==

package/dest/contract/contract.d.ts

@@ -0,0 +1,39 @@
+import { ContractAbi } from '@aztec/foundation/abi';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { PublicKey } from '@aztec/types';
+import { Wallet } from '../aztec_rpc_client/wallet.js';
+import { DeployMethod } from '../index.js';
+import { ContractBase } from './contract_base.js';
+/**
+ * The Contract class represents a contract and provides utility methods for interacting with it.
+ * It enables the creation of ContractFunctionInteraction instances for each function in the contract's ABI,
+ * allowing users to call or send transactions to these functions. Additionally, the Contract class can be used
+ * to attach the contract instance to a deployed contract on-chain through the AztecRPCClient, which facilitates
+ * interaction with Aztec's privacy protocol.
+ */
+export declare class Contract extends ContractBase {
+    /**
+     * Creates a contract instance.
+     * @param address - The deployed contract's address.
+     * @param abi - The Application Binary Interface for the contract.
+     * @param wallet - The wallet to use when interacting with the contract.
+     * @returns A promise that resolves to a new Contract instance.
+     */
+    static at(address: AztecAddress, abi: ContractAbi, wallet: Wallet): Promise<Contract>;
+    /**
+     * Creates a tx to deploy a new instance of a contract.
+     * @param wallet - The wallet for executing the deployment.
+     * @param abi - ABI of the contract to deploy.
+     * @param args - Arguments for the constructor.
+     */
+    static deploy(wallet: Wallet, abi: ContractAbi, args: any[]): DeployMethod<Contract>;
+    /**
+     * Creates a tx to deploy a new instance of a contract using the specified public key to derive the address.
+     * @param publicKey - Public key for deriving the address.
+     * @param wallet - The wallet for executing the deployment.
+     * @param abi - ABI of the contract to deploy.
+     * @param args - Arguments for the constructor.
+     */
+    static deployWithPublicKey(publicKey: PublicKey, wallet: Wallet, abi: ContractAbi, args: any[]): DeployMethod<Contract>;
+}
+//# sourceMappingURL=contract.d.ts.map

package/dest/contract/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../src/contract/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAS,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,YAAY;IACxC;;;;;;OAMG;WACiB,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQlG;;;;;OAKG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,EAAE;IAIlE;;;;;;OAMG;WACW,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,EAAE;CAGtG"}

package/dest/contract/contract.js

@@ -0,0 +1,45 @@
+import { DeployMethod, Point } from '../index.js';
+import { ContractBase } from './contract_base.js';
+/**
+ * The Contract class represents a contract and provides utility methods for interacting with it.
+ * It enables the creation of ContractFunctionInteraction instances for each function in the contract's ABI,
+ * allowing users to call or send transactions to these functions. Additionally, the Contract class can be used
+ * to attach the contract instance to a deployed contract on-chain through the AztecRPCClient, which facilitates
+ * interaction with Aztec's privacy protocol.
+ */
+export class Contract extends ContractBase {
+    /**
+     * Creates a contract instance.
+     * @param address - The deployed contract's address.
+     * @param abi - The Application Binary Interface for the contract.
+     * @param wallet - The wallet to use when interacting with the contract.
+     * @returns A promise that resolves to a new Contract instance.
+     */
+    static async at(address, abi, wallet) {
+        const extendedContractData = await wallet.getExtendedContractData(address);
+        if (extendedContractData === undefined) {
+            throw new Error('Contract ' + address.toString() + ' is not deployed');
+        }
+        return new Contract(extendedContractData.getCompleteAddress(), abi, wallet);
+    }
+    /**
+     * Creates a tx to deploy a new instance of a contract.
+     * @param wallet - The wallet for executing the deployment.
+     * @param abi - ABI of the contract to deploy.
+     * @param args - Arguments for the constructor.
+     */
+    static deploy(wallet, abi, args) {
+        return new DeployMethod(Point.ZERO, wallet, abi, args);
+    }
+    /**
+     * Creates a tx to deploy a new instance of a contract using the specified public key to derive the address.
+     * @param publicKey - Public key for deriving the address.
+     * @param wallet - The wallet for executing the deployment.
+     * @param abi - ABI of the contract to deploy.
+     * @param args - Arguments for the constructor.
+     */
+    static deployWithPublicKey(publicKey, wallet, abi, args) {
+        return new DeployMethod(publicKey, wallet, abi, args);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3QvY29udHJhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBS0EsT0FBTyxFQUFFLFlBQVksRUFBRSxLQUFLLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDbEQsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRWxEOzs7Ozs7R0FNRztBQUNILE1BQU0sT0FBTyxRQUFTLFNBQVEsWUFBWTtJQUN4Qzs7Ozs7O09BTUc7SUFDSSxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxPQUFxQixFQUFFLEdBQWdCLEVBQUUsTUFBYztRQUM1RSxNQUFNLG9CQUFvQixHQUFHLE1BQU0sTUFBTSxDQUFDLHVCQUF1QixDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzNFLElBQUksb0JBQW9CLEtBQUssU0FBUyxFQUFFO1lBQ3RDLE1BQU0sSUFBSSxLQUFLLENBQUMsV0FBVyxHQUFHLE9BQU8sQ0FBQyxRQUFRLEVBQUUsR0FBRyxrQkFBa0IsQ0FBQyxDQUFDO1NBQ3hFO1FBQ0QsT0FBTyxJQUFJLFFBQVEsQ0FBQyxvQkFBb0IsQ0FBQyxrQkFBa0IsRUFBRSxFQUFFLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQztJQUM5RSxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSSxNQUFNLENBQUMsTUFBTSxDQUFDLE1BQWMsRUFBRSxHQUFnQixFQUFFLElBQVc7UUFDaEUsT0FBTyxJQUFJLFlBQVksQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLE1BQU0sRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDekQsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNJLE1BQU0sQ0FBQyxtQkFBbUIsQ0FBQyxTQUFvQixFQUFFLE1BQWMsRUFBRSxHQUFnQixFQUFFLElBQVc7UUFDbkcsT0FBTyxJQUFJLFlBQVksQ0FBQyxTQUFTLEVBQUUsTUFBTSxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN4RCxDQUFDO0NBQ0YifQ==

package/dest/contract/contract.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=contract.test.d.ts.map

package/dest/contract/contract.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.test.d.ts","sourceRoot":"","sources":["../../src/contract/contract.test.ts"],"names":[],"mappings":""}

package/dest/contract/contract.test.js

@@ -0,0 +1,141 @@
+import { CompleteAddress, EthAddress } from '@aztec/circuits.js';
+import { ABIParameterVisibility, FunctionType } from '@aztec/foundation/abi';
+import { ExtendedContractData, randomContractAbi, randomDeployedContract, } from '@aztec/types';
+import { mock } from 'jest-mock-extended';
+import { Contract } from './contract.js';
+describe('Contract Class', () => {
+    let wallet;
+    let resolvedExtendedContractData;
+    let contractAddress;
+    let account;
+    const mockTx = { type: 'Tx' };
+    const mockTxRequest = { type: 'TxRequest' };
+    const mockTxHash = { type: 'TxHash' };
+    const mockTxReceipt = { type: 'TxReceipt' };
+    const mockViewResultValue = 1;
+    const mockNodeInfo = { version: 1, chainId: 2, rollupAddress: EthAddress.random(), client: '' };
+    const defaultAbi = {
+        name: 'FooContract',
+        functions: [
+            {
+                name: 'bar',
+                functionType: FunctionType.SECRET,
+                isInternal: false,
+                parameters: [
+                    {
+                        name: 'value',
+                        type: {
+                            kind: 'field',
+                        },
+                        visibility: ABIParameterVisibility.PUBLIC,
+                    },
+                    {
+                        name: 'value',
+                        type: {
+                            kind: 'field',
+                        },
+                        visibility: ABIParameterVisibility.SECRET,
+                    },
+                ],
+                returnTypes: [],
+                bytecode: '0af',
+            },
+            {
+                name: 'baz',
+                functionType: FunctionType.OPEN,
+                isInternal: false,
+                parameters: [],
+                returnTypes: [],
+                bytecode: '0be',
+            },
+            {
+                name: 'qux',
+                functionType: FunctionType.UNCONSTRAINED,
+                isInternal: false,
+                parameters: [
+                    {
+                        name: 'value',
+                        type: {
+                            kind: 'field',
+                        },
+                        visibility: ABIParameterVisibility.PUBLIC,
+                    },
+                ],
+                returnTypes: [
+                    {
+                        kind: 'integer',
+                        sign: '',
+                        width: 32,
+                    },
+                ],
+                bytecode: '0cd',
+            },
+        ],
+    };
+    beforeEach(async () => {
+        resolvedExtendedContractData = ExtendedContractData.random();
+        contractAddress = resolvedExtendedContractData.contractData.contractAddress;
+        account = await CompleteAddress.random();
+        wallet = mock();
+        wallet.createTxExecutionRequest.mockResolvedValue(mockTxRequest);
+        wallet.getExtendedContractData.mockResolvedValue(resolvedExtendedContractData);
+        wallet.sendTx.mockResolvedValue(mockTxHash);
+        wallet.viewTx.mockResolvedValue(mockViewResultValue);
+        wallet.getTxReceipt.mockResolvedValue(mockTxReceipt);
+        wallet.getNodeInfo.mockResolvedValue(mockNodeInfo);
+        wallet.simulateTx.mockResolvedValue(mockTx);
+        wallet.getAccounts.mockResolvedValue([account]);
+    });
+    it('should create and send a contract method tx', async () => {
+        const fooContract = await Contract.at(contractAddress, defaultAbi, wallet);
+        const param0 = 12;
+        const param1 = 345n;
+        const sentTx = fooContract.methods.bar(param0, param1).send();
+        const txHash = await sentTx.getTxHash();
+        const receipt = await sentTx.getReceipt();
+        expect(txHash).toBe(mockTxHash);
+        expect(receipt).toBe(mockTxReceipt);
+        expect(wallet.createTxExecutionRequest).toHaveBeenCalledTimes(1);
+        expect(wallet.sendTx).toHaveBeenCalledTimes(1);
+        expect(wallet.sendTx).toHaveBeenCalledWith(mockTx);
+    });
+    it('should call view on an unconstrained function', async () => {
+        const fooContract = await Contract.at(contractAddress, defaultAbi, wallet);
+        const result = await fooContract.methods.qux(123n).view({
+            from: account.address,
+        });
+        expect(wallet.viewTx).toHaveBeenCalledTimes(1);
+        expect(wallet.viewTx).toHaveBeenCalledWith('qux', [123n], contractAddress, account.address);
+        expect(result).toBe(mockViewResultValue);
+    });
+    it('should not call create on an unconstrained function', async () => {
+        const fooContract = await Contract.at(contractAddress, defaultAbi, wallet);
+        await expect(fooContract.methods.qux().create()).rejects.toThrow();
+    });
+    it('should not call view on a secret or open function', async () => {
+        const fooContract = await Contract.at(contractAddress, defaultAbi, wallet);
+        expect(() => fooContract.methods.bar().view()).toThrow();
+        expect(() => fooContract.methods.baz().view()).toThrow();
+    });
+    it('should add contract and dependencies to aztec rpc', async () => {
+        const entry = {
+            abi: randomContractAbi(),
+            completeAddress: resolvedExtendedContractData.getCompleteAddress(),
+            portalContract: EthAddress.random(),
+        };
+        const contract = await Contract.at(entry.completeAddress.address, entry.abi, wallet);
+        {
+            await contract.attach(entry.portalContract);
+            expect(wallet.addContracts).toHaveBeenCalledTimes(1);
+            expect(wallet.addContracts).toHaveBeenCalledWith([entry]);
+            wallet.addContracts.mockClear();
+        }
+        {
+            const dependencies = [await randomDeployedContract(), await randomDeployedContract()];
+            await contract.attach(entry.portalContract, dependencies);
+            expect(wallet.addContracts).toHaveBeenCalledTimes(1);
+            expect(wallet.addContracts).toHaveBeenCalledWith([entry, ...dependencies]);
+        }
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3QudGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdC9jb250cmFjdC50ZXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBZ0IsZUFBZSxFQUFFLFVBQVUsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQy9FLE9BQU8sRUFBRSxzQkFBc0IsRUFBZSxZQUFZLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUMxRixPQUFPLEVBRUwsb0JBQW9CLEVBTXBCLGlCQUFpQixFQUNqQixzQkFBc0IsR0FDdkIsTUFBTSxjQUFjLENBQUM7QUFFdEIsT0FBTyxFQUFhLElBQUksRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBR3JELE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxlQUFlLENBQUM7QUFFekMsUUFBUSxDQUFDLGdCQUFnQixFQUFFLEdBQUcsRUFBRTtJQUM5QixJQUFJLE1BQXlCLENBQUM7SUFDOUIsSUFBSSw0QkFBa0QsQ0FBQztJQUN2RCxJQUFJLGVBQTZCLENBQUM7SUFDbEMsSUFBSSxPQUF3QixDQUFDO0lBRTdCLE1BQU0sTUFBTSxHQUFHLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBZSxDQUFDO0lBQzNDLE1BQU0sYUFBYSxHQUFHLEVBQUUsSUFBSSxFQUFFLFdBQVcsRUFBK0IsQ0FBQztJQUN6RSxNQUFNLFVBQVUsR0FBRyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQW1CLENBQUM7SUFDdkQsTUFBTSxhQUFhLEdBQUcsRUFBRSxJQUFJLEVBQUUsV0FBVyxFQUFzQixDQUFDO0lBQ2hFLE1BQU0sbUJBQW1CLEdBQUcsQ0FBQyxDQUFDO0lBQzlCLE1BQU0sWUFBWSxHQUFhLEVBQUUsT0FBTyxFQUFFLENBQUMsRUFBRSxPQUFPLEVBQUUsQ0FBQyxFQUFFLGFBQWEsRUFBRSxVQUFVLENBQUMsTUFBTSxFQUFFLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxDQUFDO0lBRTFHLE1BQU0sVUFBVSxHQUFnQjtRQUM5QixJQUFJLEVBQUUsYUFBYTtRQUNuQixTQUFTLEVBQUU7WUFDVDtnQkFDRSxJQUFJLEVBQUUsS0FBSztnQkFDWCxZQUFZLEVBQUUsWUFBWSxDQUFDLE1BQU07Z0JBQ2pDLFVBQVUsRUFBRSxLQUFLO2dCQUNqQixVQUFVLEVBQUU7b0JBQ1Y7d0JBQ0UsSUFBSSxFQUFFLE9BQU87d0JBQ2IsSUFBSSxFQUFFOzRCQUNKLElBQUksRUFBRSxPQUFPO3lCQUNkO3dCQUNELFVBQVUsRUFBRSxzQkFBc0IsQ0FBQyxNQUFNO3FCQUMxQztvQkFDRDt3QkFDRSxJQUFJLEVBQUUsT0FBTzt3QkFDYixJQUFJLEVBQUU7NEJBQ0osSUFBSSxFQUFFLE9BQU87eUJBQ2Q7d0JBQ0QsVUFBVSxFQUFFLHNCQUFzQixDQUFDLE1BQU07cUJBQzFDO2lCQUNGO2dCQUNELFdBQVcsRUFBRSxFQUFFO2dCQUNmLFFBQVEsRUFBRSxLQUFLO2FBQ2hCO1lBQ0Q7Z0JBQ0UsSUFBSSxFQUFFLEtBQUs7Z0JBQ1gsWUFBWSxFQUFFLFlBQVksQ0FBQyxJQUFJO2dCQUMvQixVQUFVLEVBQUUsS0FBSztnQkFDakIsVUFBVSxFQUFFLEVBQUU7Z0JBQ2QsV0FBVyxFQUFFLEVBQUU7Z0JBQ2YsUUFBUSxFQUFFLEtBQUs7YUFDaEI7WUFDRDtnQkFDRSxJQUFJLEVBQUUsS0FBSztnQkFDWCxZQUFZLEVBQUUsWUFBWSxDQUFDLGFBQWE7Z0JBQ3hDLFVBQVUsRUFBRSxLQUFLO2dCQUNqQixVQUFVLEVBQUU7b0JBQ1Y7d0JBQ0UsSUFBSSxFQUFFLE9BQU87d0JBQ2IsSUFBSSxFQUFFOzRCQUNKLElBQUksRUFBRSxPQUFPO3lCQUNkO3dCQUNELFVBQVUsRUFBRSxzQkFBc0IsQ0FBQyxNQUFNO3FCQUMxQztpQkFDRjtnQkFDRCxXQUFXLEVBQUU7b0JBQ1g7d0JBQ0UsSUFBSSxFQUFFLFNBQVM7d0JBQ2YsSUFBSSxFQUFFLEVBQUU7d0JBQ1IsS0FBSyxFQUFFLEVBQUU7cUJBQ1Y7aUJBQ0Y7Z0JBQ0QsUUFBUSxFQUFFLEtBQUs7YUFDaEI7U0FDRjtLQUNGLENBQUM7SUFFRixVQUFVLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDcEIsNEJBQTRCLEdBQUcsb0JBQW9CLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDN0QsZUFBZSxHQUFHLDRCQUE0QixDQUFDLFlBQVksQ0FBQyxlQUFlLENBQUM7UUFDNUUsT0FBTyxHQUFHLE1BQU0sZUFBZSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBRXpDLE1BQU0sR0FBRyxJQUFJLEVBQVUsQ0FBQztRQUN4QixNQUFNLENBQUMsd0JBQXdCLENBQUMsaUJBQWlCLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDakUsTUFBTSxDQUFDLHVCQUF1QixDQUFDLGlCQUFpQixDQUFDLDRCQUE0QixDQUFDLENBQUM7UUFDL0UsTUFBTSxDQUFDLE1BQU0sQ0FBQyxpQkFBaUIsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUM1QyxNQUFNLENBQUMsTUFBTSxDQUFDLGlCQUFpQixDQUFDLG1CQUFtQixDQUFDLENBQUM7UUFDckQsTUFBTSxDQUFDLFlBQVksQ0FBQyxpQkFBaUIsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNyRCxNQUFNLENBQUMsV0FBVyxDQUFDLGlCQUFpQixDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQ25ELE1BQU0sQ0FBQyxVQUFVLENBQUMsaUJBQWlCLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDNUMsTUFBTSxDQUFDLFdBQVcsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDbEQsQ0FBQyxDQUFDLENBQUM7SUFFSCxFQUFFLENBQUMsNkNBQTZDLEVBQUUsS0FBSyxJQUFJLEVBQUU7UUFDM0QsTUFBTSxXQUFXLEdBQUcsTUFBTSxRQUFRLENBQUMsRUFBRSxDQUFDLGVBQWUsRUFBRSxVQUFVLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDM0UsTUFBTSxNQUFNLEdBQUcsRUFBRSxDQUFDO1FBQ2xCLE1BQU0sTUFBTSxHQUFHLElBQUksQ0FBQztRQUNwQixNQUFNLE1BQU0sR0FBRyxXQUFXLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsTUFBTSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUQsTUFBTSxNQUFNLEdBQUcsTUFBTSxNQUFNLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDeEMsTUFBTSxPQUFPLEdBQUcsTUFBTSxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7UUFFMUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUNoQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQ3BDLE1BQU0sQ0FBQyxNQUFNLENBQUMsd0JBQXdCLENBQUMsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNqRSxNQUFNLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQy9DLE1BQU0sQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsb0JBQW9CLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDckQsQ0FBQyxDQUFDLENBQUM7SUFFSCxFQUFFLENBQUMsK0NBQStDLEVBQUUsS0FBSyxJQUFJLEVBQUU7UUFDN0QsTUFBTSxXQUFXLEdBQUcsTUFBTSxRQUFRLENBQUMsRUFBRSxDQUFDLGVBQWUsRUFBRSxVQUFVLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDM0UsTUFBTSxNQUFNLEdBQUcsTUFBTSxXQUFXLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFDdEQsSUFBSSxFQUFFLE9BQU8sQ0FBQyxPQUFPO1NBQ3RCLENBQUMsQ0FBQztRQUNILE1BQU0sQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDL0MsTUFBTSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxvQkFBb0IsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRSxlQUFlLEVBQUUsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzVGLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUMsbUJBQW1CLENBQUMsQ0FBQztJQUMzQyxDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyxxREFBcUQsRUFBRSxLQUFLLElBQUksRUFBRTtRQUNuRSxNQUFNLFdBQVcsR0FBRyxNQUFNLFFBQVEsQ0FBQyxFQUFFLENBQUMsZUFBZSxFQUFFLFVBQVUsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUMzRSxNQUFNLE1BQU0sQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ3JFLENBQUMsQ0FBQyxDQUFDO0lBRUgsRUFBRSxDQUFDLG1EQUFtRCxFQUFFLEtBQUssSUFBSSxFQUFFO1FBQ2pFLE1BQU0sV0FBVyxHQUFHLE1BQU0sUUFBUSxDQUFDLEVBQUUsQ0FBQyxlQUFlLEVBQUUsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQzNFLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDekQsTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUMzRCxDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyxtREFBbUQsRUFBRSxLQUFLLElBQUksRUFBRTtRQUNqRSxNQUFNLEtBQUssR0FBcUI7WUFDOUIsR0FBRyxFQUFFLGlCQUFpQixFQUFFO1lBQ3hCLGVBQWUsRUFBRSw0QkFBNEIsQ0FBQyxrQkFBa0IsRUFBRTtZQUNsRSxjQUFjLEVBQUUsVUFBVSxDQUFDLE1BQU0sRUFBRTtTQUNwQyxDQUFDO1FBQ0YsTUFBTSxRQUFRLEdBQUcsTUFBTSxRQUFRLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxlQUFlLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFFckY7WUFDRSxNQUFNLFFBQVEsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBQzVDLE1BQU0sQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDckQsTUFBTSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUM7WUFDMUQsTUFBTSxDQUFDLFlBQVksQ0FBQyxTQUFTLEVBQUUsQ0FBQztTQUNqQztRQUVEO1lBQ0UsTUFBTSxZQUFZLEdBQUcsQ0FBQyxNQUFNLHNCQUFzQixFQUFFLEVBQUUsTUFBTSxzQkFBc0IsRUFBRSxDQUFDLENBQUM7WUFDdEYsTUFBTSxRQUFRLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxjQUFjLEVBQUUsWUFBWSxDQUFDLENBQUM7WUFDMUQsTUFBTSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNyRCxNQUFNLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDLG9CQUFvQixDQUFDLENBQUMsS0FBSyxFQUFFLEdBQUcsWUFBWSxDQUFDLENBQUMsQ0FBQztTQUM1RTtJQUNILENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDLENBQUMifQ==

package/dest/contract/contract_base.d.ts

@@ -0,0 +1,72 @@
+import { ContractAbi, FunctionSelector } from '@aztec/foundation/abi';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { CompleteAddress, DeployedContract } from '@aztec/types';
+import { Wallet } from '../aztec_rpc_client/wallet.js';
+import { ContractFunctionInteraction } from './contract_function_interaction.js';
+/**
+ * Type representing a contract method that returns a ContractFunctionInteraction instance
+ * and has a readonly 'selector' property of type Buffer. Takes any number of arguments.
+ */
+export type ContractMethod = ((...args: any[]) => ContractFunctionInteraction) & {
+    /**
+     * The unique identifier for a contract function in bytecode.
+     */
+    readonly selector: FunctionSelector;
+};
+/**
+ * Abstract implementation of a contract extended by the Contract class and generated contract types.
+ */
+export declare class ContractBase {
+    /**
+     * The deployed contract's complete address.
+     */
+    readonly completeAddress: CompleteAddress;
+    /**
+     * The Application Binary Interface for the contract.
+     */
+    readonly abi: ContractAbi;
+    /**
+     * The wallet.
+     */
+    protected wallet: Wallet;
+    /**
+     * An object containing contract methods mapped to their respective names.
+     */
+    methods: {
+        [name: string]: ContractMethod;
+    };
+    protected constructor(
+    /**
+     * The deployed contract's complete address.
+     */
+    completeAddress: CompleteAddress, 
+    /**
+     * The Application Binary Interface for the contract.
+     */
+    abi: ContractAbi, 
+    /**
+     * The wallet.
+     */
+    wallet: Wallet);
+    /**
+     * Address of the contract.
+     */
+    get address(): import("@aztec/circuits.js").AztecAddress;
+    /**
+     * Creates a new instance of the contract wrapper attached to a different wallet.
+     * @param wallet - Wallet to use for sending txs.
+     * @returns A new contract instance.
+     */
+    withWallet(wallet: Wallet): this;
+    /**
+     * Attach the current contract instance to a portal contract and optionally add its dependencies.
+     * The function will return a promise that resolves when all contracts have been added to the AztecRPCClient.
+     * This is useful when you need to interact with a deployed contract that has multiple nested contracts.
+     *
+     * @param portalContract - The Ethereum address of the portal contract.
+     * @param dependencies - An optional array of additional DeployedContract instances to be attached.
+     * @returns A promise that resolves when all contracts are successfully added to the AztecRPCClient.
+     */
+    attach(portalContract: EthAddress, dependencies?: DeployedContract[]): Promise<void>;
+}
+//# sourceMappingURL=contract_base.d.ts.map

package/dest/contract/contract_base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract_base.d.ts","sourceRoot":"","sources":["../../src/contract/contract_base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,2BAA2B,CAAC,GAAG;IAC/E;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY;IAOrB;;OAEG;aACa,eAAe,EAAE,eAAe;IAChD;;OAEG;aACa,GAAG,EAAE,WAAW;IAChC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM;IAjB1B;;OAEG;IACI,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAM;IAExD,SAAS;IACP;;OAEG;IACa,eAAe,EAAE,eAAe;IAChD;;OAEG;IACa,GAAG,EAAE,WAAW;IAChC;;OAEG;IACO,MAAM,EAAE,MAAM;IAmB1B;;OAEG;IACH,IAAW,OAAO,8CAEjB;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIvC;;;;;;;;OAQG;IACI,MAAM,CAAC,cAAc,EAAE,UAAU,EAAE,YAAY,GAAE,gBAAgB,EAAO;CAQhF"}