@keep-network/tbtc-v2-starknet
v1.0.2
Published
StarkNet cross-chain integration for tBTC v2
Downloads
5
Readme
tBTC v2 StarkNet Cross-Chain Integration
StarkNet cross-chain integration for tBTC v2, enabling Bitcoin deposits directly to StarkNet Layer 2.
Prerequisites
- Node.js >= 14.0.0
- Yarn package manager
Installation
yarn installEnvironment Configuration
Required environment variables:
L1_CHAIN_API_URL=https://1rpc.io/sepolia
L1_ACCOUNTS_PRIVATE_KEYS=your_private_key_here # for sepolia (comma-separated)
CONTRACT_OWNER_ACCOUNT_PRIVATE_KEY=your_key # for mainnet
ETHERSCAN_API_KEY=your_etherscan_api_keyAvailable Commands
Development
yarn clean # Clean build artifacts and cache
yarn build # Compile contracts
yarn test # Run tests with external deployments
yarn test:integration # Run integration testsDeployment
yarn deploy:test # Deploy with test stubs
yarn deploy:sepolia # Deploy to Sepolia testnet
yarn deploy:mainnet # Deploy to mainnetVerification
yarn verify --network <network> # Verify contracts on EtherscanArtifacts
yarn export-artifacts:sepolia # Export Sepolia deployment artifacts
yarn export-artifacts:mainnet # Export mainnet deployment artifactsNetwork Configuration
Sepolia Testnet
- StarkGate Bridge:
0xF6217de888fD6E6b2CbFBB2370973BE4c36a152D - StarkNet tBTC Token:
0x05f09ee6e942b869aa159287924156cb9bc4510a447c0cc80a898780434d5c2c
Mainnet
- StarkGate Bridge:
0x2111A49ebb717959059693a3698872a0aE9866b9 - StarkNet tBTC Token:
0x04daa17763b286d1e59b97c283c0b8c949994c361e426a28f743c67bdfe9a32f
Architecture
The StarkNetBitcoinDepositor contract uses OpenZeppelin's transparent proxy pattern and integrates with:
- tBTC Bridge: Core Bitcoin deposit processing
- tBTC Vault: Token minting and custody
- StarkGate Bridge: L1→L2 messaging infrastructure
- StarkNet tBTC Token: L2 token representation
Deployment Notes
- Test on Sepolia before mainnet deployment
- Update mainnet StarkNet tBTC token address in deployment script
- Contracts are automatically verified on Etherscan when
ETHERSCAN_API_KEYis configured
License
GPL-3.0-only
