OpenZeppelin

https://docs.openzeppelin.com/
Admin
OpenZeppelin is a library of modular, reusable, secure smart contracts for blockchain development,...
Tokens:715,172
Snippets:8,429
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start with Docker Compose

Source: https://docs.openzeppelin.com/monitor/1.3.x

Launches the application using the configured Docker Compose setup.

```bash
cargo make docker-compose-up
```

--------------------------------

### Docker Setup and Execution

Source: https://docs.openzeppelin.com/monitor

Commands for initializing the environment and starting the service with Docker Compose.

```bash
cp .env.example .env
# Edit .env file with your configuration
```

```bash
cargo make docker-compose-up
```

--------------------------------

### Run the meta-transaction application

Source: https://docs.openzeppelin.com/defender/guide/meta-tx

Commands to navigate to the application directory, install dependencies, and start the development server.

```bash
$ cd app
$ yarn
$ yarn start
```

--------------------------------

### Complete Ownable Integration Example

Source: https://docs.openzeppelin.com/contracts-compact/ownable

A full example demonstrating initialization, ownership queries, transfers, renouncing, and circuit protection.

```compact
// SimpleOwnable.compact

pragma language_version >= 0.21.0;

import CompactStandardLibrary;
import "./node_modules/@openzeppelin/compact-contracts/access/Ownable"
  prefix Ownable_;

/**
 * Set `initialOwner` as the owner of the contract.
 * `initialOwner` should be derived off-chain using computeAccountId(secretKey).
 */
constructor(initialOwner: Either<Bytes<32>, ContractAddress>) {
  Ownable_initialize(initialOwner);
}

/**
 * The current owner of the contract.
 */
export circuit owner(): Either<Bytes<32>, ContractAddress> {
  return Ownable_owner();
}

/**
 * Transfers ownership of the contract.
 * Can only be called by the current owner.
 * `newOwner` should be derived off-chain by the new owner using computeAccountId(secretKey).
 */
export circuit transferOwnership(newOwner: Either<Bytes<32>, ContractAddress>): [] {
  Ownable_transferOwnership(newOwner);
}

/**
 * Leaves the contract without an owner.
 * Can only be called by the current owner.
 * Renouncing ownership means `mySensitiveCircuit` can never be called again.
 */
export circuit renounceOwnership(): [] {
  Ownable_renounceOwnership();
}

/**
 * This is the protected circuit that only the current owner can call.
 */
export circuit mySensitiveCircuit(): [] {
  // Protects the circuit
  Ownable_assertOnlyOwner();

  // Do something
}
```

--------------------------------

### Execute Automated Setup Script

Source: https://docs.openzeppelin.com/monitor/1.3.x/quickstart

Commands to prepare and run the automated setup script.

```bash
chmod +x setup_and_run.sh
```

```bash
./setup_and_run.sh
```

--------------------------------

### Install Channels Plugin

Source: https://docs.openzeppelin.com/relayer/1.5.x/plugins/channels

Install the package using npm or pnpm.

```bash
npm install @openzeppelin/relayer-plugin-channels
# or
pnpm add @openzeppelin/relayer-plugin-channels
```

--------------------------------

### Copy Example Configuration Files

Source: https://docs.openzeppelin.com/monitor/1.3.x

Commands to copy example configuration files for various networks, notifications, and filters into the active configuration directory.

```bash
# EVM Configuration
cp examples/config/monitors/evm_transfer_usdc.json config/monitors/evm_transfer_usdc.json
cp examples/config/networks/ethereum_mainnet.json config/networks/ethereum_mainnet.json

# Stellar Configuration
cp examples/config/monitors/stellar_swap_dex.json config/monitors/stellar_swap_dex.json
cp examples/config/networks/stellar_mainnet.json config/networks/stellar_mainnet.json

# Solana Configuration
cp examples/config/monitors/solana_kamino_deposit.json config/monitors/solana_kamino_deposit.json
cp examples/config/networks/solana_mainnet.json config/networks/solana_mainnet.json

# Notification Configuration
cp examples/config/triggers/slack_notifications.json config/triggers/slack_notifications.json
cp examples/config/triggers/email_notifications.json config/triggers/email_notifications.json

# Filter Configuration
cp examples/config/filters/evm_filter_block_number.sh config/filters/evm_filter_block_number.sh
cp examples/config/filters/stellar_filter_block_number.sh config/filters/stellar_filter_block_number.sh
```

