Skip to content

Latest commit

 

History

History

contracts-periphery

README.md

Umbra periphery contracts

Smart contracts that integrate with Umbra, but are not part of the core protocol contracts.

Contracts

Below is a list of contracts contained in this package:

  • UmbraBatchSend: Aggregate multiple Umbra sends into a single transaction.

Development

This repo uses Foundry.

How to use the DeployBatchSend Script

  1. Inside contracts-periphery folder, run cp .env.example .env and fill out all fields.
  2. In your terminal use command
  • cast nonce <Deployer's address> --rpc-url <URL> to find your nonce.
  1. Change EXPECTED_NONCE of DeployBatchSend script to match your nonce.
  2. To make sure the script test passes, run
  • forge test --mc DeployBatchSendTest --sender <Deployer's address>
  1. Pass in the private key to dry run deploying the contract across the networks you've specified. You should see gas estimates for each network, otherwise there could be a mismatch between deployer's nonce and the specified expected nonce, or there's already code at the expected contract address.
  • forge script DeployBatchSend --private-key <Private Key>
  1. Execute the deploy by broadcasting the deploy transactions.
  • forge script DeployBatchSend --private-key <Private Key> --broadcast

How to use the ApproveTokens Script

  1. Inside contracts-periphery folder, run cp .env.example .env and fill out all fields.
  2. In your terminal use command source .env to load the environment variables.
  3. To make sure the script test passes, run
  • forge test --mc ApproveBatchSendTokensTest --sender <Owner's address>
  1. To dry run the script pass in the --private-key flag and the desired network in the --rpc-url flag. Contract and token addresses should be specific to the network specified in the --rpc-url flag.
  • forge script ApproveBatchSendTokens --sig "run(address,address,address[])" <UmbraContractAddress> <UmbraBatchSendContractAddress> "[<TokenAddressToApprove>,<TokenAddressToApprove>]" --rpc-url $MAINNET_RPC_URL --private-key $PRIVATE_KEY
  1. Execute the script by adding the broadcasting flag.
  • forge script ApproveBatchSendTokens --sig "run(address,address,address[])" <UmbraContractAddress> <UmbraBatchSendContractAddress> "[<TokenAddressToApprove>,<SecondTokenAddressToApprove>]" --rpc-url $MAINNET_RPC_URL --private-key $PRIVATE_KEY --broadcast