# @across-protocol/contracts > ![Across-logo](https://raw.githubusercontent.com/across-protocol/across-frontend/65abd7772704a9ec243fd370f9e8e76322f0905b/src/assets/logo.svg) Latest version **5.0.27** (published 2026-09-16) · AGPL-3.0-only license · 0 weekly downloads ## Install ```sh npm install @across-protocol/contracts pnpm add @across-protocol/contracts yarn add @across-protocol/contracts bun add @across-protocol/contracts ``` ## Health **Score 65/100 (B)** — status: active. Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 5.0.27 | | Published | 2026-09-16 | | First published | 2021-12-08 | | Weekly downloads | 0 | | License | AGPL-3.0-only | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=22.18.0 | | Dependencies | 15 | | Unpacked size | 8.1 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | UMA Team | | Maintainers | chrismaree, mrice32, nicholaspai, evaldofelipe | ## Links - npm: https://www.npmjs.com/package/@across-protocol/contracts - Repository: https://github.com/across-protocol/across-smart-contracts-v2 - Homepage: https://github.com/across-protocol/across-smart-contracts-v2#readme - Issues: https://github.com/across-protocol/across-smart-contracts-v2/issues - npm.io page: https://npm.io/package/@across-protocol/contracts ## Dependencies (15) - [bs58](https://npm.io/package/bs58.md) ^6.0.0 - [ethers](https://npm.io/package/ethers.md) 5.7.2 - [@solana/kit](https://npm.io/package/@solana/kit.md) ^5.4.0 - [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) 1.98.2 - [@coral-xyz/anchor](https://npm.io/package/@coral-xyz/anchor.md) ^0.31.1 - [@ethersproject/bytes](https://npm.io/package/@ethersproject/bytes.md) 5.7.0 - [@eth-optimism/contracts](https://npm.io/package/@eth-optimism/contracts.md) ^0.5.40 - [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) 5.5.0 - [@ethersproject/bignumber](https://npm.io/package/@ethersproject/bignumber.md) 5.7.0 - [@ethersproject/keccak256](https://npm.io/package/@ethersproject/keccak256.md) 5.7.0 - [@across-protocol/constants](https://npm.io/package/@across-protocol/constants.md) ^3.1.124 - [@openzeppelin/contracts-v4](https://npm.io/package/@openzeppelin/contracts-v4.md) npm:@openzeppelin/contracts@4.9.6 - [@openzeppelin/contracts-upgradeable](https://npm.io/package/@openzeppelin/contracts-upgradeable.md) 5.5.0 - [@solana-program/address-lookup-table](https://npm.io/package/@solana-program/address-lookup-table.md) 0.10.0 - [@openzeppelin/contracts-upgradeable-v4](https://npm.io/package/@openzeppelin/contracts-upgradeable-v4.md) npm:@openzeppelin/contracts-upgradeable@4.9.6 ## Recent versions - 5.0.27 (latest) — 2026-09-16 - 6.0.0-beta.2 (beta) — 2026-09-11 - 5.0.16-alpha.2 (alpha) — 2026-06-10 - 5.0.26 — 2026-07-30 - 5.0.25 — 2026-07-30 - 5.0.24 — 2026-07-14 - 5.0.22 — 2026-07-03 - 5.0.21 — 2026-06-30 - 5.0.20 — 2026-06-24 - 5.0.19 — 2026-06-24 - 5.0.18 — 2026-06-15 - 5.0.16 — 2026-06-10 - 5.0.15 — 2026-06-09 - 5.0.13-alpha.1 — 2026-06-03 - 5.0.12-alpha.2 — 2026-06-03 - … 136 more at https://npm.io/package/@across-protocol/contracts/versions ## README ![Across-logo](https://raw.githubusercontent.com/across-protocol/across-frontend/65abd7772704a9ec243fd370f9e8e76322f0905b/src/assets/logo.svg) Contains smart contract suite to enable instant token transfers between any two networks. Relays are backstopped by liquidity held in a central `HubPool` on Ethereum, which also serves as the cross-chain administrator of all contracts in the system. `SpokePool` contracts are deployed to any network that wants to originate token deposits or be the final destination for token transfers, and they are all governed by the `HubPool` on Ethereum. These contracts have been continuously audited by OpenZeppelin and the audit reports can be found [here](https://docs.across.to/resources/audits). ## Understanding Upgradeability The SpokePool contracts are [UUPSUpgradeable](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/cbb66aca87521f818d9c1769c69d5dcc1004977a/contracts/proxy/utils/UUPSUpgradeable.sol) Proxy contracts which means that their addresses will always be the same but their implementation code can change. All SpokePools can be upgraded if the "admin" of the contract calls `upgradeTo`. The SpokePool's admin is set by implementing the [`_requireAdminSender()` virtual function](https://github.com/across-protocol/contracts/blob/555475cdee6109afc85065ca415c740d7f97b992/contracts/SpokePool.sol#L1745) in the child contract. For example here are the [Arbitrum](https://github.com/across-protocol/contracts/blob/555475cdee6109afc85065ca415c740d7f97b992/contracts/Arbitrum_SpokePool.sol#L114) and [Optimism](https://github.com/across-protocol/contracts/blob/555475cdee6109afc85065ca415c740d7f97b992/contracts/Ovm_SpokePool.sol#L208) implementations of the admin check. All SpokePools are implemented such that the admin is the HubPool, and therefore we describe the SpokePools as having "cross-chain ownership". The owner of the HubPool can call [this function](https://github.com/across-protocol/contracts/blob/555475cdee6109afc85065ca415c740d7f97b992/contracts/HubPool.sol#L249) to send a cross-chain execution of `upgradeTo` on any SpokePool in order to upgrade it. This [script](https://github.com/across-protocol/contracts/blob/555475cdee6109afc85065ca415c740d7f97b992/tasks/upgradeSpokePool.ts) is useful for creating the calldata to execute a cross-chain upgrade via the HubPool. ## Deployed Contract Versions The latest contract deployments can be found in `/broadcast/deployed-addresses.json` (auto-generated by `yarn extract-addresses`). ## Requirements This repository assumes you have [Node](https://nodejs.org/en/download/package-manager) installed, with a minimum version of 16.18.0. Depending on what you want to do with the repo you might also need [foundry](https://book.getfoundry.sh/getting-started/installation) and [anchor](https://www.anchor-lang.com/docs/installation) to also be installed. If you have build issues please ensure these are both installed first. Note if you get build issues on the initial `yarn` command try downgrading to node 20.17 (`nvm use 20.17`). If you've never used anchor before you might need to run `avm use latest` as well. ## Build ```shell yarn yarn build # Will build all code. Compile solidity & rust (local toolchain), generate ts outputs yarn build-verified # Will build all code. Compile solidity & rust (verified docker build), generate ts outputs ``` EVM builds and tests use the Foundry version pinned in `.foundry-version`; CI installs exactly that version via `foundry-rs/foundry-toolchain`. Run `yarn pin-foundry` to switch your local toolchain to it (a no-op when it already matches). Bump the pin by editing that file. ## Test ```shell yarn test # Run all unit tests without gas analysis, using local toolchain SVM build yarn test-verified # Run all unit tests (without gas analysis) with verified SVM docker build yarn test:gas-analytics # Run only tests that count gas costs yarn test:report-gas # Run unit tests with gas reporting enabled yarn test-evm # Only test EVM code yarn test-svm # Only test SVM code (local toolchain build) yarn test-svm-solana-verify # Only test SVM code (verified docker build) ``` ## Lint ```shell yarn lint yarn lint-js # Only lint Javascript yarn lint-rust # Only lint rust yarn lint-solidity # Only lint solidity yarn lint-fix ``` ## Deploy and Verify ### EVM #### Foundry ```shell forge build forge script script/001DeployHubPool.s.sol:DeployHubPool --rpc-url ethereum --broadcast --verify -vvvv ``` #### Foundry (ZKSync) To enable ZKSync support, the zksync fork of foundry must be installed (see [here](https://foundry-book.zksync.io/introduction/installation#using-foundryup-zksync) for instructions). Also, the `FOUNDRY_PROFILE` environment variable must be set to `zksync`. ```shell FOUNDRY_PROFILE=zksync forge script script/016DeployZkSyncSpokePool.s.sol:DeployZkSyncSpokePool --rpc-url zksync --broadcast --verify -vvvv ``` Alternatively, the `yarn forge-script-zksync` command can be used to deploy the contract. ```shell yarn forge-script-zksync script/016DeployZkSyncSpokePool.s.sol:DeployZkSyncSpokePool --rpc-url zksync --broadcast --verify -vvvv ``` ### SVM Before deploying for the first time make sure all program IDs in `lib.rs` and `Anchor.toml` are the same as listed when running `anchor keys list`. If not, update them to match the deployment keypairs under `target/deploy/` and commit the changes. Make sure to use the verified docker binaries that can be built: ```shell unset IS_TEST # Ensures the production build is used (not the test feature) yarn build-svm-solana-verify # Builds verified SVM binaries yarn generate-svm-artifacts # Builds IDLs ``` Export required environment variables, e.g.: ```shell export RPC_URL=https://api.devnet.solana.com export KEYPAIR=~/.config/solana/dev-wallet.json export PROGRAM=svm_spoke # Also repeat the deployment process for multicall_handler export PROGRAM_ID=$(cat target/idl/$PROGRAM.json | jq -r ".address") export MULTISIG= # Export the Squads vault, not the multisig address! export SOLANA_VERSION=$(grep -A 2 'name = "solana-program"' Cargo.lock | grep 'version' | head -n 1 | cut -d'"' -f2) ``` For the initial deployment also need these: ```shell export SVM_CHAIN_ID=$(cast to-dec $(cast shr $(cast shl $(cast keccak solana-devnet) 208) 208)) export HUB_POOL=0x14224e63716afAcE30C9a417E0542281869f7d9e # This is for sepolia, update for mainnet export DEPOSIT_QUOTE_TIME_BUFFER=3600 export FILL_DEADLINE_BUFFER=21600 export MAX_LEN=$(( 2 * $(stat -c %s target/deploy/$PROGRAM.so) )) # Reserve twice the size of the program for future upgrades ``` #### Initial deployment Deploy the program and set the upgrade authority to the multisig: ```shell solana program deploy \ --url $RPC_URL \ --keypair $KEYPAIR \ --program-id target/deploy/$PROGRAM-keypair.json \ --max-len $MAX_LEN \ --with-compute-unit-price 100000 \ --max-sign-attempts 100 \ --use-rpc \ target/deploy/$PROGRAM.so solana program set-upgrade-authority \ --url $RPC_URL \ --keypair $KEYPAIR \ --skip-new-upgrade-authority-signer-check \ $PROGRAM_ID \ --new-upgrade-authority $MULTISIG ``` Update and commit `deployments/legacy-addresses.json` with the deployed program ID and deployment slot. Upload the IDL and set the upgrade authority to the multisig: ```shell anchor idl init \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR \ --filepath target/idl/$PROGRAM.json \ $PROGRAM_ID anchor idl set-authority \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR \ --program-id $PROGRAM_ID \ --new-authority $MULTISIG ``` `svm_spoke` also requires initialization and transfer of ownership on the first deployment: ```shell anchor run initialize \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR -- \ --chainId $SVM_CHAIN_ID \ --remoteDomain 0 \ --crossDomainAdmin $HUB_POOL \ --svmAdmin $MULTISIG \ --depositQuoteTimeBuffer $DEPOSIT_QUOTE_TIME_BUFFER \ --fillDeadlineBuffer $FILL_DEADLINE_BUFFER ``` Create the vault for accepting deposits, e.g.: ```shell export MINT=4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU # This is USDC on devnet, update with address for mainnet anchor run createVault \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR -- \ --originToken $MINT ``` `sponsored_cctp_src_periphery` requires initialization and setting minimum deposit amount for supported burn token: ```shell # Replace --quoteSigner with actual quote signer address anchor run initializeSponsoredCctpSrc \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR -- \ --quoteSigner 0x0000000000000000000000000000000000000000 # Below is USDC on devnet, replace --burnToken with mainnet burn token and --amount with required minimum deposit amount (raw value) anchor run setMinimumDepositSponsoredCctpSrc \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR -- \ --burnToken 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU \ --amount 0 ``` #### Upgrades Initiate the program upgrade: ```shell solana program write-buffer \ --url $RPC_URL \ --keypair $KEYPAIR \ --with-compute-unit-price 100000 \ --max-sign-attempts 100 \ --use-rpc \ target/deploy/$PROGRAM.so export BUFFER= # Export the logged buffer address from the command above solana program set-buffer-authority \ --url $RPC_URL \ --keypair $KEYPAIR \ $BUFFER \ --new-buffer-authority $MULTISIG ``` Add the program ID to Squads multisig (`https://devnet.squads.so/` for devnet and `https://app.squads.so/` for mainnet) in the Developers/Programs section. Then add the upgrade filling in the buffer address and buffer refund. After creating the upgrade verify the buffer authority as prompted and proceed with initiating the upgrade. Once all required signers have approved, execute the upgrade in the transactions section. Start the IDL upgrade by writing it to the buffer: ```shell anchor idl write-buffer \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR \ --filepath target/idl/$PROGRAM.json \ $PROGRAM_ID export IDL_BUFFER= # Export the logged IDL buffer address from the command above anchor idl set-authority \ --provider.cluster $RPC_URL \ --provider.wallet $KEYPAIR \ --program-id $PROGRAM_ID \ --new-authority $MULTISIG \ $IDL_BUFFER ``` Construct the multisig transaction for finalizing the IDL upgrade. Copy the printed base58 encoded transaction from below command and import it into the Squads multisig for approval and execution: ```shell anchor run squadsIdlUpgrade -- \ --programId $PROGRAM_ID \ --idlBuffer $IDL_BUFFER \ --multisig $MULTISIG \ --closeRecipient $(solana address --keypair $KEYPAIR) ``` #### Verify Start with verifying locally that the deployed program matches the source code of the public repository: ```shell solana-verify verify-from-repo \ --url $RPC_URL \ --program-id $PROGRAM_ID \ --library-name $PROGRAM \ --base-image "solanafoundation/solana-verifiable-build:$SOLANA_VERSION" \ https://github.com/across-protocol/contracts ``` When prompted, don't yet upload the verification data to the blockchain as that should be done by the multisig. Proceed with creating the upload transaction and then import and sign/execute it in the Squads multisig: ```shell solana-verify export-pda-tx \ --url $RPC_URL \ --program-id $PROGRAM_ID \ --library-name $PROGRAM \ --base-image "solanafoundation/solana-verifiable-build:$SOLANA_VERSION" \ --uploader $MULTISIG \ https://github.com/across-protocol/contracts ``` Note that the initial upload transaction might fail if the multisig vault does not have enough SOL for PDA creation. In that case, transfer the required funds to the multisig vault before executing the upload transaction. Finally, submit the verification to OtterSec API (only works on mainnet): ```shell solana-verify remote submit-job \ --url $RPC_URL \ --program-id $PROGRAM_ID \ --uploader $MULTISIG ``` ## Miscellaneous topics ### Slither [Slither](https://github.com/crytic/slither) is a Solidity static analysis framework written in Python 3. It runs a suite of vulnerability detectors, prints visual information about contract details, and provides an API to easily write custom analyses. Slither enables developers to find vulnerabilities, enhance their code comprehension, and quickly prototype custom analyses. Spire-Contracts has been analyzed using `Slither@0.9.2` and no major bugs was found. To rerun the analytics, run: ```sh slither contracts/SpokePool.sol \ --solc-remaps @=node_modules/@ \ --solc-args "--optimize --optimize-runs 1000000" \ --filter-paths "node_modules" \ --exclude naming-convention ``` You can replace `SpokePool.sol` with the specific contract you want to analyze. ### ZK Sync Adapter ZK EVM's typically require a special compiler to convert Solidity into code that can be run on the ZK VM. There are special instructions for compiling and deploying contracts on `zksync`. The compile command will create `artifacts-zk` and `cache-zk` directories. #### Compile This step requires [Docker Desktop](https://www.docker.com/products/docker-desktop/) to be running, as the `solc` docker image is fetched as a prerequisite. `yarn compile-zksync` ## License All code in this repository is licensed under BUSL-1.1 unless specified differently in the file. Individual exceptions to this license can be made by Risk Labs, which holds the rights to this software and design. If you are interested in using the code or designs in a derivative work, feel free to reach out to licensing@risklabs.foundation. --- _Source: https://npm.io/package/@across-protocol/contracts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._