--------------------------------

### CLI Migration Output Example

Source: https://docs.openzeppelin.com/upgrades-plugins/migrate-from-cli

Example output showing the migration of network files and the display of previous compiler settings.

```text
✔ Successfully migrated .openzeppelin/rinkeby.json
✔ Migration data exported to openzeppelin-cli-export.json
✔ Deleting .openzeppelin/project.json

These were your project’s compiler options:

  "compilerSettings": {
    "optimizer": {
      "enabled": false,
      "runs": "200"

  },
  "typechain":
    "enabled": false
  ,
  "manager": "openzeppelin",
  "solcVersion": "0.6.12",
  "artifactsDir": "build/contracts",
  "contractsDir": "contracts"
}
```

--------------------------------

### Install Adapter Dependencies

Source: https://docs.openzeppelin.com/ecosystem-adapters/getting-started

Install the necessary ecosystem adapters and the Vite plugin for your project.

```bash
pnpm add @openzeppelin/adapter-evm @openzeppelin/adapter-stellar @openzeppelin/ui-types
pnpm add -D @openzeppelin/adapters-vite
```

--------------------------------

### Install Foundry Upgrades Library

Source: https://docs.openzeppelin.com/upgrades-plugins/hardhat-upgrades

Install the necessary dependencies for Solidity-based testing in Hardhat.

```bash
$ npm install --save-dev @openzeppelin/foundry-upgrades "github:foundry-rs/forge-std#semver:^1.9.5"
```

--------------------------------

### Install Truffle and Upgrades Plugin

Source: https://docs.openzeppelin.com/upgrades-plugins/migrate-from-cli

Commands to initialize a Truffle project and install the OpenZeppelin Truffle Upgrades plugin.

```bash
$ npm install --save-dev truffle
$ npx truffle init
```

```bash
$ npm install --save-dev @openzeppelin/truffle-upgrades
```

--------------------------------

### Install Ecosystem Adapters

Source: https://docs.openzeppelin.com/ecosystem-adapters/getting-started

Install the required adapter for your target ecosystem along with the shared types package.

```bash
pnpm add @openzeppelin/adapter-evm @openzeppelin/ui-types
```

```bash
pnpm add @openzeppelin/adapter-stellar @openzeppelin/ui-types
```

```bash
pnpm add @openzeppelin/adapter-polkadot @openzeppelin/ui-types
```

--------------------------------

### Install and Build Exported Project

Source: https://docs.openzeppelin.com/ui-builder/exporting-and-history

Run these commands after unzipping the exported project to install dependencies and build the application.

```bash
pnpm install && pnpm build
```

--------------------------------

### Install the Channels Client

Source: https://docs.openzeppelin.com/relayer/1.5.x/guides/stellar-channels-guide

Commands to install the required SDK package using common Node.js package managers.

```bash
npm install @openzeppelin/relayer-plugin-channels
# or
pnpm add @openzeppelin/relayer-plugin-channels
# or
yarn add @openzeppelin/relayer-plugin-channels
```

--------------------------------

### cURL Request Examples

Source: https://docs.openzeppelin.com/relayer/1.3.x/api/getTransactionById

Examples of how to perform a GET request to retrieve a transaction, including an authenticated version.

```bash
curl -X GET "https://docs.openzeppelin.com/api/v1/relayers/string/transactions/string"
```

```bash
curl -X GET "https://docs.openzeppelin.com/api/v1/relayers/string/transactions/string" \  -H "Authorization: Bearer "
```

--------------------------------

### Unpack a Starter Kit

Source: https://docs.openzeppelin.com/contracts/5.x/learn/building-a-dapp

Use the CLI to download and initialize a preconfigured starter project.

```bash
$ oz unpack starter
✓ Kit downloaded and unpacked
```

--------------------------------

### modules(uint256 start, uint256 end)

Source: https://docs.openzeppelin.com/confidential-contracts/api/token

Returns a slice of the list of installed modules using inclusive start and exclusive end indices.

