Latam stables

Installation

1. Install Foundry (if not already installed):

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

2. Install project dependencies:

make install

3. Build the project:

make build

4. Run tests:

make test

Running the Project

• To run tests: make test
• To build: make build
• To deploy: see the Deployment section below

Setting the Wallet for Deployment

The deployment script requires a wallet address to broadcast transactions. By default, if you do not specify a network, the script uses a local Anvil account. For other networks, you can set the wallet in one of two ways:

1. Using a Private Key (for local Anvil or testnets)

Set the DEFAULT_ANVIL_KEY environment variable in your .env file or shell:

DEFAULT_ANVIL_KEY=your_private_key_here

2. Using a Keystore (for public networks)

Set the following environment variables in your .env file or shell:

KEYSTORE_PATH=path/to/your/keystore
KEYSTORE_PASSWORD=your_keystore_password

Importing a Wallet Key Using Cast

You can import a private key into a keystore using the following command:

cast wallet import --interactive key.json --keystore-dir keys

• This will prompt you to enter your private key and set a password.
• The generated key.json file will be stored in the keys directory.
• Set KEYSTORE_PATH to the path of the generated key.json and KEYSTORE_PASSWORD to the password you set.

The Makefile will automatically use these variables to determine the wallet address for deployment. For more details, see the comments in the Makefile.

Deployment

To deploy the LatamStable contract, you need to set the following environment variables with the addresses for each role:

• DEFAULT_ADMIN: Address to be granted the DEFAULT_ADMIN_ROLE
• PAUSER: Address to be granted the PAUSER_ROLE
• MINTER: Address to be granted the MINTER_ROLE
• UPGRADER: Address to be granted the UPGRADER_ROLE
• TOKEN_NAME: The name of the token (e.g., "Latam Stable")
• TOKEN_SYMBOL: The symbol of the token (e.g., "LATAM")

You can set these in your shell or in a .env file in the project root.

Example .env file

DEFAULT_ADMIN=0xYourAdminAddress
PAUSER=0xYourPauserAddress
MINTER=0xYourMinterAddress
UPGRADER=0xYourUpgraderAddress
TOKEN_NAME=Latam Stable
TOKEN_SYMBOL=LATAM

Deploying with Makefile

To deploy the contract, use the following command:

make deploy-latam-stable 

You can also specify a network using the ARGS variable. For example, to deploy to Sepolia:

make deploy-latam-stable ARGS="--network sepolia"

This will run the deployment script using the parameters from your environment variables and print the deployed contract addresses and roles.

Bridge Contracts

The bridge infrastructure enables cross-chain token transfers using a burn-and-mint mechanism.

Architecture

1. LimitedMinterBridge: Rate-limited minting contract that enforces daily mint caps per token. Unlike LimitedMinter, it allows minting to arbitrary recipients (for bridge fulfillment).

2. BridgeDeposit: Handles both sides of cross-chain bridges:

   • Source chain: Users call depositForBridge() to burn tokens
   • Destination chain: Bridge operators call fulfillBridgeMint() to mint tokens via LimitedMinterBridge

Deploying Bridge Contracts

1. Deploy LimitedMinterBridge

Set environment variables:

DEFAULT_ADMIN=0xAdminAddress
MINTER=0xMinterAddress  # Address that can call mintTo (e.g., BridgeDeposit contract)

Deploy:

make deploy-limited-minter-bridge ARGS="--network sepolia"

2. Deploy BridgeDeposit

Set environment variables:

BRIDGE_ADMIN=0xAdminAddress      # Receives DEFAULT_ADMIN_ROLE and BRIDGE_OPERATOR_ROLE
LIMITED_MINTER=0xLimitedMinterBridgeAddress  # Address from step 1

Deploy:

make deploy-bridge-deposit ARGS="--network sepolia"

Post-Deployment Setup

After deploying both contracts, you need to:

1. Grant MINTER_ROLE on LimitedMinterBridge to BridgeDeposit:

   limitedMinterBridge.grantRole(MINTER_ROLE, bridgeDepositAddress);

2. Register tokens in LimitedMinterBridge (by token admin):

   limitedMinterBridge.registerToken(tokenAddress, dailyMaxMint);

3. Add supported tokens to BridgeDeposit (by admin):

   bridgeDeposit.setSupportedToken(tokenAddress, true);

4. Grant MINTER_ROLE on LatamStable to LimitedMinterBridge (by token admin):

   latamStable.grantRole(MINTER_ROLE, limitedMinterBridgeAddress);