Skip to content

Replace id field with prefix, fix typo #48

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

Merged
merged 1 commit into from
Sep 29, 2025
+14 −14
Merged

Replace id field with prefix, fix typo #48

Show file tree
Hide file tree
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
22 changes: 11 additions & 11 deletions content/contracts-compact/api/access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ None.
circuitSig="hasRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>) → Boolean"
kind="circuit"
complexity="k=10, rows=487"
id="AccessControl-_operatorRoles"
modulePrefix="AccessControl"
>
Returns `true` if `account` has been granted `roleId`.
</APIItemCompact>
Expand All @@ -115,7 +115,7 @@ None.
circuitSig="assertOnlyRole(roleId: Bytes<32>) → []"
kind="circuit"
complexity="k=10, rows=345"
id="AccessControl-assertOnlyRole"
modulePrefix="AccessControl"
>
Reverts if caller is missing `roleId`.

Expand All @@ -131,7 +131,7 @@ None.
circuitSig="_checkRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>) → []"
kind="circuit"
complexity="k=10, rows=467"
id="AccessControl-_checkRole"
modulePrefix="AccessControl"
>
Reverts if `account` is missing `roleId`.

Expand All @@ -146,7 +146,7 @@ None.
circuitSig="getRoleAdmin(roleId: Bytes<32>) → Bytes<32>"
kind="circuit"
complexity="k=10, rows=207"
id="AccessControl-getRoleAdmin"
modulePrefix="AccessControl"
>
Returns the admin role that controls `roleId` or a byte array with all zero bytes if `roleId` doesn’t exist.
See [grantRole](#AccessControl-grantRole) and [revokeRole](#AccessControl-revokeRole).
Expand All @@ -160,7 +160,7 @@ None.
circuitSig="grantRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>) → []"
kind="circuit"
complexity="k=10, rows=994"
id="AccessControl-grantRole"
modulePrefix="AccessControl"
>
Grants `roleId` to `account`.

Expand All @@ -181,7 +181,7 @@ None.
circuitSig="revokeRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>) → []"
kind="circuit"
complexity="k=10, rows=827"
id="AccessControl-revokeRole"
modulePrefix="AccessControl"
>
Revokes `roleId` from `account`.

Expand All @@ -197,7 +197,7 @@ None.
stackParams="true"
kind="circuit"
complexity="k=10, rows=640"
id="AccessControl-renounceRole"
modulePrefix="AccessControl"
>
Revokes `roleId` from the calling account.

Expand All @@ -222,7 +222,7 @@ None.
circuitSig="_setRoleAdmin(roleId: Bytes<32>, adminRole: Bytes<32>) → []"
kind="circuit"
complexity="k=10, rows=209"
id="AccessControl-_setRoleAdmin"
modulePrefix="AccessControl"
>
Sets `adminRole` as `roleId`’s admin role.
</APIItemCompact>
Expand All @@ -233,7 +233,7 @@ None.
circuitSig="_grantRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>) → Boolean"
kind="circuit"
complexity="k=10, rows=734"
id="AccessControl-_grantRole"
modulePrefix="AccessControl"
>
Attempts to grant `roleId` to `account` and returns a boolean indicating if `roleId` was granted.

Expand All @@ -256,7 +256,7 @@ None.
kind="circuit"
complexity="k=10, rows=733"
stackParams="true"
id="AccessControl-_unsafeGrantRole"
modulePrefix="AccessControl"
>
Unsafe variant of [_grantRole](#AccessControl-_grantRole).

Expand All @@ -273,7 +273,7 @@ None.
circuitSig="_revokeRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>) → Boolean"
kind="circuit"
complexity="k=10, rows=563"
id="AccessControl-_revokeRole"
modulePrefix="AccessControl"
>
Attempts to revoke `roleId` from `account` and returns a boolean indicating if `roleId` was revoked.

Expand Down
2 changes: 1 addition & 1 deletion content/contracts-compact/api/fungibleToken.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ None.
modulePrefix="FungibleToken"
>
Moves `value` tokens from `from` to `to` using the allowance mechanism.
`value` is the deducted from the caller’s allowance.
`value` is then deducted from the caller’s allowance.

<Callout type='info'>
Transfers to contract addresses are currently disallowed until contract-to-contract interactions are supported in Compact.
Expand Down
2 changes: 1 addition & 1 deletion content/contracts-compact/api/nonFungibleToken.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ import "./node-modules/@openzeppelin-compact/contracts/src/token/NonFungibleToke
<APIItemCompact
circuitSig='_balances: Map<Either<ZswapCoinPublicKey, ContractAddress>, Uint<128>>'
kind="ledger"
id="_balances"
id="NonFungibleToken-_balances"
>
Mapping from account addresses to their token balances.
</APIItemCompact>
Expand Down
2 changes: 1 addition & 1 deletion content/contracts-compact/api/ownable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ None.
circuitSig='initialize(initialOwner: Either<ZswapCoinPublicKey, ContractAddress>) → []'
kind="circuit"
complexity="k=10, rows=258"
id="Ownable-initialize"
modulePrefix="Ownable"
>
Initializes the contract by setting the `initialOwner`.
This must be called in the contract’s constructor.
Expand Down