Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cli: Add command to output function signatures from abis #2180

Closed
PhilWindle opened this issue Sep 11, 2023 · 0 comments · Fixed by #2248 or #2200
Closed

Cli: Add command to output function signatures from abis #2180

PhilWindle opened this issue Sep 11, 2023 · 0 comments · Fixed by #2248 or #2200

Comments

@PhilWindle
Copy link
Collaborator

PhilWindle commented Sep 11, 2023

If a user has just spun up the sandbox and cli and wants to play with our example contracts. How do they know what functions to call with what parameters? It would be great if the cli had a command to produce a human-friendly digest of the abi:

transfer(recipient: field, amount: field)
getBalance(owner: field)
@PhilWindle PhilWindle added this to the 📢 Initial Public Sandbox Release milestone Sep 11, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 11, 2023
@spalladino spalladino moved this from Todo to In Progress in A3 Sep 12, 2023
spalladino added a commit that referenced this issue Sep 12, 2023
Adds an `inspect-contract` command that lists the functions available to
call. Omits internal functions and stev.

```
$ yarn aztec-cli inspect-contract PrivateTokenContractAbi
secret constructor(initial_supply: Field, owner: Field)
unconstrained getBalance(owner: Field)
secret mint(amount: Field, owner: Field)
secret transfer(amount: Field, recipient: Field)
```

Fixes #2180
@github-project-automation github-project-automation bot moved this from In Progress to Done in A3 Sep 12, 2023
PhilWindle pushed a commit that referenced this issue Sep 13, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.7.0</summary>

##
[0.7.0](aztec-packages-v0.6.7...aztec-packages-v0.7.0)
(2023-09-13)


### ⚠ BREAKING CHANGES