```APIDOC
## modules(uint256 start, uint256 end)

### Description
Returns a slice of the list of modules installed on the token with inclusive start and exclusive end. Use an end value of type(uint256).max to get the entire list of modules.

### Parameters
- **start** (uint256) - Required - The starting index.
- **end** (uint256) - Required - The ending index (exclusive).
```

--------------------------------

### Initialize AccountERC7579

Source: https://docs.openzeppelin.com/contracts/5.x/api/account

Example of initializing a contract that inherits from AccountERC7579 by installing a validator module.

```solidity
contract MyAccountERC7579 is AccountERC7579, Initializable {
  function initializeAccount(address validator, bytes calldata validatorData) public initializer {
    _installModule(MODULE_TYPE_VALIDATOR, validator, validatorData);
  }
}
```

--------------------------------

### Clone and Navigate to Template

Source: https://docs.openzeppelin.com/substrate-runtimes/2.0.2/guides/testing_with_zombienet

Initial setup commands to prepare the environment.

```bash
git clone https://github.com/OpenZeppelin/polkadot-runtime-templates
```

```bash
cd evm-template
```

--------------------------------

### Initialize project directory

Source: https://docs.openzeppelin.com/contracts/5.x/learn/webauthn-smart-accounts

Creates the root directory for the tutorial project and navigates into it.

```shell
mkdir webauthn-tutorial
cd webauthn-tutorial
```

--------------------------------

### Copy Configuration Files

Source: https://docs.openzeppelin.com/monitor/1.3.x/local-evm-testing

Set up the monitor configuration by copying example files.

```bash
cp examples/config/networks/anvil_local.json config/networks/
cp examples/config/monitors/evm_transfer_local.json config/monitors/
cp examples/config/triggers/script_notifications.json config/triggers/
mkdir -p config/triggers/scripts
cp examples/config/triggers/scripts/custom_notification.sh config/triggers/scripts/
```

--------------------------------

### Get Fee Quote Response

Source: https://docs.openzeppelin.com/relayer/1.3.x/guides/stellar-sponsored-transactions-guide

Example response containing fee information in the requested token.

```json
{
  "success": true,
  "data": {
    "fee_in_token_ui": "1.5",
    "fee_in_token": "15000000",
    "conversion_rate": "0.15"
  }
}
```

--------------------------------

### onInstall(bytes initData)

Source: https://docs.openzeppelin.com/community-contracts/api/account

Sets up the module's initial configuration when installed by an account.

```APIDOC
## onInstall(bytes initData)

### Description
Sets up the module's initial configuration when installed by an account. Besides the standard delay and signer configuration, this can also include signer weights.

### Parameters
- **initData** (bytes) - Required - Encoded as `abi.encode(bytes[] signers, uint64 threshold, uint64[] weights)`.
```

--------------------------------

### Quick Start Commands

Source: https://docs.openzeppelin.com/contracts/5.x/learn/building-a-dapp

Commands to initialize the local environment and launch the React application.

```bash
Run your local blockchain:
> ganache-cli --deterministic
Initialize the OpenZeppelin project:
> openzeppelin init app
Go to the client directory:
> cd client
Run the React app:
> npm run start
```

--------------------------------

### CircularBuffer Usage Example

Source: https://docs.openzeppelin.com/contracts/5.x/api/utils

Initialize and use a CircularBuffer within a contract. Ensure setup is called during construction to define the buffer size.

```solidity
contract Example {
    // Add the library methods
    using CircularBuffer for CircularBuffer.Bytes32CircularBuffer;

    // Declare a buffer storage variable
    CircularBuffer.Bytes32CircularBuffer private myBuffer;

    constructor() {
        myBuffer.setup(16); // Initialize the buffer with a non-zero fixed size (e.g., 16)
    }

    function pushValue(bytes32 value) external {
        myBuffer.push(value); // Safe to push because the buffer was initialized in the constructor
    }
}
```

--------------------------------

### Implementing Custom Fees in ERC4626 Vaults

Source: https://docs.openzeppelin.com/contracts-cairo/3.x/erc4626

This example demonstrates a Starknet contract setup that integrates ERC4626 with custom entry and exit fee logic stored in contract state.

