Skip to content

Update Stylus exporting-abi CLI usage #3386

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.

Sign up for GitHub

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

Closed
anegg0 wants to merge 1 commit into from
Closed

Update Stylus exporting-abi CLI usage #3386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 21 additions & 62 deletions docs/stylus/how-tos/exporting-abi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ interface IMyContract {

function setValue(uint256 new_value) external;

error Unauthorized(address caller);
error Unauthorized(address);
}
```

Expand All @@ -91,39 +91,16 @@ Generate JSON format ABI (requires `solc` installed):
cargo stylus export-abi --json > abi.json
```

Output:
The JSON output is produced by `solc`, so it includes `solc`'s header lines before the ABI array:

```json
[
{
"type": "function",
"name": "getValue",
"inputs": [],
"outputs": [
{
"name": "",
"type": "uint256",
"internalType": "uint256"
}
],
"stateMutability": "view"
},
{
"type": "function",
"name": "setValue",
"inputs": [
{
"name": "new_value",
"type": "uint256",
"internalType": "uint256"
}
],
"outputs": [],
"stateMutability": "nonpayable"
}
]
```
======= <stdin>:IMyContract =======
Contract JSON ABI
[{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"Unauthorized","type":"error"},{"inputs":[],"name":"getValue","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"new_value","type":"uint256"}],"name":"setValue","outputs":[],"stateMutability":"nonpayable","type":"function"}]
```

Strip the two header lines before feeding the array to front-end tooling.

## Writing ABI-compatible contracts

### Basic contract structure
Expand Down Expand Up @@ -281,14 +258,14 @@ impl Token {
}
```

Generated interface includes errors:
Generated interface includes errors. Note that the exported Solidity drops the error parameter names, keeping only their types:

```solidity
interface IToken {
function transfer(address to, uint256 amount) external;

error InsufficientBalance(address account, uint256 requested, uint256 available);
error Unauthorized(address caller);
error InsufficientBalance(address, uint256, uint256);
error Unauthorized(address);
error InvalidAmount();
}
```
Expand Down Expand Up @@ -444,10 +421,10 @@ impl MyContract {
}
```

Export constructor signature:
Export constructor signature with the top-level `constructor` command (the constructor is not part of `export-abi` output):

```shell
cargo stylus export-abi constructor
cargo stylus constructor
```

Output:
Expand Down Expand Up @@ -478,29 +455,6 @@ constructor(address owner) payable

## Export configuration

### Custom license

Specify a custom SPDX license identifier:

```shell
cargo stylus export-abi --license=GPL-3.0
```

Output includes:

```solidity
// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8.23;
```

### Custom pragma

Specify a custom Solidity version pragma:

```shell
cargo stylus export-abi --pragma="pragma solidity ^0.8.20;"
```

### Rust features

Export ABI with specific Rust features enabled:
Expand Down Expand Up @@ -795,7 +749,7 @@ cp abi.json ../frontend/src/abis/
When adding or modifying constructors, regenerate and commit:

```shell
cargo stylus export-abi constructor > CONSTRUCTOR.txt
cargo stylus constructor > CONSTRUCTOR.txt
git add CONSTRUCTOR.txt
git commit -m "Update constructor signature"
```
Expand Down Expand Up @@ -958,11 +912,16 @@ impl AbiType for MyType {

Export ABIs for all contracts in a workspace:

The `--contract` value is a cargo package name. Repeat the flag to select several contracts; with no `--contract`, the workspace's default contracts are exported.

```shell
# Export specific contract
# Export specific contract by package name
cargo stylus export-abi --contract=my-token

# Export all contracts
# Select several contracts in one invocation
cargo stylus export-abi --contract=token --contract=staking

# Export each to its own file
for contract in token staking governance; do
cargo stylus export-abi --contract=$contract > interfaces/I${contract^}.sol
done
Expand Down
Loading