Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bitcoin Bridge Smart Contract Implementation #1

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Bitcoin Bridge Smart Contract Implementation #1

wants to merge 8 commits into from

Conversation

peace-source
Copy link
Owner

Overview

This PR implements a comprehensive Bitcoin Bridge smart contract that enables secure bridging of Bitcoin to wrapped tokens (wBTC) on the Stacks blockchain.

Changes

Core Contract Implementation

  • Added error code constants for contract operations
  • Implemented core configuration and state management
  • Added storage definitions for various contract components
  • Defined wrapped Bitcoin token functionality
  • Implemented validation and helper functions
  • Added public functions for contract operations
  • Added read-only query functions

Documentation

  • Added LICENSE (MIT)
  • Added SECURITY.md with vulnerability reporting guidelines
  • Added API documentation
  • Added technical specifications
  • Added contribution guidelines

Implementation Details

1. Constants and Error Codes

(define-constant ERR-NOT-AUTHORIZED (err u1))
(define-constant ERR-INVALID-AMOUNT (err u2))
...
  • Defined error codes for all contract operations
  • Clear error messaging for better debugging

2. Core Configuration

(define-data-var bridge-owner principal tx-sender)
(define-data-var bridge-fee-percentage uint u10)
...
  • Configurable bridge parameters
  • Default 1% fee structure
  • Adjustable deposit limits

3. Storage and State Management

(define-map authorized-oracles principal bool)
(define-map processed-transactions { tx-hash: (string-ascii 64) } bool)
...
  • Efficient storage structure
  • Clear data organization
  • Optimized for common operations

4. Security Features

  • Oracle-based transaction validation
  • Whitelist management
  • Emergency pause mechanism
  • Transaction double-processing prevention
  • Input validation

Security Considerations

  • Access control validation
  • Amount validation
  • Transaction hash verification
  • Oracle authorization checks
  • Deposit limit enforcement

Deployment Notes

  1. Deploy contract
  2. Initialize bridge owner
  3. Add initial oracles
  4. Configure bridge parameters
  5. Add initial whitelisted recipients

Checklist

  • Error codes defined
  • Core configuration implemented
  • Storage maps defined
  • Token functionality implemented
  • Helper functions added
  • Public functions implemented
  • Read-only functions added
  • Documentation completed
  • Security policy added
  • License added

@peace-source
Add initial constants and error codes for Bitcoin Bridge smart contract
7b51429 
- Defined error codes for various contract operations including authorization, amount validation, balance checks, bridge status, transaction processing, oracle validation, recipient validation, deposit limits, and transaction hash validation.
@peace-source
Add core configuration and bridge state data variables
383790e 
- Defined core configuration variables including bridge owner, bridge pause status, bridge fee percentage, and maximum deposit amount.
- Added bridge state variable to track the total locked Bitcoin.
@peace-source
Add storage definitions for oracle management, transaction tracking, …
6e36ea9 
…recipient management, and user balances

- Defined maps for managing authorized oracles, tracking processed transactions, whitelisting recipients, and storing user balances.
@peace-source
Define wrapped Bitcoin token and private helper functions
553770b 
- Defined the wrapped Bitcoin fungible token.
- Added private functions for authorization checks, principal validation, transaction hash validation, and retrieving user balance amounts.
@peace-source
Add private function for Bitcoin transaction validation
e85b31e 
- Defined a private function to validate Bitcoin transactions by checking the transaction hash, amount, and authorization status of the validator.
@peace-source
Add public functions for oracle management, whitelist management, bri…
8b95891 
…dge controls, configuration updates, and core bridge operations

- Added public functions to add and remove oracles, manage recipient whitelist, pause and unpause the bridge, update bridge fee and maximum deposit amount.
- Implemented core bridge operation for depositing Bitcoin, including input validation, bridge state validation, transaction processing, and state updates.
@peace-source
Add read-only functions for querying bridge state and user information
63dfa08 
- Added read-only functions to get total locked Bitcoin, user balance, oracle authorization status, and bridge owner status.
@peace-source
Add license, security policy, code of conduct, API documentation, and…
3b6ea06 
… contribution guidelines
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@peace-source