```cairo
#[starknet::contract]
#[with_components(./erc20, ERC4626)]
pub mod ERC4626Fees {
    use openzeppelin_interfaces::erc20::{IERC20Dispatcher, IERC20DispatcherTrait};
    use openzeppelin_token::erc20::extensions::erc4626::ERC4626Component::{Fee, FeeConfigTrait};
    use openzeppelin_token::erc20::extensions::erc4626::{
        DefaultConfig, ERC4626DefaultNoLimits, ERC4626SelfAssetsManagement,
    };
    use openzeppelin_token::erc20::{DefaultConfig as ERC20DefaultConfig, ERC20HooksEmptyImpl};
    use openzeppelin_utils::math;
    use openzeppelin_utils::math::Rounding;
    use starknet::ContractAddress;
    use starknet::storage::{StoragePointerReadAccess, StoragePointerWriteAccess};

    const _BASIS_POINT_SCALE: u256 = 10_000;
    const FEE_TRANSFER_FAILED: felt252 = 0x1;

    // ERC4626
    #[abi(embed_v0)]
    impl ERC4626ComponentImpl = ERC4626Component::ERC4626Impl<ContractState>;
    // ERC4626MetadataImpl is a custom impl of IERC20Metadata
    #[abi(embed_v0)]
    impl ERC4626MetadataImpl = ERC4626Component::ERC4626MetadataImpl<ContractState>;

    // ERC20
    #[abi(embed_v0)]
    impl ERC20Impl = ERC20Component::ERC20Impl<ContractState>;
    #[abi(embed_v0)]
    impl ERC20CamelOnlyImpl = ERC20Component::ERC20CamelOnlyImpl<ContractState>;

    #[storage]
    pub struct Storage {
        pub entry_fee_basis_point_value: u256,
        pub entry_fee_recipient: ContractAddress,
        pub exit_fee_basis_point_value: u256,
        pub exit_fee_recipient: ContractAddress,
    }

    #[constructor]
    fn constructor(
        ref self: ContractState,
        name: ByteArray,
        symbol: ByteArray,
        underlying_asset: ContractAddress,
        initial_supply: u256,
        recipient: ContractAddress,
        entry_fee: u256,
        entry_treasury: ContractAddress,
        exit_fee: u256,
        exit_treasury: ContractAddress,
    ) {
        self.erc20.initializer(name, symbol);
        self.erc20.mint(recipient, initial_supply);
        self.erc4626.initializer(underlying_asset);

        self.entry_fee_basis_point_value.write(entry_fee);
        self.entry_fee_recipient.write(entry_treasury);
        self.exit_fee_basis_point_value.write(exit_fee);
        self.exit_fee_recipient.write(exit_treasury);
    }
```

--------------------------------

### Initialize Local Configuration

Source: https://docs.openzeppelin.com/monitor/1.3.x/quickstart

Create a local .env file from the provided example template.

```bash
cp .env.example .env
```

--------------------------------

### Implement a Game Item NFT Contract

Source: https://docs.openzeppelin.com/stellar-contracts/tokens/non-fungible/non-fungible

Example of a contract using the Base NFT variant to track unique game items, including constructor metadata setup and a minting function.

```rust
use soroban_sdk::{contract, contractimpl, Address, Env, String};
use stellar_tokens::non_fungible::{
    burnable::NonFungibleBurnable,
    Base, ContractOverrides, NonFungibleToken,
};

#[contract]
pub struct GameItem;

#[contractimpl]
impl GameItem {
    pub fn __constructor(e: &Env) {
        Base::set_metadata(
            e,
            String::from_str(e, "www.mygame.com"),
            String::from_str(e, "My Game Items Collection"),
            String::from_str(e, "MGMC"),
        );
    }

    pub fn award_item(e: &Env, to: Address) -> u32 {
        // access control might be needed
        Base::sequential_mint(e, &to)
    }
}

#[contractimpl(contracttrait)]
impl NonFungibleToken for GameItem {
    type ContractType = Base;
}

#[contractimpl(contracttrait)]
impl NonFungibleBurnable for GameItem {}
```

--------------------------------

### Build and Verify Application

Source: https://docs.openzeppelin.com/monitor

Compiles the project and verifies the installation using the help command.

```bash
cargo build --release
```

```bash
mv ./target/release/openzeppelin-monitor .
```