* **aztec-noir:** rename noir-aztec to aztec-noir
([#2071](#2071))

### Features

* **build:** Use LTS version of ubuntu
([#2239](#2239))
([ce6671e](ce6671e))
* **ci:** Run nargo test in ci on all packages
([#2197](#2197))
([cca55f2](cca55f2))
* **cli:** Add commands for generating ts and nr interfaces
([#2241](#2241))
([c11b70d](c11b70d)),
closes
[#2183](#2183)
* **cli:** Inspect contract command
([#2248](#2248))
([381706e](381706e)),
closes
[#2180](#2180)
* Define specific Sandbox version when running docker-compose up
([#2238](#2238))
([71da236](71da236))
* **docs:** Updated docs explaining Sandbox accounts
([#2235](#2235))
([f560066](f560066))
* Optimise sandbox startup time by only initialising the BB solver once.
([#2240](#2240))
([e9cac9c](e9cac9c))
* Remove entrypoint collection
([#2148](#2148))
([e97c94d](e97c94d))
* Validate nargo version against expected one
([#2254](#2254))
([011c0b7](011c0b7))


### Bug Fixes

* Add cjs-entry to bbjs package files
([#2237](#2237))
([ae16193](ae16193))
* Add link to example contracts in the monorepo
([#2219](#2219))
([8aede54](8aede54))
* **build:** Update ubuntu version used in Docker builds
([#2236](#2236))
([dbe80b7](dbe80b7))
* **docs:** Use code snippet macros in bridge docs
([#2205](#2205))
([0c3a627](0c3a627))
* Format barretenberg
([#2209](#2209))
([0801372](0801372))
* Msgpack blowup with bigger objects
([#2207](#2207))
([b909937](b909937))
* Refactor constraints in scalar mul to use the high limb
([#2161](#2161))
([1d0e25d](1d0e25d))
* Reinstate v stripping in build
([#2220](#2220))
([13d34f5](13d34f5))
* Return partial witnesses based on the content of read requests.
([#2164](#2164))
([a2125f7](a2125f7))
* Try e2e cli timeout bump
([#2210](#2210))
([a039fdd](a039fdd))
* Try workaround sample dapp ci timeout
([#2208](#2208))
([e39f6bf](e39f6bf))


### Miscellaneous

* Add a Nargo workspace in `noir-contracts`
([#2083](#2083))
([728a79c](728a79c))
* Add debugging to run_tests
([#2212](#2212))
([1c5e78a](1c5e78a))
* **aztec-noir:** Rename noir-aztec to aztec-noir
([#2071](#2071))
([e1e14d2](e1e14d2))
* **circuits:** Merge and root rollup cbind msgpack
([#2192](#2192))
([4f3ecee](4f3ecee))
* **noir-contracts:** 1655 - rename functions to make hack clearer for
publicly created notes
([#2230](#2230))
([707bc09](707bc09))
* Run the test for zero division with mul div up
([#2206](#2206))
([747de6a](747de6a))
* Update url for acir artifacts
([#2231](#2231))
([5e0abd3](5e0abd3))
* Use workspace build with `nargo compile --workspace`
([#2266](#2266))
([9ab66a0](9ab66a0))


### Documentation

* Dapp tutorial
([#2109](#2109))
([573dbc2](573dbc2)),
closes
[#2051](#2051)
* Minor fixes to dapp tutorial
([#2203](#2203))
([dcc927c](dcc927c))
</details>

<details><summary>barretenberg.js: 0.7.0</summary>

##
[0.7.0](barretenberg.js-v0.6.7...barretenberg.js-v0.7.0)
(2023-09-13)


### Bug Fixes

* Add cjs-entry to bbjs package files
([#2237](#2237))
([ae16193](ae16193))


### Miscellaneous

* Add debugging to run_tests
([#2212](#2212))
([1c5e78a](1c5e78a))
</details>

<details><summary>barretenberg: 0.7.0</summary>

##
[0.7.0](barretenberg-v0.6.7...barretenberg-v0.7.0)
(2023-09-13)


### ⚠ BREAKING CHANGES

* **aztec-noir:** rename noir-aztec to aztec-noir
([#2071](#2071))

### Features

* **build:** Use LTS version of ubuntu
([#2239](#2239))
([ce6671e](ce6671e))


### Bug Fixes

* **build:** Update ubuntu version used in Docker builds
([#2236](#2236))
([dbe80b7](dbe80b7))
* Format barretenberg
([#2209](#2209))
([0801372](0801372))
* Msgpack blowup with bigger objects
([#2207](#2207))
([b909937](b909937))
* Refactor constraints in scalar mul to use the high limb
([#2161](#2161))
([1d0e25d](1d0e25d))


### Miscellaneous

* Add debugging to run_tests
([#2212](#2212))
([1c5e78a](1c5e78a))
* **aztec-noir:** Rename noir-aztec to aztec-noir
([#2071](#2071))
([e1e14d2](e1e14d2))
* Update url for acir artifacts
([#2231](#2231))
([5e0abd3](5e0abd3))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this issue Sep 13, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.7.0</summary>

##
[0.7.0](AztecProtocol/aztec-packages@aztec-packages-v0.6.7...aztec-packages-v0.7.0)
(2023-09-13)


### ⚠ BREAKING CHANGES

* **aztec-noir:** rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))

### Features

* **build:** Use LTS version of ubuntu
([#2239](AztecProtocol/aztec-packages#2239))
([ce6671e](AztecProtocol/aztec-packages@ce6671e))
* **ci:** Run nargo test in ci on all packages
([#2197](AztecProtocol/aztec-packages#2197))
([cca55f2](AztecProtocol/aztec-packages@cca55f2))
* **cli:** Add commands for generating ts and nr interfaces
([#2241](AztecProtocol/aztec-packages#2241))
([c11b70d](AztecProtocol/aztec-packages@c11b70d)),
closes
[#2183](AztecProtocol/aztec-packages#2183)
* **cli:** Inspect contract command
([#2248](AztecProtocol/aztec-packages#2248))
([381706e](AztecProtocol/aztec-packages@381706e)),
closes
[#2180](AztecProtocol/aztec-packages#2180)
* Define specific Sandbox version when running docker-compose up
([#2238](AztecProtocol/aztec-packages#2238))
([71da236](AztecProtocol/aztec-packages@71da236))
* **docs:** Updated docs explaining Sandbox accounts
([#2235](AztecProtocol/aztec-packages#2235))
([f560066](AztecProtocol/aztec-packages@f560066))
* Optimise sandbox startup time by only initialising the BB solver once.
([#2240](AztecProtocol/aztec-packages#2240))
([e9cac9c](AztecProtocol/aztec-packages@e9cac9c))
* Remove entrypoint collection
([#2148](AztecProtocol/aztec-packages#2148))
([e97c94d](AztecProtocol/aztec-packages@e97c94d))
* Validate nargo version against expected one
([#2254](AztecProtocol/aztec-packages#2254))
([011c0b7](AztecProtocol/aztec-packages@011c0b7))


### Bug Fixes

* Add cjs-entry to bbjs package files
([#2237](AztecProtocol/aztec-packages#2237))
([ae16193](AztecProtocol/aztec-packages@ae16193))
* Add link to example contracts in the monorepo
([#2219](AztecProtocol/aztec-packages#2219))
([8aede54](AztecProtocol/aztec-packages@8aede54))
* **build:** Update ubuntu version used in Docker builds
([#2236](AztecProtocol/aztec-packages#2236))
([dbe80b7](AztecProtocol/aztec-packages@dbe80b7))
* **docs:** Use code snippet macros in bridge docs
([#2205](AztecProtocol/aztec-packages#2205))
([0c3a627](AztecProtocol/aztec-packages@0c3a627))
* Format barretenberg
([#2209](AztecProtocol/aztec-packages#2209))
([0801372](AztecProtocol/aztec-packages@0801372))
* Msgpack blowup with bigger objects
([#2207](AztecProtocol/aztec-packages#2207))
([b909937](AztecProtocol/aztec-packages@b909937))
* Refactor constraints in scalar mul to use the high limb
([#2161](AztecProtocol/aztec-packages#2161))
([1d0e25d](AztecProtocol/aztec-packages@1d0e25d))
* Reinstate v stripping in build
([#2220](AztecProtocol/aztec-packages#2220))
([13d34f5](AztecProtocol/aztec-packages@13d34f5))
* Return partial witnesses based on the content of read requests.
([#2164](AztecProtocol/aztec-packages#2164))
([a2125f7](AztecProtocol/aztec-packages@a2125f7))
* Try e2e cli timeout bump
([#2210](AztecProtocol/aztec-packages#2210))
([a039fdd](AztecProtocol/aztec-packages@a039fdd))
* Try workaround sample dapp ci timeout
([#2208](AztecProtocol/aztec-packages#2208))
([e39f6bf](AztecProtocol/aztec-packages@e39f6bf))


### Miscellaneous

* Add a Nargo workspace in `noir-contracts`
([#2083](AztecProtocol/aztec-packages#2083))
([728a79c](AztecProtocol/aztec-packages@728a79c))
* Add debugging to run_tests
([#2212](AztecProtocol/aztec-packages#2212))
([1c5e78a](AztecProtocol/aztec-packages@1c5e78a))
* **aztec-noir:** Rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))
([e1e14d2](AztecProtocol/aztec-packages@e1e14d2))
* **circuits:** Merge and root rollup cbind msgpack
([#2192](AztecProtocol/aztec-packages#2192))
([4f3ecee](AztecProtocol/aztec-packages@4f3ecee))
* **noir-contracts:** 1655 - rename functions to make hack clearer for
publicly created notes
([#2230](AztecProtocol/aztec-packages#2230))
([707bc09](AztecProtocol/aztec-packages@707bc09))
* Run the test for zero division with mul div up
([#2206](AztecProtocol/aztec-packages#2206))
([747de6a](AztecProtocol/aztec-packages@747de6a))
* Update url for acir artifacts
([#2231](AztecProtocol/aztec-packages#2231))
([5e0abd3](AztecProtocol/aztec-packages@5e0abd3))
* Use workspace build with `nargo compile --workspace`
([#2266](AztecProtocol/aztec-packages#2266))
([9ab66a0](AztecProtocol/aztec-packages@9ab66a0))


### Documentation

* Dapp tutorial
([#2109](AztecProtocol/aztec-packages#2109))
([573dbc2](AztecProtocol/aztec-packages@573dbc2)),
closes
[#2051](AztecProtocol/aztec-packages#2051)
* Minor fixes to dapp tutorial
([#2203](AztecProtocol/aztec-packages#2203))
([dcc927c](AztecProtocol/aztec-packages@dcc927c))
</details>

<details><summary>barretenberg.js: 0.7.0</summary>

##
[0.7.0](AztecProtocol/aztec-packages@barretenberg.js-v0.6.7...barretenberg.js-v0.7.0)
(2023-09-13)


### Bug Fixes

* Add cjs-entry to bbjs package files
([#2237](AztecProtocol/aztec-packages#2237))
([ae16193](AztecProtocol/aztec-packages@ae16193))


### Miscellaneous

* Add debugging to run_tests
([#2212](AztecProtocol/aztec-packages#2212))
([1c5e78a](AztecProtocol/aztec-packages@1c5e78a))
</details>

<details><summary>barretenberg: 0.7.0</summary>

##
[0.7.0](AztecProtocol/aztec-packages@barretenberg-v0.6.7...barretenberg-v0.7.0)
(2023-09-13)


### ⚠ BREAKING CHANGES

* **aztec-noir:** rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))

### Features

* **build:** Use LTS version of ubuntu
([#2239](AztecProtocol/aztec-packages#2239))
([ce6671e](AztecProtocol/aztec-packages@ce6671e))


### Bug Fixes

* **build:** Update ubuntu version used in Docker builds
([#2236](AztecProtocol/aztec-packages#2236))
([dbe80b7](AztecProtocol/aztec-packages@dbe80b7))
* Format barretenberg
([#2209](AztecProtocol/aztec-packages#2209))
([0801372](AztecProtocol/aztec-packages@0801372))
* Msgpack blowup with bigger objects
([#2207](AztecProtocol/aztec-packages#2207))
([b909937](AztecProtocol/aztec-packages@b909937))
* Refactor constraints in scalar mul to use the high limb
([#2161](AztecProtocol/aztec-packages#2161))
([1d0e25d](AztecProtocol/aztec-packages@1d0e25d))


### Miscellaneous

* Add debugging to run_tests
([#2212](AztecProtocol/aztec-packages#2212))
([1c5e78a](AztecProtocol/aztec-packages@1c5e78a))
* **aztec-noir:** Rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))
([e1e14d2](AztecProtocol/aztec-packages@e1e14d2))
* Update url for acir artifacts
([#2231](AztecProtocol/aztec-packages#2231))
([5e0abd3](AztecProtocol/aztec-packages@5e0abd3))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/build-system that referenced this issue Sep 14, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.7.0</summary>

##
[0.7.0](AztecProtocol/aztec-packages@aztec-packages-v0.6.7...aztec-packages-v0.7.0)
(2023-09-13)


### ⚠ BREAKING CHANGES

* **aztec-noir:** rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))

### Features

* **build:** Use LTS version of ubuntu
([#2239](AztecProtocol/aztec-packages#2239))
([ce6671e](AztecProtocol/aztec-packages@ce6671e))
* **ci:** Run nargo test in ci on all packages
([#2197](AztecProtocol/aztec-packages#2197))
([cca55f2](AztecProtocol/aztec-packages@cca55f2))
* **cli:** Add commands for generating ts and nr interfaces
([#2241](AztecProtocol/aztec-packages#2241))
([c11b70d](AztecProtocol/aztec-packages@c11b70d)),
closes
[#2183](AztecProtocol/aztec-packages#2183)
* **cli:** Inspect contract command
([#2248](AztecProtocol/aztec-packages#2248))
([381706e](AztecProtocol/aztec-packages@381706e)),
closes
[#2180](AztecProtocol/aztec-packages#2180)
* Define specific Sandbox version when running docker-compose up
([#2238](AztecProtocol/aztec-packages#2238))
([71da236](AztecProtocol/aztec-packages@71da236))
* **docs:** Updated docs explaining Sandbox accounts
([#2235](AztecProtocol/aztec-packages#2235))
([f560066](AztecProtocol/aztec-packages@f560066))
* Optimise sandbox startup time by only initialising the BB solver once.
([#2240](AztecProtocol/aztec-packages#2240))
([e9cac9c](AztecProtocol/aztec-packages@e9cac9c))
* Remove entrypoint collection
([#2148](AztecProtocol/aztec-packages#2148))
([e97c94d](AztecProtocol/aztec-packages@e97c94d))
* Validate nargo version against expected one
([#2254](AztecProtocol/aztec-packages#2254))
([011c0b7](AztecProtocol/aztec-packages@011c0b7))


### Bug Fixes

* Add cjs-entry to bbjs package files
([#2237](AztecProtocol/aztec-packages#2237))
([ae16193](AztecProtocol/aztec-packages@ae16193))
* Add link to example contracts in the monorepo
([#2219](AztecProtocol/aztec-packages#2219))
([8aede54](AztecProtocol/aztec-packages@8aede54))
* **build:** Update ubuntu version used in Docker builds
([#2236](AztecProtocol/aztec-packages#2236))
([dbe80b7](AztecProtocol/aztec-packages@dbe80b7))
* **docs:** Use code snippet macros in bridge docs
([#2205](AztecProtocol/aztec-packages#2205))
([0c3a627](AztecProtocol/aztec-packages@0c3a627))
* Format barretenberg
([#2209](AztecProtocol/aztec-packages#2209))
([0801372](AztecProtocol/aztec-packages@0801372))
* Msgpack blowup with bigger objects
([#2207](AztecProtocol/aztec-packages#2207))
([b909937](AztecProtocol/aztec-packages@b909937))
* Refactor constraints in scalar mul to use the high limb
([#2161](AztecProtocol/aztec-packages#2161))
([1d0e25d](AztecProtocol/aztec-packages@1d0e25d))
* Reinstate v stripping in build
([#2220](AztecProtocol/aztec-packages#2220))
([13d34f5](AztecProtocol/aztec-packages@13d34f5))
* Return partial witnesses based on the content of read requests.
([#2164](AztecProtocol/aztec-packages#2164))
([a2125f7](AztecProtocol/aztec-packages@a2125f7))
* Try e2e cli timeout bump
([#2210](AztecProtocol/aztec-packages#2210))
([a039fdd](AztecProtocol/aztec-packages@a039fdd))
* Try workaround sample dapp ci timeout
([#2208](AztecProtocol/aztec-packages#2208))
([e39f6bf](AztecProtocol/aztec-packages@e39f6bf))


### Miscellaneous

* Add a Nargo workspace in `noir-contracts`
([#2083](AztecProtocol/aztec-packages#2083))
([728a79c](AztecProtocol/aztec-packages@728a79c))
* Add debugging to run_tests
([#2212](AztecProtocol/aztec-packages#2212))
([1c5e78a](AztecProtocol/aztec-packages@1c5e78a))
* **aztec-noir:** Rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))
([e1e14d2](AztecProtocol/aztec-packages@e1e14d2))
* **circuits:** Merge and root rollup cbind msgpack
([#2192](AztecProtocol/aztec-packages#2192))
([4f3ecee](AztecProtocol/aztec-packages@4f3ecee))
* **noir-contracts:** 1655 - rename functions to make hack clearer for
publicly created notes
([#2230](AztecProtocol/aztec-packages#2230))
([707bc09](AztecProtocol/aztec-packages@707bc09))
* Run the test for zero division with mul div up
([#2206](AztecProtocol/aztec-packages#2206))
([747de6a](AztecProtocol/aztec-packages@747de6a))
* Update url for acir artifacts
([#2231](AztecProtocol/aztec-packages#2231))
([5e0abd3](AztecProtocol/aztec-packages@5e0abd3))
* Use workspace build with `nargo compile --workspace`
([#2266](AztecProtocol/aztec-packages#2266))
([9ab66a0](AztecProtocol/aztec-packages@9ab66a0))


### Documentation

* Dapp tutorial
([#2109](AztecProtocol/aztec-packages#2109))
([573dbc2](AztecProtocol/aztec-packages@573dbc2)),
closes
[#2051](AztecProtocol/aztec-packages#2051)
* Minor fixes to dapp tutorial
([#2203](AztecProtocol/aztec-packages#2203))
([dcc927c](AztecProtocol/aztec-packages@dcc927c))
</details>

<details><summary>barretenberg.js: 0.7.0</summary>

##
[0.7.0](AztecProtocol/aztec-packages@barretenberg.js-v0.6.7...barretenberg.js-v0.7.0)
(2023-09-13)


### Bug Fixes

* Add cjs-entry to bbjs package files
([#2237](AztecProtocol/aztec-packages#2237))
([ae16193](AztecProtocol/aztec-packages@ae16193))


### Miscellaneous

* Add debugging to run_tests
([#2212](AztecProtocol/aztec-packages#2212))
([1c5e78a](AztecProtocol/aztec-packages@1c5e78a))
</details>

<details><summary>barretenberg: 0.7.0</summary>

##
[0.7.0](AztecProtocol/aztec-packages@barretenberg-v0.6.7...barretenberg-v0.7.0)
(2023-09-13)


### ⚠ BREAKING CHANGES

* **aztec-noir:** rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))

### Features

* **build:** Use LTS version of ubuntu
([#2239](AztecProtocol/aztec-packages#2239))
([ce6671e](AztecProtocol/aztec-packages@ce6671e))


### Bug Fixes

* **build:** Update ubuntu version used in Docker builds
([#2236](AztecProtocol/aztec-packages#2236))
([dbe80b7](AztecProtocol/aztec-packages@dbe80b7))
* Format barretenberg
([#2209](AztecProtocol/aztec-packages#2209))
([0801372](AztecProtocol/aztec-packages@0801372))
* Msgpack blowup with bigger objects
([#2207](AztecProtocol/aztec-packages#2207))
([b909937](AztecProtocol/aztec-packages@b909937))
* Refactor constraints in scalar mul to use the high limb
([#2161](AztecProtocol/aztec-packages#2161))
([1d0e25d](AztecProtocol/aztec-packages@1d0e25d))


### Miscellaneous

* Add debugging to run_tests
([#2212](AztecProtocol/aztec-packages#2212))
([1c5e78a](AztecProtocol/aztec-packages@1c5e78a))
* **aztec-noir:** Rename noir-aztec to aztec-noir
([#2071](AztecProtocol/aztec-packages#2071))
([e1e14d2](AztecProtocol/aztec-packages@e1e14d2))
* Update url for acir artifacts
([#2231](AztecProtocol/aztec-packages#2231))
([5e0abd3](AztecProtocol/aztec-packages@5e0abd3))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
1 participant