@aztec/aztec.js 0.1.0-alpha13

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,69 @@
+/// <reference types="node" resolution-mode="require"/>
+import { DeployedContract } from '@aztec/aztec-rpc';
+import { ContractAbi } from '@aztec/foundation/abi';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { EthAddress } from '@aztec/foundation/eth-address';
+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.
+ */
+type ContractMethod = ((...args: any[]) => ContractFunctionInteraction) & {
+    /**
+     * The unique identifier for a contract function in bytecode.
+     */
+    readonly selector: Buffer;
+};
+/**
+ * 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 {
+    /**
+     * The deployed contract's address.
+     */
+    readonly address: AztecAddress;
+    /**
+     * The Application Binary Interface for the contract.
+     */
+    readonly abi: ContractAbi;
+    /**
+     * The wallet.
+     */
+    private wallet;
+    /**
+     * An object containing contract methods mapped to their respective names.
+     */
+    methods: {
+        [name: string]: ContractMethod;
+    };
+    constructor(
+    /**
+     * The deployed contract's address.
+     */
+    address: AztecAddress, 
+    /**
+     * The Application Binary Interface for the contract.
+     */
+    abi: ContractAbi, 
+    /**
+     * The wallet.
+     */
+    wallet: Wallet);
+    /**
+     * 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>;
+}
+export {};
+//# 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,gBAAgB,EAA4B,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAe,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF;;;GAGG;AACH,KAAK,cAAc,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,2BAA2B,CAAC,GAAG;IACxE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,QAAQ;IAOjB;;OAEG;aACa,OAAO,EAAE,YAAY;IACrC;;OAEG;aACa,GAAG,EAAE,WAAW;IAChC;;OAEG;IACH,OAAO,CAAC,MAAM;IAjBhB;;OAEG;IACI,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAM;;IAGtD;;OAEG;IACa,OAAO,EAAE,YAAY;IACrC;;OAEG;IACa,GAAG,EAAE,WAAW;IAChC;;OAEG;IACK,MAAM,EAAE,MAAM;IAmBxB;;;;;;;;OAQG;IACH,MAAM,CAAC,cAAc,EAAE,UAAU,EAAE,YAAY,GAAE,gBAAgB,EAAO;CAQzE"}

package/dest/contract/contract.js

@@ -0,0 +1,64 @@
+import { generateFunctionSelector } from '@aztec/aztec-rpc';
+import { ContractFunctionInteraction } from './contract_function_interaction.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 {
+    constructor(
+    /**
+     * The deployed contract's address.
+     */
+    address, 
+    /**
+     * The Application Binary Interface for the contract.
+     */
+    abi, 
+    /**
+     * The wallet.
+     */
+    wallet) {
+        this.address = address;
+        this.abi = abi;
+        this.wallet = wallet;
+        /**
+         * An object containing contract methods mapped to their respective names.
+         */
+        this.methods = {};
+        abi.functions.forEach((f) => {
+            const interactionFunction = (...args) => {
+                return new ContractFunctionInteraction(this.wallet, this.address, f, args);
+            };
+            this.methods[f.name] = Object.assign(interactionFunction, {
+                /**
+                 * A getter for users to fetch the function selector.
+                 * @returns Selector of the function.
+                 */
+                get selector() {
+                    return generateFunctionSelector(f.name, f.parameters);
+                },
+            });
+        });
+    }
+    /**
+     * 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, dependencies = []) {
+        const deployedContract = {
+            abi: this.abi,
+            address: this.address,
+            portalContract,
+        };
+        return this.wallet.addContracts([deployedContract, ...dependencies]);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3QvY29udHJhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFvQix3QkFBd0IsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBSzlFLE9BQU8sRUFBRSwyQkFBMkIsRUFBRSxNQUFNLG9DQUFvQyxDQUFDO0FBYWpGOzs7Ozs7R0FNRztBQUNILE1BQU0sT0FBTyxRQUFRO0lBTW5CO0lBQ0U7O09BRUc7SUFDYSxPQUFxQjtJQUNyQzs7T0FFRztJQUNhLEdBQWdCO0lBQ2hDOztPQUVHO0lBQ0ssTUFBYztRQVJOLFlBQU8sR0FBUCxPQUFPLENBQWM7UUFJckIsUUFBRyxHQUFILEdBQUcsQ0FBYTtRQUl4QixXQUFNLEdBQU4sTUFBTSxDQUFRO1FBakJ4Qjs7V0FFRztRQUNJLFlBQU8sR0FBdUMsRUFBRSxDQUFDO1FBZ0J0RCxHQUFHLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQWMsRUFBRSxFQUFFO1lBQ3ZDLE1BQU0sbUJBQW1CLEdBQUcsQ0FBQyxHQUFHLElBQVcsRUFBRSxFQUFFO2dCQUM3QyxPQUFPLElBQUksMkJBQTJCLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsT0FBUSxFQUFFLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztZQUM5RSxDQUFDLENBQUM7WUFFRixJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxNQUFNLENBQUMsTUFBTSxDQUFDLG1CQUFtQixFQUFFO2dCQUN4RDs7O21CQUdHO2dCQUNILElBQUksUUFBUTtvQkFDVixPQUFPLHdCQUF3QixDQUFDLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxDQUFDO2dCQUN4RCxDQUFDO2FBQ0YsQ0FBQyxDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxNQUFNLENBQUMsY0FBMEIsRUFBRSxlQUFtQyxFQUFFO1FBQ3RFLE1BQU0sZ0JBQWdCLEdBQXFCO1lBQ3pDLEdBQUcsRUFBRSxJQUFJLENBQUMsR0FBRztZQUNiLE9BQU8sRUFBRSxJQUFJLENBQUMsT0FBTztZQUNyQixjQUFjO1NBQ2YsQ0FBQztRQUNGLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxnQkFBZ0IsRUFBRSxHQUFHLFlBQVksQ0FBQyxDQUFDLENBQUM7SUFDdkUsQ0FBQztDQUNGIn0=

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 { AztecAddress, EthAddress } from '@aztec/aztec-rpc';
+import { mock } from 'jest-mock-extended';
+import { ABIParameterVisibility, FunctionType } from '@aztec/foundation/abi';
+import { randomBytes } from '@aztec/foundation/crypto';
+import { Contract } from './contract.js';
+describe('Contract Class', () => {
+    let wallet;
+    const contractAddress = AztecAddress.random();
+    const account = AztecAddress.random();
+    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 };
+    const defaultAbi = {
+        name: 'FooContract',
+        functions: [
+            {
+                name: 'bar',
+                functionType: FunctionType.SECRET,
+                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,
+                parameters: [],
+                returnTypes: [],
+                bytecode: '0be',
+            },
+            {
+                name: 'qux',
+                functionType: FunctionType.UNCONSTRAINED,
+                parameters: [
+                    {
+                        name: 'value',
+                        type: {
+                            kind: 'field',
+                        },
+                        visibility: ABIParameterVisibility.PUBLIC,
+                    },
+                ],
+                returnTypes: [
+                    {
+                        kind: 'integer',
+                        sign: '',
+                        width: 32,
+                    },
+                ],
+                bytecode: '0cd',
+            },
+        ],
+    };
+    const randomContractAbi = () => ({
+        name: randomBytes(4).toString('hex'),
+        functions: [],
+    });
+    const randomDeployContract = () => ({
+        abi: randomContractAbi(),
+        address: AztecAddress.random(),
+        portalContract: EthAddress.random(),
+    });
+    beforeEach(() => {
+        wallet = mock();
+        wallet.createAuthenticatedTxRequest.mockResolvedValue(mockTxRequest);
+        wallet.sendTx.mockResolvedValue(mockTxHash);
+        wallet.viewTx.mockResolvedValue(mockViewResultValue);
+        wallet.getTxReceipt.mockResolvedValue(mockTxReceipt);
+        wallet.getNodeInfo.mockResolvedValue(mockNodeInfo);
+        wallet.simulateTx.mockResolvedValue(mockTx);
+    });
+    it('should create and send a contract method tx', async () => {
+        const fooContract = new Contract(contractAddress, defaultAbi, wallet);
+        const param0 = 12;
+        const param1 = 345n;
+        const sentTx = fooContract.methods.bar(param0, param1).send({
+            from: account,
+        });
+        const txHash = await sentTx.getTxHash();
+        const receipt = await sentTx.getReceipt();
+        expect(txHash).toBe(mockTxHash);
+        expect(receipt).toBe(mockTxReceipt);
+        expect(wallet.createAuthenticatedTxRequest).toHaveBeenCalledTimes(1);
+        expect(wallet.sendTx).toHaveBeenCalledTimes(1);
+        expect(wallet.sendTx).toHaveBeenCalledWith(mockTx);
+    });
+    it('should call view on an unconstrained function', async () => {
+        const fooContract = new Contract(contractAddress, defaultAbi, wallet);
+        const result = await fooContract.methods.qux(123n).view({
+            from: account,
+        });
+        expect(wallet.viewTx).toHaveBeenCalledTimes(1);
+        expect(wallet.viewTx).toHaveBeenCalledWith('qux', [123n], contractAddress, account);
+        expect(result).toBe(mockViewResultValue);
+    });
+    it('should not call send on an unconstrained function', () => {
+        const fooContract = new Contract(contractAddress, defaultAbi, wallet);
+        expect(() => fooContract.methods.qux().send({
+            from: account,
+        })).toThrow();
+    });
+    it('should not call view on a secret or open function', () => {
+        const fooContract = new Contract(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 = randomDeployContract();
+        const contract = new Contract(entry.address, entry.abi, wallet);
+        {
+            await contract.attach(entry.portalContract);
+            expect(wallet.addContracts).toHaveBeenCalledTimes(1);
+            expect(wallet.addContracts).toHaveBeenCalledWith([entry]);
+            wallet.addContracts.mockClear();
+        }
+        {
+            const dependencies = [randomDeployContract(), randomDeployContract()];
+            await contract.attach(entry.portalContract, dependencies);
+            expect(wallet.addContracts).toHaveBeenCalledTimes(1);
+            expect(wallet.addContracts).toHaveBeenCalledWith([entry, ...dependencies]);
+        }
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3QudGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdC9jb250cmFjdC50ZXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxZQUFZLEVBQW9CLFVBQVUsRUFBbUMsTUFBTSxrQkFBa0IsQ0FBQztBQUMvRyxPQUFPLEVBQWEsSUFBSSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFFckQsT0FBTyxFQUFFLHNCQUFzQixFQUFlLFlBQVksRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBQzFGLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSwwQkFBMEIsQ0FBQztBQUd2RCxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sZUFBZSxDQUFDO0FBRXpDLFFBQVEsQ0FBQyxnQkFBZ0IsRUFBRSxHQUFHLEVBQUU7SUFDOUIsSUFBSSxNQUF5QixDQUFDO0lBRTlCLE1BQU0sZUFBZSxHQUFHLFlBQVksQ0FBQyxNQUFNLEVBQUUsQ0FBQztJQUM5QyxNQUFNLE9BQU8sR0FBRyxZQUFZLENBQUMsTUFBTSxFQUFFLENBQUM7SUFFdEMsTUFBTSxNQUFNLEdBQUcsRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFlLENBQUM7SUFDM0MsTUFBTSxhQUFhLEdBQUcsRUFBRSxJQUFJLEVBQUUsV0FBVyxFQUErQixDQUFDO0lBQ3pFLE1BQU0sVUFBVSxHQUFHLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBbUIsQ0FBQztJQUN2RCxNQUFNLGFBQWEsR0FBRyxFQUFFLElBQUksRUFBRSxXQUFXLEVBQXNCLENBQUM7SUFDaEUsTUFBTSxtQkFBbUIsR0FBRyxDQUFDLENBQUM7SUFDOUIsTUFBTSxZQUFZLEdBQWEsRUFBRSxPQUFPLEVBQUUsQ0FBQyxFQUFFLE9BQU8sRUFBRSxDQUFDLEVBQUUsQ0FBQztJQUUxRCxNQUFNLFVBQVUsR0FBZ0I7UUFDOUIsSUFBSSxFQUFFLGFBQWE7UUFDbkIsU0FBUyxFQUFFO1lBQ1Q7Z0JBQ0UsSUFBSSxFQUFFLEtBQUs7Z0JBQ1gsWUFBWSxFQUFFLFlBQVksQ0FBQyxNQUFNO2dCQUNqQyxVQUFVLEVBQUU7b0JBQ1Y7d0JBQ0UsSUFBSSxFQUFFLE9BQU87d0JBQ2IsSUFBSSxFQUFFOzRCQUNKLElBQUksRUFBRSxPQUFPO3lCQUNkO3dCQUNELFVBQVUsRUFBRSxzQkFBc0IsQ0FBQyxNQUFNO3FCQUMxQztvQkFDRDt3QkFDRSxJQUFJLEVBQUUsT0FBTzt3QkFDYixJQUFJLEVBQUU7NEJBQ0osSUFBSSxFQUFFLE9BQU87eUJBQ2Q7d0JBQ0QsVUFBVSxFQUFFLHNCQUFzQixDQUFDLE1BQU07cUJBQzFDO2lCQUNGO2dCQUNELFdBQVcsRUFBRSxFQUFFO2dCQUNmLFFBQVEsRUFBRSxLQUFLO2FBQ2hCO1lBQ0Q7Z0JBQ0UsSUFBSSxFQUFFLEtBQUs7Z0JBQ1gsWUFBWSxFQUFFLFlBQVksQ0FBQyxJQUFJO2dCQUMvQixVQUFVLEVBQUUsRUFBRTtnQkFDZCxXQUFXLEVBQUUsRUFBRTtnQkFDZixRQUFRLEVBQUUsS0FBSzthQUNoQjtZQUNEO2dCQUNFLElBQUksRUFBRSxLQUFLO2dCQUNYLFlBQVksRUFBRSxZQUFZLENBQUMsYUFBYTtnQkFDeEMsVUFBVSxFQUFFO29CQUNWO3dCQUNFLElBQUksRUFBRSxPQUFPO3dCQUNiLElBQUksRUFBRTs0QkFDSixJQUFJLEVBQUUsT0FBTzt5QkFDZDt3QkFDRCxVQUFVLEVBQUUsc0JBQXNCLENBQUMsTUFBTTtxQkFDMUM7aUJBQ0Y7Z0JBQ0QsV0FBVyxFQUFFO29CQUNYO3dCQUNFLElBQUksRUFBRSxTQUFTO3dCQUNmLElBQUksRUFBRSxFQUFFO3dCQUNSLEtBQUssRUFBRSxFQUFFO3FCQUNWO2lCQUNGO2dCQUNELFFBQVEsRUFBRSxLQUFLO2FBQ2hCO1NBQ0Y7S0FDRixDQUFDO0lBRUYsTUFBTSxpQkFBaUIsR0FBRyxHQUFnQixFQUFFLENBQUMsQ0FBQztRQUM1QyxJQUFJLEVBQUUsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUM7UUFDcEMsU0FBUyxFQUFFLEVBQUU7S0FDZCxDQUFDLENBQUM7SUFFSCxNQUFNLG9CQUFvQixHQUFHLEdBQXFCLEVBQUUsQ0FBQyxDQUFDO1FBQ3BELEdBQUcsRUFBRSxpQkFBaUIsRUFBRTtRQUN4QixPQUFPLEVBQUUsWUFBWSxDQUFDLE1BQU0sRUFBRTtRQUM5QixjQUFjLEVBQUUsVUFBVSxDQUFDLE1BQU0sRUFBRTtLQUNwQyxDQUFDLENBQUM7SUFFSCxVQUFVLENBQUMsR0FBRyxFQUFFO1FBQ2QsTUFBTSxHQUFHLElBQUksRUFBVSxDQUFDO1FBQ3hCLE1BQU0sQ0FBQyw0QkFBNEIsQ0FBQyxpQkFBaUIsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNyRSxNQUFNLENBQUMsTUFBTSxDQUFDLGlCQUFpQixDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQzVDLE1BQU0sQ0FBQyxNQUFNLENBQUMsaUJBQWlCLENBQUMsbUJBQW1CLENBQUMsQ0FBQztRQUNyRCxNQUFNLENBQUMsWUFBWSxDQUFDLGlCQUFpQixDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQ3JELE1BQU0sQ0FBQyxXQUFXLENBQUMsaUJBQWlCLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDbkQsTUFBTSxDQUFDLFVBQVUsQ0FBQyxpQkFBaUIsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyw2Q0FBNkMsRUFBRSxLQUFLLElBQUksRUFBRTtRQUMzRCxNQUFNLFdBQVcsR0FBRyxJQUFJLFFBQVEsQ0FBQyxlQUFlLEVBQUUsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQ3RFLE1BQU0sTUFBTSxHQUFHLEVBQUUsQ0FBQztRQUNsQixNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUM7UUFDcEIsTUFBTSxNQUFNLEdBQUcsV0FBVyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDLElBQUksQ0FBQztZQUMxRCxJQUFJLEVBQUUsT0FBTztTQUNkLENBQUMsQ0FBQztRQUNILE1BQU0sTUFBTSxHQUFHLE1BQU0sTUFBTSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ3hDLE1BQU0sT0FBTyxHQUFHLE1BQU0sTUFBTSxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBRTFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDaEMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNwQyxNQUFNLENBQUMsTUFBTSxDQUFDLDRCQUE0QixDQUFDLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDckUsTUFBTSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUMvQyxNQUFNLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLG9CQUFvQixDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ3JELENBQUMsQ0FBQyxDQUFDO0lBRUgsRUFBRSxDQUFDLCtDQUErQyxFQUFFLEtBQUssSUFBSSxFQUFFO1FBQzdELE1BQU0sV0FBVyxHQUFHLElBQUksUUFBUSxDQUFDLGVBQWUsRUFBRSxVQUFVLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDdEUsTUFBTSxNQUFNLEdBQUcsTUFBTSxXQUFXLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFDdEQsSUFBSSxFQUFFLE9BQU87U0FDZCxDQUFDLENBQUM7UUFDSCxNQUFNLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQy9DLE1BQU0sQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsb0JBQW9CLENBQUMsS0FBSyxFQUFFLENBQUMsSUFBSSxDQUFDLEVBQUUsZUFBZSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBQ3BGLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUMsbUJBQW1CLENBQUMsQ0FBQztJQUMzQyxDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyxtREFBbUQsRUFBRSxHQUFHLEVBQUU7UUFDM0QsTUFBTSxXQUFXLEdBQUcsSUFBSSxRQUFRLENBQUMsZUFBZSxFQUFFLFVBQVUsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUN0RSxNQUFNLENBQUMsR0FBRyxFQUFFLENBQ1YsV0FBVyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUM7WUFDN0IsSUFBSSxFQUFFLE9BQU87U0FDZCxDQUFDLENBQ0gsQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNkLENBQUMsQ0FBQyxDQUFDO0lBRUgsRUFBRSxDQUFDLG1EQUFtRCxFQUFFLEdBQUcsRUFBRTtRQUMzRCxNQUFNLFdBQVcsR0FBRyxJQUFJLFFBQVEsQ0FBQyxlQUFlLEVBQUUsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQ3RFLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDekQsTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUMzRCxDQUFDLENBQUMsQ0FBQztJQUVILEVBQUUsQ0FBQyxtREFBbUQsRUFBRSxLQUFLLElBQUksRUFBRTtRQUNqRSxNQUFNLEtBQUssR0FBRyxvQkFBb0IsRUFBRSxDQUFDO1FBQ3JDLE1BQU0sUUFBUSxHQUFHLElBQUksUUFBUSxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUVoRTtZQUNFLE1BQU0sUUFBUSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDNUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNyRCxNQUFNLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDLG9CQUFvQixDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztZQUMxRCxNQUFNLENBQUMsWUFBWSxDQUFDLFNBQVMsRUFBRSxDQUFDO1NBQ2pDO1FBRUQ7WUFDRSxNQUFNLFlBQVksR0FBRyxDQUFDLG9CQUFvQixFQUFFLEVBQUUsb0JBQW9CLEVBQUUsQ0FBQyxDQUFDO1lBQ3RFLE1BQU0sUUFBUSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLFlBQVksQ0FBQyxDQUFDO1lBQzFELE1BQU0sQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDckQsTUFBTSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDLEtBQUssRUFBRSxHQUFHLFlBQVksQ0FBQyxDQUFDLENBQUM7U0FDNUU7SUFDSCxDQUFDLENBQUMsQ0FBQztBQUNMLENBQUMsQ0FBQyxDQUFDIn0=

package/dest/contract/contract_function_interaction.d.ts

@@ -0,0 +1,81 @@
+import { Tx } from '@aztec/aztec-rpc';
+import { AztecAddress, Fr } from '@aztec/circuits.js';
+import { FunctionAbi } from '@aztec/foundation/abi';
+import { ExecutionRequest, TxExecutionRequest } from '@aztec/types';
+import { Wallet } from '../aztec_rpc_client/wallet.js';
+import { SentTx } from './sent_tx.js';
+/**
+ * Represents options for calling a (constrained) function in a contract.
+ * Allows the user to specify the sender address and nonce for a transaction.
+ */
+export interface SendMethodOptions {
+    /**
+     * Sender's address initiating the transaction.
+     */
+    from?: AztecAddress;
+    /**
+     * The nonce representing the order of transactions sent by the address.
+     */
+    nonce?: Fr;
+}
+/**
+ * Represents the options for a view method in a contract function interaction.
+ * Allows specifying the address from which the view method should be called.
+ */
+export interface ViewMethodOptions {
+    /**
+     * The sender's Aztec address.
+     */
+    from?: AztecAddress;
+}
+/**
+ * This is the class that is returned when calling e.g. `contract.methods.myMethod(arg0, arg1)`.
+ * It contains available interactions one can call on a method.
+ */
+export declare class ContractFunctionInteraction {
+    protected wallet: Wallet;
+    protected contractAddress: AztecAddress;
+    protected functionDao: FunctionAbi;
+    protected args: any[];
+    protected tx?: Tx;
+    protected txRequest?: TxExecutionRequest;
+    constructor(wallet: Wallet, contractAddress: AztecAddress, functionDao: FunctionAbi, args: any[]);
+    /**
+     * Create an Aztec transaction instance by combining the transaction request and its signature.
+     * This function will first check if a signature exists, and if not, it will call the `sign` method
+     * to obtain the signature before creating the transaction. Throws an error if the function is
+     * of unconstrained type or if the transaction request and signature are missing.
+     *
+     * @param options - An optional object containing additional configuration for the transaction.
+     * @returns A Promise that resolves to a transaction instance.
+     */
+    create(options?: SendMethodOptions): Promise<TxExecutionRequest>;
+    /**
+     * Simulates a transaction's execution.
+     * @param options - optional arguments to be used in the creation of the transaction
+     * @returns The resulting transaction
+     */
+    simulate(options: SendMethodOptions): Promise<Tx>;
+    protected getExecutionRequest(to: AztecAddress, from?: AztecAddress): ExecutionRequest;
+    /**
+     * Sends a transaction to the contract function with the specified options.
+     * This function throws an error if called on an unconstrained function.
+     * It creates and signs the transaction if necessary, and returns a SentTx instance,
+     * which can be used to track the transaction status, receipt, and events.
+     *
+     * @param options - An optional object containing 'from' property representing
+     * the AztecAddress of the sender. If not provided, the default address is used.
+     * @returns A SentTx instance for tracking the transaction status and information.
+     */
+    send(options?: SendMethodOptions): SentTx;
+    /**
+     * Execute a view (read-only) transaction on an unconstrained function.
+     * This method is used to call functions that do not modify the contract state and only return data.
+     * Throws an error if called on a non-unconstrained function.
+     *
+     * @param options - An optional object containing additional configuration for the transaction.
+     * @returns The result of the view transaction as returned by the contract function.
+     */
+    view(options?: ViewMethodOptions): Promise<any>;
+}
+//# sourceMappingURL=contract_function_interaction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contract_function_interaction.d.ts","sourceRoot":"","sources":["../../src/contract/contract_function_interaction.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,EAAE,EAA2B,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAgB,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,EAAE,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,2BAA2B;IAKpC,SAAS,CAAC,MAAM,EAAE,MAAM;IACxB,SAAS,CAAC,eAAe,EAAE,YAAY;IACvC,SAAS,CAAC,WAAW,EAAE,WAAW;IAClC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE;IAPvB,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;IAClB,SAAS,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC;gBAG7B,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,YAAY,EAC7B,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,GAAG,EAAE;IAGvB;;;;;;;;OAQG;IACU,MAAM,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAcjF;;;;OAIG;IACU,QAAQ,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,EAAE,CAAC;IAO9D,SAAS,CAAC,mBAAmB,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,gBAAgB;IAiBtF;;;;;;;;;OASG;IACI,IAAI,CAAC,OAAO,GAAE,iBAAsB;IAa3C;;;;;;;OAOG;IACI,IAAI,CAAC,OAAO,GAAE,iBAAsB;CAQ5C"}