```bash
./openzeppelin-monitor --help
```

--------------------------------

### Configuration Reference Example

Source: https://docs.openzeppelin.com/monitor/1.3.x

Demonstrates how to link network slugs and trigger keys within configuration files.

```json
// networks/ethereum_mainnet.json
{
  "slug": "ethereum_mainnet",
  ...
}

// triggers/slack_notifications.json
{
  "large_transfer_slack": {
    ...
  }
}

// monitors/usdc_transfer_monitor.json
{
  "networks": ["ethereum_mainnet"],
  "triggers": ["large_transfer_slack"],
  ...
}
```

--------------------------------

### start()

Source: https://docs.openzeppelin.com/confidential-contracts/api/finance

Returns the timestamp at which the vesting starts.

```APIDOC
## start()

### Description
Returns the timestamp at which the vesting starts.

### Returns
- **uint64** - The start timestamp.
```

--------------------------------

### Initialize Project Directory

Source: https://docs.openzeppelin.com/contracts-compact

Create and enter a new directory for your Compact project.

```bash
mkdir my-project
cd my-project
```

--------------------------------

### Install required dependencies

Source: https://docs.openzeppelin.com/upgrades-plugins/migrate-from-hardhat-2

Install the necessary Hardhat 3 packages for the project.

```bash
npm install --save-dev hardhat @nomicfoundation/hardhat-ethers
```

--------------------------------

### Install Forge Dependencies

Source: https://docs.openzeppelin.com/monitor/1.3.x/local-evm-testing

Install the forge-std library within the contracts directory.

```bash
cd examples/contracts
forge install foundry-rs/forge-std
```

--------------------------------

### Initialize Project Dependencies

Source: https://docs.openzeppelin.com/contracts/5.x/learn/sending-gasless-transactions

Commands to create a new directory and install necessary OpenZeppelin and Ganache dependencies.

```bash
$ mkdir gsn-dapp && cd gsn-dapp
$ npm init -y
$ npm install @openzeppelin/network
$ npm install --save-dev @openzeppelin/gsn-helpers @openzeppelin/contracts-ethereum-package @openzeppelin/upgrades @openzeppelin/cli ganache-cli
```

--------------------------------

### Verify Foundry Installation

Source: https://docs.openzeppelin.com/monitor/1.3.x/local-evm-testing

Check that the Foundry tools are correctly installed and accessible.

```bash
anvil --version
forge --version
cast --version
```

--------------------------------

### Initialize a new project

Source: https://docs.openzeppelin.com/contracts/5.x/learn/setting-up-a-node-project

Create a new directory and initialize it as an npm package.

```bash
$ mkdir learn && cd learn
```

```bash
$ npm init -y
```

--------------------------------

### Install Foundry

Source: https://docs.openzeppelin.com/monitor/1.3.x/local-evm-testing

Install the Foundry toolchain including Anvil, Forge, and Cast.

```bash
curl -L https://foundry.paradigm.xyz | bash
foundryup
```

--------------------------------

### Install Dependencies

Source: https://docs.openzeppelin.com/defender/tutorial/deploy

Installs OpenZeppelin Hardhat Upgrades, contracts, and dotenv packages.

```bash
npm i @openzeppelin/hardhat-upgrades @openzeppelin/contracts-upgradeable dotenv --save-dev
```

--------------------------------

### Set Up Docker Environment

Source: https://docs.openzeppelin.com/monitor/1.3.x

Prepares the environment file for Docker-based deployment.

```bash
cp .env.example .env
# Edit .env file with your configuration
```

--------------------------------

### Verify Scarb Installation

Source: https://docs.openzeppelin.com/contracts-cairo/3.x

Check the installed version of Scarb and Cairo compiler.

```bash
$ scarb --version

scarb 2.13.1 (a76aed7 2025-10-30)
cairo: 2.13.1 (https://crates.io/crates/cairo-lang-compiler/2.13.1)
sierra: 1.7.0
```

--------------------------------

### Initialize Server Project

Source: https://docs.openzeppelin.com/contracts/5.x/learn/webauthn-smart-accounts

Commands to create a Hono server and install required dependencies.

```shell
pnpm create hono@latest server
```

```shell
pnpm install viem
pnpm install -D @types/node
```

