Skip to content

Commit 27bdb36

Browse files
committed
chore: updated API reference with release-v3.x
1 parent 3ebf036 commit 27bdb36

File tree

7 files changed

+2603
-410
lines changed

7 files changed

+2603
-410
lines changed

content/confidential-contracts/api/finance.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For convenience, this directory also includes:
2323

2424
## `ERC7821WithExecutor`
2525

26-
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/v0.2.0/contracts/finance/ERC7821WithExecutor.sol">
26+
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/release-v0.3.0/contracts/finance/ERC7821WithExecutor.sol">
2727
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-github-icon lucide-github"><path d="M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"/><path d="M9 18c-4.51 2-5-2-7-2"/></svg>
2828
</a>
2929

@@ -145,7 +145,7 @@ function _erc7821AuthorizedExecutor(
145145

146146
## `VestingWalletCliffConfidential`
147147

148-
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/v0.2.0/contracts/finance/VestingWalletCliffConfidential.sol">
148+
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/release-v0.3.0/contracts/finance/VestingWalletCliffConfidential.sol">
149149
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-github-icon lucide-github"><path d="M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"/><path d="M9 18c-4.51 2-5-2-7-2"/></svg>
150150
</a>
151151

@@ -328,7 +328,7 @@ The specified cliff duration is larger than the vesting duration.
328328

329329
## `VestingWalletConfidential`
330330

331-
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/v0.2.0/contracts/finance/VestingWalletConfidential.sol">
331+
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/release-v0.3.0/contracts/finance/VestingWalletConfidential.sol">
332332
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-github-icon lucide-github"><path d="M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"/><path d="M9 18c-4.51 2-5-2-7-2"/></svg>
333333
</a>
334334

@@ -338,7 +338,7 @@ The specified cliff duration is larger than the vesting duration.
338338
import "@openzeppelin/confidential-contracts/finance/VestingWalletConfidential.sol";
339339
```
340340

341-
A vesting wallet is an ownable contract that can receive ConfidentialFungibleTokens, and release these
341+
A vesting wallet is an ownable contract that can receive ERC7984 tokens, and release these
342342
assets to the wallet owner, also referred to as "beneficiary", according to a vesting schedule.
343343

344344
Any assets transferred to this contract will follow the vesting schedule as if they were locked from the beginning.
@@ -506,7 +506,7 @@ Amount of token already released
506506
<div className="px-4">
507507

508508
Getter for the amount of releasable `token` tokens. `token` should be the address of an
509-
[`IConfidentialFungibleToken`](./interfaces#IConfidentialFungibleToken) contract.
509+
[`IERC7984`](/confidential-contracts/api/interfaces#IERC7984) contract.
510510

511511
</div>
512512
</div>
@@ -622,7 +622,7 @@ Emitted when releasable vested tokens are released.
622622

623623
## `VestingWalletConfidentialFactory`
624624

625-
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/v0.2.0/contracts/finance/VestingWalletConfidentialFactory.sol">
625+
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/release-v0.3.0/contracts/finance/VestingWalletConfidentialFactory.sol">
626626
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-github-icon lucide-github"><path d="M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"/><path d="M9 18c-4.51 2-5-2-7-2"/></svg>
627627
</a>
628628

@@ -641,7 +641,7 @@ functions remain unimplemented to allow for custom implementations of the vestin
641641
<h3 style={{ marginTop: "0"}}>Functions</h3>
642642
<div className="font-mono">
643643
- [constructor()](#VestingWalletConfidentialFactory-constructor--)
644-
- [batchFundVestingWalletConfidential(confidentialFungibleToken, vestingPlans, inputProof)](#VestingWalletConfidentialFactory-batchFundVestingWalletConfidential-address-struct-VestingWalletConfidentialFactory-VestingPlan---bytes-)
644+
- [batchFundVestingWalletConfidential(token, vestingPlans, inputProof)](#VestingWalletConfidentialFactory-batchFundVestingWalletConfidential-address-struct-VestingWalletConfidentialFactory-VestingPlan---bytes-)
645645
- [createVestingWalletConfidential(initArgs)](#VestingWalletConfidentialFactory-createVestingWalletConfidential-bytes-)
646646
- [predictVestingWalletConfidential(initArgs)](#VestingWalletConfidentialFactory-predictVestingWalletConfidential-bytes-)
647647
- [_validateVestingWalletInitArgs(initArgs)](#VestingWalletConfidentialFactory-_validateVestingWalletInitArgs-bytes-)
@@ -654,7 +654,7 @@ functions remain unimplemented to allow for custom implementations of the vestin
654654
<div className="bg-secondary p-4 rounded-md mb-6">
655655
<h3 style={{ marginTop: "0"}}>Events</h3>
656656
<div className="font-mono">
657-
- [VestingWalletConfidentialFunded(vestingWalletConfidential, confidentialFungibleToken, transferredAmount, initArgs)](#VestingWalletConfidentialFactory-VestingWalletConfidentialFunded-address-address-euint64-bytes-)
657+
- [VestingWalletConfidentialFunded(vestingWalletConfidential, token, transferredAmount, initArgs)](#VestingWalletConfidentialFactory-VestingWalletConfidentialFunded-address-address-euint64-bytes-)
658658
- [VestingWalletConfidentialCreated(vestingWalletConfidential, initArgs)](#VestingWalletConfidentialFactory-VestingWalletConfidentialCreated-address-bytes-)
659659
</div>
660660
</div>
@@ -678,7 +678,7 @@ functions remain unimplemented to allow for custom implementations of the vestin
678678

679679
<div className="border rounded-md mb-4">
680680
<div className="bg-secondary flex w-full justify-between px-4">
681-
<p className="font-bold text-sm font-mono">batchFundVestingWalletConfidential(address confidentialFungibleToken, struct VestingWalletConfidentialFactory.VestingPlan[] vestingPlans, bytes inputProof)</p>
681+
<p className="font-bold text-sm font-mono">batchFundVestingWalletConfidential(address token, struct VestingWalletConfidentialFactory.VestingPlan[] vestingPlans, bytes inputProof)</p>
682682
<div className="flex flex-row items-center gap-2">
683683
<p className="font-light text-sm">public</p>
684684
<a className="peer" data-card href="VestingWalletConfidentialFactory-batchFundVestingWalletConfidential-address-struct-VestingWalletConfidentialFactory-VestingPlan---bytes-">#</a>
@@ -806,7 +806,7 @@ Gets create2 salt for a confidential vesting wallet.
806806

807807
<div className="border rounded-md mb-4">
808808
<div className="bg-secondary flex w-full justify-between px-4">
809-
<p className="font-bold text-sm font-mono">VestingWalletConfidentialFunded(address indexed vestingWalletConfidential, address indexed confidentialFungibleToken, euint64 transferredAmount, bytes initArgs)</p>
809+
<p className="font-bold text-sm font-mono">VestingWalletConfidentialFunded(address indexed vestingWalletConfidential, address indexed token, euint64 transferredAmount, bytes initArgs)</p>
810810
<div className="flex flex-row items-center gap-2">
811811
<p className="font-light text-sm">event</p>
812812
<a className="peer" data-card href="VestingWalletConfidentialFactory-VestingWalletConfidentialFunded-address-address-euint64-bytes-">#</a>

content/confidential-contracts/api/governance.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This directory includes primitives for on-chain confidential governance.
1616

1717
## `VotesConfidential`
1818

19-
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/v0.2.0/contracts/governance/utils/VotesConfidential.sol">
19+
<a target="_blank" style={{marginTop: "1.5em"}} href="https://github.com/OpenZeppelin/openzeppelin-confidential-contracts/blob/release-v0.3.0/contracts/governance/utils/VotesConfidential.sol">
2020
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-github-icon lucide-github"><path d="M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"/><path d="M9 18c-4.51 2-5-2-7-2"/></svg>
2121
</a>
2222

@@ -33,7 +33,7 @@ This contract keeps a history (checkpoints) of each account's confidential vote
3333
voting power can be delegated either by calling the [`VotesConfidential.delegate`](#VotesConfidential-delegate-address-) function directly, or by providing
3434
a signature to be used with [`VotesConfidential.delegateBySig`](#VotesConfidential-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-). Confidential voting power handles can be queried
3535
through the public accessors [`VotesConfidential.getVotes`](#VotesConfidential-getVotes-address-) and [`VotesConfidential.getPastVotes`](#VotesConfidential-getPastVotes-address-uint256-) but can only be decrypted by accounts
36-
allowed to access them. Ensure that [`HandleAccessManager._validateHandleAllowance`](./utils#HandleAccessManager-_validateHandleAllowance-bytes32-) is implemented properly, allowing all
36+
allowed to access them. Ensure that [`HandleAccessManager._validateHandleAllowance`](/confidential-contracts/api/utils#HandleAccessManager-_validateHandleAllowance-bytes32-) is implemented properly, allowing all
3737
necessary addresses to access voting power handles.
3838

3939
By default, voting units does not account for voting power. This makes transfers of underlying

content/confidential-contracts/api/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Smart contract token utilities and implementations for ERC7984, a confidential t
1212
- **[ERC7984Freezable](./api/token#ERC7984Freezable)** - Extension with freezing mechanism
1313
- **[ERC7984ObserverAccess](./api/token#ERC7984ObserverAccess)** - Extension allowing observers to access transfer amounts
1414
- **[ERC7984Restricted](./api/token#ERC7984Restricted)** - Extension implementing user account transfer restrictions
15-
- **[ERC7984Votes](./api/token#ERC7984Votes)** - Extension supporting confidential votes tracking and delegation
15+
- **[ERC7984Omnibus](./api/token#ERC7984Omnibus)** - Extension for omnibus transfers with encrypted sub-account addresses
16+
- **[ERC7984Rwa](./api/token#ERC7984Rwa)** - Extension supporting confidential Real World Assets with compliance checks
1617
- **[ERC7984Utils](./api/token#ERC7984Utils)** - Utility library for ERC7984 functions
1718

1819
### [Finance](./api/finance)
@@ -33,6 +34,7 @@ Core interfaces for interacting with confidential contracts.
3334

3435
- **[IERC7984](./api/interfaces#IERC7984)** - Interface for confidential fungible token standard
3536
- **[IERC7984Receiver](./api/interfaces#IERC7984Receiver)** - Interface for contracts receiving ERC7984 transfers with callbacks
37+
- **[IERC7984Rwa](./api/interfaces#IERC7984Rwa)** - Interface for confidential RWA contracts
3638

3739
### [Utils](./api/utils)
3840
Miscellaneous contracts and libraries with utility functions for confidential contracts.

0 commit comments

Comments
 (0)