--------------------------------

### Packing and Unpacking Example

Source: https://docs.openzeppelin.com/contracts/5.x/api/utils

Demonstrates how to use the library to pack multiple values into a bytes32 and extract them back.

```solidity
library MyPacker {
    type MyType is bytes32;

    function _pack(address account, bytes4 selector, uint64 period) external pure returns (MyType) {
        bytes12 subpack = Packing.pack_4_8(selector, bytes8(period));
        bytes32 pack = Packing.pack_20_12(bytes20(account), subpack);
        return MyType.wrap(pack);
    }

    function _unpack(MyType self) external pure returns (address, bytes4, uint64) {
        bytes32 pack = MyType.unwrap(self);
        return (
            address(Packing.extract_32_20(pack, 0)),
            Packing.extract_32_4(pack, 20),
            uint64(Packing.extract_32_8(pack, 24))
        );
    }
}
```

--------------------------------

### Install Truffle Upgrades plugin

Source: https://docs.openzeppelin.com/upgrades-plugins/truffle-upgrades

Install the package as a development dependency in your Truffle project.

```bash
$ npm install --save-dev @openzeppelin/truffle-upgrades
```

--------------------------------

### Install plugin via NPM

Source: https://docs.openzeppelin.com/upgrades-plugins/foundry/foundry-upgrades

Alternative installation command for the plugin using NPM.

```bash
npm install @openzeppelin/foundry-upgrades
```

--------------------------------

### Verify Installation and View Options

Source: https://docs.openzeppelin.com/monitor/1.3.x

Displays help information and various operational flags for the monitor binary.

```bash
./openzeppelin-monitor --help

# Enable logging to file
./openzeppelin-monitor --log-file

# Enable metrics server
./openzeppelin-monitor --metrics

# Validate configuration files without starting the service
./openzeppelin-monitor --check
```

--------------------------------

### Install Hardhat

Source: https://docs.openzeppelin.com/contracts/5.x/learn/developing-smart-contracts

Install the Hardhat development framework as a development dependency in your project directory.

```bash
npm install --save-dev hardhat
```

--------------------------------

### Initialize Client Project

Source: https://docs.openzeppelin.com/contracts/5.x/learn/webauthn-smart-accounts

Commands to create a new Vite project and install necessary dependencies.

```shell
pnpm create vite@latest client
```

```shell
cd client
pnpm install viem ox
```

--------------------------------

### Initialize Slack Notification Configuration

Source: https://docs.openzeppelin.com/monitor/1.3.x/quickstart

Copy the example Slack configuration file to the active configuration directory.

```bash
# Only necessary if you haven't already run the automated setup script (Option 1: Automated Setup)
cp examples/config/triggers/slack_notifications.json config/triggers/slack_notifications.json
```

--------------------------------

### Relayer API Response Examples

Source: https://docs.openzeppelin.com/relayer/1.2.x/api/createRelayer

Examples of successful and error responses returned by the API.

```json
{
  "data": {
    "address": "string",
    "custom_rpc_urls": [
      {
        "url": "string",
        "weight": 0
      }
    ],
    "disabled_reason": {
      "details": "string",
      "type": "NonceSyncFailed"
    },
    "id": "string",
    "name": "string",
    "network": "string",
    "network_type": "evm",
    "notification_id": "string",
    "paused": true,
    "policies": {
      "eip1559_pricing": true,
      "gas_limit_estimation": true,
      "gas_price_cap": 0,
      "min_balance": 0,
      "private_transactions": true,
      "whitelist_receivers": [
        "string"
      ]
    },
    "signer_id": "string",
    "system_disabled": true
  },
  "error": "string",
  "metadata": {
    "logs": [
      {
        "level": "log",
        "message": "string"
      }
    ],
    "traces": [
      null
    ]
  },
  "pagination": {
    "current_page": 0,
    "per_page": 0,
    "total_items": 0
  },
  "success": true
}
```

```json
{
  "data": null,
  "message": "Bad Request",
  "success": false
}
```

```json
{
  "data": null,
  "message": "Unauthorized",
  "success": false
}
```

```json
{
  "data": null,
  "message": "Relayer with this ID already exists",
  "success": false
}
```

```json
{
  "data": null,
  "message": "Internal Server Error",
  "success": false
}
```

--------------------------------

### Initialize Email Notification Configuration

Source: https://docs.openzeppelin.com/monitor/1.3.x/quickstart

Copy the example email configuration file to the active configuration directory.

```bash
# Only necessary if you haven't already run the automated setup script (Option 1: Automated Setup)
cp examples/config/triggers/email_notifications.json config/triggers/email_notifications.json
```

--------------------------------

### Install Upgrades Plugin Dependencies

Source: https://docs.openzeppelin.com/upgrades-plugins/hardhat-upgrades

Install the plugin and its required peer dependencies via npm.

```bash
$ npm install --save-dev @openzeppelin/hardhat-upgrades
$ npm install --save-dev @nomicfoundation/hardhat-ethers ethers # peer dependencies
```

--------------------------------

### Bootstrap React Application

Source: https://docs.openzeppelin.com/contracts/5.x/learn/sending-gasless-transactions

Initialize a new React project using create-react-app.

```bash
$ npx create-react-app client
```

--------------------------------

### Configure Starter OApp

Source: https://docs.openzeppelin.com/symbiotic/layerzero

Enable or disable the starter OApp deployment in the LayerZero configuration.

```json
{
  "layerzero": {
    "oapp": {
      "enabled": true
    }
  }
}
```

--------------------------------

### Install Hardhat Upgrades Plugin

Source: https://docs.openzeppelin.com/upgrades-plugins/hardhat-2/hardhat-upgrades

Install the plugin and its required peer dependencies via npm.

```bash
$ npm install --save-dev @openzeppelin/hardhat-upgrades@^3.9.1
$ npm install --save-dev @nomicfoundation/hardhat-ethers ethers # peer dependencies
```

--------------------------------

### Install OpenZeppelin Contracts

Source: https://docs.openzeppelin.com/contracts/5.x/learn/webauthn-smart-accounts

Install the required OpenZeppelin contracts library version for WebAuthn support.

```shell
foundry install OpenZeppelin/openzeppelin-contracts@v5.5.0-rc.0
```

--------------------------------

### Initialize Project Dependencies

Source: https://docs.openzeppelin.com/defender/guide/meta-tx

Commands to clone the workshop repository and install necessary dependencies.

```bash
$ git clone https://github.com/openzeppelin/workshops.git
$ cd workshops/25-defender-metatx-api/
$ yarn
```

--------------------------------

### Install hardhat-verify plugin

Source: https://docs.openzeppelin.com/contracts/5.x/learn/preparing-for-mainnet

Install the necessary plugin to enable contract verification via Hardhat.

```bash
npm install --save-dev @nomicfoundation/hardhat-verify
```

--------------------------------

### Clone and install Safe smart account repository

Source: https://docs.openzeppelin.com/defender/guide/private-network

Initializes the environment for Safe contract deployment.

```bash
git clone https://github.com/safe-global/safe-smart-account && cd safe-smart-account && npm install
```

--------------------------------

### Install Uniswap Hooks with Foundry

Source: https://docs.openzeppelin.com/uniswap-hooks

Command to install the library via git submodules in a Foundry project.

```bash
$ forge install OpenZeppelin/uniswap-hooks
```

--------------------------------

### Configure Bulletin Board Monitor

Source: https://docs.openzeppelin.com/monitor/quickstart

Copy the example monitor configuration file to the local config directory.

```bash
cp examples/config/monitors/midnight_testnet_bulletin_post.json config/monitors/midnight_testnet_bulletin_post.json
```

--------------------------------

### Setup and Push to a Merkle Tree

Source: https://docs.openzeppelin.com/contracts/5.x/utilities

Demonstrates initializing a Merkle tree and pushing leaves to it using the default hashing mechanism.

```solidity
using MerkleTree for MerkleTree.Bytes32PushTree;
MerkleTree.Bytes32PushTree private _tree;

function setup(uint8 _depth, bytes32 _zero) public /* onlyOwner */ {
    root = _tree.setup(_depth, _zero);
}

function push(bytes32 leaf) public /* onlyOwner */ {
    (uint256 leafIndex, bytes32 currentRoot) = _tree.push(leaf);
    // Store the new root.
}
```

--------------------------------

### Install Defender SDK

Source: https://docs.openzeppelin.com/defender/sdk

Commands to install the full SDK package or specific subpackages via NPM.

```bash
npm install @openzeppelin/defender-sdk
```

```bash
npm install @openzeppelin/defender-sdk-deploy-client
```

--------------------------------

### Implement Pricing Logic with OpenZeppelin Math

Source: https://docs.openzeppelin.com/contracts-sui/1.x/math

Example demonstrating the use of mul_div and sqrt for swap quoting and geometric mean calculations.

```move
use openzeppelin_math::{rounding};
use openzeppelin_math::u64::{mul_div, sqrt};

const EMathOverflow: u64 = 0;

/// Quote a swap output with a 0.25% fee, rounded to nearest.
public fun quote_with_fee(amount_in: u64, reserve_in: u64, reserve_out: u64): u64 {
    // Apply fee: amount_in * 997.5 / 1000 (approximated as 9975 / 10000)
    let effective_in = mul_div(amount_in, 9975u64, 10000u64, rounding::down())
        .destroy_or!(abort EMathOverflow);

    // Constant-product swap output
    mul_div(reserve_out, effective_in, reserve_in + effective_in, rounding::down())
        .destroy_or!(abort EMathOverflow)
}

/// Geometric mean of two prices, rounded down.
public fun geometric_mean(price_a: u64, price_b: u64): u64 {
    let product = mul_div(price_a, price_b, 1u64, rounding::down())
        .destroy_or!(abort EMathOverflow);
    sqrt(product, rounding::down())
}
```

--------------------------------

### Verify Compact Installation

Source: https://docs.openzeppelin.com/contracts-compact

Check the installed version of the Compact compiler to ensure the environment is correctly configured.

```bash
$ compact compile --version

Compactc version: 0.29.0
0.29.0
```

--------------------------------

### Install OpenZeppelin Contracts via npm

Source: https://docs.openzeppelin.com/contracts/5.x/changelog

Command to install the latest version of the OpenZeppelin Contracts package.

```bash
$ npm install @openzeppelin/contracts@latest
```

--------------------------------

### Shared Directory Setup

Source: https://docs.openzeppelin.com/contracts/5.x/learn/webauthn-smart-accounts

Commands to initialize the shared directory and create the index file.

```bash
cd .. # Move out of contracts
mkdir shared
cd shared
```

```bash
touch index.ts
```

--------------------------------

### Install Hardhat Upgrades Plugin

Source: https://docs.openzeppelin.com/contracts/5.x/learn/upgrading-smart-contracts

Command to install the OpenZeppelin Hardhat Upgrades plugin as a development dependency.

```bash
npm install --save-dev @openzeppelin/hardhat-upgrades
```

--------------------------------

### Initialize OpenZeppelin Project

Source: https://docs.openzeppelin.com/contracts/5.x/learn/sending-gasless-transactions

Command to initialize the project structure using the OpenZeppelin CLI.

```bash
$ npx oz init
```

--------------------------------

### Install Hardhat ethers dependencies

Source: https://docs.openzeppelin.com/contracts/5.x/learn/deploying-and-interacting

Install the required ethers library and Hardhat plugin for contract deployment.

```bash
npm install --save-dev @nomicfoundation/hardhat-ethers ethers
```

--------------------------------

### onInstall(bytes data)

Source: https://docs.openzeppelin.com/community-contracts/api/account

Initializes the module for an account. This function can only be called once per account; if called directly, the provided data is set as the signer.

```APIDOC
## onInstall(bytes data)

### Description
Initializes the module. An account can only call this once. If called directly, the signer is set to the provided data.

### Parameters
- **data** (bytes) - Required - The initial signer data to be set.
```

--------------------------------

### Install Community Contracts with Foundry

Source: https://docs.openzeppelin.com/community-contracts

Use this command to install the library via gitmodules in a Foundry project.

```bash
$ forge install OpenZeppelin/openzeppelin-community-contracts
```

--------------------------------

### Build from Source

Source: https://docs.openzeppelin.com/monitor/1.3.x/quickstart

Manual compilation steps using Cargo.

```bash
cargo build --release
```

```bash
mv ./target/release/openzeppelin-monitor .
```
Tokens:
Raw