Skip to content

MetroLogic/chainremit_contract

BranchesTags

Repository files navigation

StarkRemit Contract

License: MIT

Project Overview

StarkRemit is a comprehensive Cairo smart contract for cross-border remittances on StarkNet, featuring multi-currency support, KYC compliance, and advanced transfer administration capabilities.

This project leverages the scalability and low transaction costs of StarkNet L2 to provide secure, efficient, and compliant cross-border money transfers with comprehensive administrative controls.

Key Features:

  • ERC-20 Token Standard: Full implementation with multi-currency support
  • User Registration & KYC: Comprehensive user onboarding with multi-level verification
  • Transfer Administration: Complete transfer lifecycle management with agent integration
  • Multi-Currency Support: Handle multiple currencies with exchange rate integration
  • Agent Management: Cash-out agent registration and authorization system
  • Transfer History: Comprehensive tracking and searchable transaction history
  • Administrative Controls: Admin functions for transfer and agent management
  • Event-Driven Architecture: Real-time events for all administrative actions

Cairo Starknet Build Status

Project Overview

starkRemit_contract is a Starknet smart contract designed for facilitating secure and efficient cross-border remittances with built-in escrow services and compliance features.

This project leverages the scalability and low transaction costs of Starknet L2 to solve the high-cost, slow settlement, and limited transparency issues plaguing traditional remittance services. By utilizing blockchain technology, we eliminate intermediaries, reduce fees from 6-10% to under 1%, and provide real-time settlement with full transaction transparency.

Key Features:

  • Multi-Currency Support: Send and receive payments in various ERC20 tokens with automatic conversion
  • KYC Integration: Built-in identity verification system with compliance checks for regulatory requirements
  • Secure Escrow System: Funds are locked in smart contract escrow until recipient confirmation or dispute resolution
  • Real-time Exchange Rates: Integration with Pragma Oracle for accurate, up-to-date currency conversion rates
  • Dispute Resolution: Automated arbitration system with appeal mechanisms for transaction conflicts
  • Ultra-Low Fees: Leverage Starknet's L2 efficiency for transaction costs under 0.5% of transfer amount
  • Multi-signature Security: Optional multi-sig approval for high-value transactions
  • Compliance Monitoring: Automatic AML/CFT screening and regulatory reporting capabilities

Transfer Administration Features âś…

The contract includes comprehensive transfer administration functionality:

Transfer Lifecycle Management

  • Transfer Creation: Create transfers with expiry times and metadata
  • Transfer Cancellation: Cancel incomplete transfers with automatic refunds
  • Transfer Completion: Mark transfers as completed with fund distribution
  • Partial Completion: Support for partial transfer completion
  • Transfer Expiry: Automatic handling of expired transfers with refunds

Agent Integration

  • Agent Registration: Register cash-out agents with regional and currency support
  • Agent Management: Update agent status and manage agent lifecycle
  • Agent Authorization: Verify agent permissions for specific transfers
  • Cash-Out Operations: Agent-facilitated cash-out completion

Transfer History & Tracking

  • Comprehensive History: Track all transfer actions and status changes
  • Searchable Records: Search history by actor, action, or transfer
  • Event Emission: Real-time events for all administrative actions
  • Statistics Tracking: Maintain transfer and agent statistics

Setup Instructions

Prerequisites:

Installation:

  1. Clone the repository:

    git clone https://github.com/your-username/starkRemit_contract.git
cd starkRemit_contract

  2. Install dependencies:

  3. Install Scarb dependencies:

    scarb build

  4. Configure environment variables:

    cp .env.example .env
# Edit .env with your configuration:
# STARKNET_RPC_URL=https://starknet-goerli.g.alchemy.com/v2/your-api-key
# ACCOUNT_ADDRESS=0x...
# PRIVATE_KEY=0x...
# PRAGMA_ORACLE_ADDRESS=0x...
# DEFAULT_FEE_RATE=50  # 0.5% in basis points

  5. Install additional tools:

    # Install Starkli for contract interaction
curl -L https://raw.githubusercontent.com/xJonathanLEI/starkli/master/install.sh | bash
starkliup

# Install Node.js dependencies for scripts
npm install

Running Locally:

  1. Start a local Starknet Devnet:

    starknet-devnet --host 127.0.0.1 --port 5050 --seed 42 &

  2. Compile the contract:

    scarb build

  3. Run tests:

    scarb test

snforge test --verbose

  4. Deploy to local devnet:

    ./scripts/deploy_local.sh

Available Scripts

  • scarb build: Compiles the Cairo contract
  • scarb test: Runs the test suite using Starknet Foundry
  • scarb fmt: Formats the code

This project includes the following scripts to aid development:

  • scarb build: Compiles the Cairo contract and generates artifacts.
  • snforge test: Runs the complete test suite using Starknet Foundry.
  • scarb fmt: Formats all Cairo source code according to project standards.
  • Local Deployment: Deploys contract to local devnet with test configuration 
    ./scripts/deploy_local.sh
  • Testnet Deployment: Deploys contract to Goerli or Sepolia testnet 
    ./scripts/deploy_testnet.sh --network goerli
./scripts/deploy_testnet.sh --network sepolia
  • Contract Interaction: Utility scripts for common contract operations 
    ./scripts/create_remittance.sh <recipient> <amount> <token_address>
./scripts/fund_remittance.sh <remittance_id>
./scripts/release_funds.sh <remittance_id>
  • Oracle Setup: Initialize and configure Pragma Oracle integration 
    ./scripts/setup_oracle.sh
  • Verification: Verify deployed contracts on Starkscan 
    ./scripts/verify_contract.sh <contract_address> <network>
  • Load Testing: Performance testing suite for high-volume scenarios 
    npm run load-test

Project Structure

starkRemit_contract/
├── Scarb.toml                    # Project manifest and dependencies
├── src/
│   ├── lib.cairo                 # Library entry point
│   ├── starkremit/
│   │   └── StarkRemit.cairo      # Main contract implementation
│   ├── base/
│   │   ├── types.cairo           # Data structures and enums
│   │   └── errors.cairo          # Error definitions
│   └── interfaces/
│       └── IStarkRemit.cairo     # Contract interface
├── tests/
│   ├── test_StarkRemit.cairo     # Transfer administration tests
│   ├── test_kyc.cairo            # KYC functionality tests
│   └── test_contract.cairo       # Basic contract tests
└── README.md                     # This file

Key Data Structures

Transfer Management

struct Transfer {
    transfer_id: u256,
    sender: ContractAddress,
    recipient: ContractAddress,
    amount: u256,
    currency: felt252,
    status: TransferStatus,
    created_at: u64,
    updated_at: u64,
    expires_at: u64,
    assigned_agent: ContractAddress,
    partial_amount: u256,
    metadata: felt252,
}

enum TransferStatus {
    Pending,
    Completed,
    Cancelled,
    Expired,
    PartialComplete,
    CashOutRequested,
    CashOutCompleted,
}

Agent Management

struct Agent {
    agent_address: ContractAddress,
    name: felt252,
    status: AgentStatus,
    primary_currency: felt252,
    secondary_currency: felt252,
    primary_region: felt252,
    secondary_region: felt252,
    commission_rate: u256,
    completed_transactions: u256,
    total_volume: u256,
    registered_at: u64,
    last_active: u64,
    rating: u256,
}

History Tracking

struct TransferHistory {
    transfer_id: u256,
    action: felt252,
    actor: ContractAddress,
    timestamp: u64,
    previous_status: TransferStatus,
    new_status: TransferStatus,
    details: felt252,
}

Directory Descriptions:

  • Scarb.toml: Defines project metadata, Cairo dependencies, and compilation settings.
  • src/core/: Contains the main business logic for remittance processing, escrow management, and compliance.
  • src/interfaces/: Defines contract interfaces following Cairo best practices for modularity.
  • src/utils/: Reusable utility functions for mathematical operations, access control, and event handling.
  • tests/: Comprehensive testing suite including unit tests, integration tests, and mock contracts.
  • scripts/: Shell and Node.js scripts for deployment, contract interaction, and maintenance tasks.
  • docs/: Extended documentation covering API details, security, and integration guides.

Coding Conventions

  • Language: Cairo 1.x+ (Compatible with Cairo 2.4.0+)
  • Formatting: Use scarb fmt for consistent code style across all source files.
  • Naming Conventions:
    • Contracts: PascalCase (e.g., StarkRemit, EscrowManager)
    • Functions: snake_case (e.g., create_remittance, release_funds)
    • Variables: snake_case (e.g., sender_address, total_amount)
    • Structs/Enums: PascalCase (e.g., RemittanceDetails, TransactionStatus)
    • Constants: UPPER_SNAKE_CASE (e.g., MAX_REMITTANCE_AMOUNT, MIN_FEE_RATE)
    • Events: PascalCase (e.g., RemittanceCreated, FundsReleased)
    • Storage Variables: snake_case (e.g., remittances_by_id, user_kyc_status)
  • Documentation Standards:
    • Use /// for documentation comments explaining functions, structs, and modules
    • Include parameter descriptions, return value explanations, and usage examples
    • Document all public interfaces with comprehensive examples
  • Error Handling:
    • Use descriptive error messages with context
    • Implement custom error types for different failure scenarios
    • Use assert! for critical invariants and panic_with_felt252 for custom error codes
    • Prefer recoverable errors with proper Result types where applicable
  • Security Practices:
    • Implement checks-effects-interactions pattern
    • Use reentrancy guards for external calls
    • Validate all inputs and state changes
    • Follow principle of least privilege for access control
  • Testing Standards:
    • Write unit tests for all public functions
    • Include edge cases and boundary condition testing
    • Test both success and failure scenarios
    • Maintain minimum 85% code coverage
    • Use descriptive test names following test_function_name_condition_expected_result pattern

Transfer Administration API

Transfer Operations

  • create_transfer() - Create a new transfer
  • cancel_transfer() - Cancel an existing transfer
  • complete_transfer() - Mark transfer as completed
  • partial_complete_transfer() - Partially complete a transfer
  • request_cash_out() - Request cash-out for a transfer
  • complete_cash_out() - Complete cash-out (agent only)

Agent Management

  • register_agent() - Register a new agent (admin only)
  • update_agent_status() - Update agent status (admin only)
  • get_agent() - Get agent details
  • is_agent_authorized() - Check agent authorization

Transfer Queries

  • get_transfer() - Get transfer details
  • get_transfers_by_sender() - Get transfers by sender
  • get_transfers_by_recipient() - Get transfers by recipient
  • get_transfers_by_status() - Get transfers by status
  • get_expired_transfers() - Get expired transfers

History & Statistics

  • get_transfer_history() - Get transfer history
  • search_history_by_actor() - Search history by actor
  • search_history_by_action() - Search history by action
  • get_transfer_statistics() - Get transfer statistics
  • get_agent_statistics() - Get agent statistics

Administrative Functions

  • assign_agent_to_transfer() - Assign agent to transfer (admin only)
  • process_expired_transfers() - Process expired transfers (admin only)

Events

The contract emits comprehensive events for all transfer administration actions:

  • TransferCreated - When a transfer is created
  • TransferCancelled - When a transfer is cancelled
  • TransferCompleted - When a transfer is completed
  • TransferPartialCompleted - When a transfer is partially completed
  • TransferExpired - When a transfer expires
  • CashOutRequested - When cash-out is requested
  • CashOutCompleted - When cash-out is completed
  • AgentAssigned - When an agent is assigned
  • AgentRegistered - When an agent is registered
  • AgentStatusUpdated - When agent status is updated
  • TransferHistoryRecorded - When history is recorded

Prerequisites:

  • Compiled contract artifacts in target/dev/ directory
  • Funded Starknet account with sufficient ETH for deployment fees
  • RPC endpoint access for target network (Mainnet, Goerli, or Sepolia)
  • Deployment tools: Starkli v0.2.0+ or Starknet.js

Network Configuration:

Network RPC Endpoint Chain ID Status
Mainnet https://starknet-mainnet.g.alchemy.com/v2/ SN_MAIN Production
Goerli https://starknet-goerli.g.alchemy.com/v2/ SN_GOERLI Testnet
Sepolia https://starknet-sepolia.g.alchemy.com/v2/ SN_SEPOLIA Testnet

Deployment Steps (using Starkli):

  1. Set up Starkli account and keystore:

    # Create account descriptor
starkli account fetch <account_address> --rpc <rpc_url>

# Create keystore (if not already done)
starkli signer keystore from-key ~/.starkli-wallets/keystore.json

  2. Declare the Contract Class:

    starkli declare target/dev/starkRemit_contract_StarkRemit.contract_class.json \
    --network goerli \
    --account ~/.starkli-wallets/account.json \
    --keystore ~/.starkli-wallets/keystore.json \
    --compiler-version 2.4.0 \
    --max-fee 0.01

# Save the returned class hash: 0x...

  3. Deploy Contract Instance:

    starkli deploy <class_hash> \
    <initial_owner_address> \
    <oracle_address> \
    <default_fee_rate> \
    --network goerli \
    --account ~/.starkli-wallets/account.json \
    --keystore ~/.starkli-wallets/keystore.json \
    --max-fee 0.05

# Save the returned contract address: 0x...

Constructor Parameters:

  • initial_owner: Address that will have admin privileges (use your account address)
  • oracle_address: Pragma Oracle contract address for price feeds
  • default_fee_rate: Fee rate in basis points (e.g., 50 = 0.5%)

Testing

Post-Deployment Configuration:

# Set supported tokens
starkli invoke <contract_address> add_supported_token <token_address> --network goerli

# Configure KYC provider
starkli invoke <contract_address> set_kyc_provider <provider_address> --network goerli

# Set minimum/maximum remittance limits
starkli invoke <contract_address> set_limits <min_amount> <max_amount> --network goerli

Automated Deployment: Use our deployment scripts for easier deployment:

# Deploy to testnet with configuration
./scripts/deploy_testnet.sh --network goerli --owner 0x... --oracle 0x...

# Deploy to mainnet (requires additional confirmations)
./scripts/deploy_mainnet.sh --owner 0x... --oracle 0x...

The contract includes comprehensive tests covering:

  • Contract compilation and deployment
  • Transfer lifecycle operations
  • Agent management functionality
  • History tracking and statistics
  • KYC compliance and enforcement
  • Error handling and edge cases

All tests pass successfully:

Tests: 20 passed, 0 failed, 0 skipped, 0 ignored, 0 filtered out

Deployment

The contract requires the following constructor parameters:

  • admin: Admin address with special privileges
  • name: Token name
  • symbol: Token symbol
  • initial_supply: Initial token supply
  • base_currency: Base currency identifier
  • oracle_address: Oracle contract address for exchange rates

Component Library Documentation (Contract Interface)

This section describes the main functions, data structures, and events exposed by the starkRemit_contract.

Core Data Structures

Structs:

  • RemittanceDetails: 
    struct RemittanceDetails {
    id: u64,                           // Unique remittance identifier
    sender: ContractAddress,           // Address initiating the remittance
    recipient: ContractAddress,        // Intended recipient address
    amount: u256,                      // Amount in source token units
    source_token: ContractAddress,     // Source token contract address
    target_token: ContractAddress,     // Target token contract address
    exchange_rate: u256,               // Exchange rate at creation time
    fee_amount: u256,                  // Total fees charged
    status: RemittanceStatus,          // Current remittance status
    created_at: u64,                   // Block timestamp of creation
    funded_at: u64,                    // Block timestamp when funded
    released_at: u64,                  // Block timestamp when released
    expires_at: u64,                   // Expiration timestamp
    kyc_verified: bool,               // KYC verification status
    dispute_id: u64,                   // Associated dispute ID (if any)
}

Security Features

  • Access Control: Admin-only functions for sensitive operations
  • KYC Integration: Optional KYC enforcement for transfers
  • Transfer Limits: Configurable transaction limits based on KYC level
  • Expiry Protection: Automatic handling of expired transfers
  • Agent Authorization: Strict agent verification for cash-out operations
  • Event Logging: Comprehensive event emission for audit trails

Performance Considerations

  • Efficient Storage: Optimized storage patterns for gas efficiency
  • Batch Operations: Support for processing multiple transfers
  • Indexed Queries: Efficient querying by user, status, and region
  • Event-Driven: Real-time event emission for external monitoring

  • UserProfile:

    struct UserProfile {
    address: ContractAddress,          // User's address
    kyc_level: KYCLevel,              // KYC verification level
    total_sent: u256,                  // Total amount sent lifetime
    total_received: u256,              // Total amount received lifetime
    reputation_score: u32,             // User reputation (0-1000)
    is_blocked: bool,                  // Account suspension status
    created_at: u64,                   // Registration timestamp
    last_activity: u64,                // Last transaction timestamp
}

  • DisputeDetails:

    struct DisputeDetails {
    id: u64,                           // Unique dispute identifier
    remittance_id: u64,               // Associated remittance ID
    initiator: ContractAddress,        // Address that raised the dispute
    reason: DisputeReason,            // Categorized dispute reason
    description: ByteArray,            // Detailed description
    evidence_hash: felt252,           // IPFS hash of evidence
    status: DisputeStatus,            // Current dispute status
    created_at: u64,                   // Dispute creation timestamp
    resolved_at: u64,                  // Resolution timestamp
    resolution: DisputeResolution,     // Final resolution decision
}

Enums:

  • RemittanceStatus:

    enum RemittanceStatus {
    Created,        // Remittance created but not funded
    Funded,         // Funds locked in escrow
    Released,       // Funds released to recipient
    Cancelled,      // Cancelled by sender (before funding)
    Disputed,       // Under dispute resolution
    Expired,        // Expired without completion
    Refunded,       // Funds returned to sender
}

  • KYCLevel:

    enum KYCLevel {
    None,           // No KYC verification
    Basic,          // Basic identity verification
    Enhanced,       // Enhanced due diligence
    Premium,        // Full institutional verification
}

  • DisputeReason:

    enum DisputeReason {
    PaymentNotReceived,     // Recipient claims non-receipt
    WrongAmount,           // Incorrect amount received
    UnauthorizedTx,        // Unauthorized transaction claim
    TechnicalIssue,        // Technical problem during transfer
    FraudSuspicion,        // Suspected fraudulent activity
    Other,                 // Other dispute reasons
}

External Functions

Core Remittance Functions:

  • fn create_remittance(ref self: ContractState, recipient: ContractAddress, amount: u256, source_token: ContractAddress, target_token: ContractAddress, expires_in: u64) -> u64:

    • Creates a new remittance request with specified parameters.
    • Parameters:
      • recipient: Destination address for funds
      • amount: Amount to send in source token units
      • source_token: ERC20 token address for source currency
      • target_token: ERC20 token address for target currency
      • expires_in: Expiration time in seconds from now
    • Returns: Unique remittance ID
    • Emits: RemittanceCreated event
    • Requirements: Valid addresses, amount > 0, tokens supported
    • Usage Example: 
      starkli invoke <contract_address> create_remittance \
    0x1234...recipient 1000000000000000000 \
    0x5678...usdc 0x9abc...eth 86400

  • fn fund_remittance(ref self: ContractState, remittance_id: u64):

    • Locks funds in escrow for the specified remittance. Requires prior ERC20 approval.
    • Parameters: remittance_id: ID of the remittance to fund
    • Emits: RemittanceFunded event
    • Requirements: Remittance exists, caller is sender, sufficient allowance
    • Usage Example: 
      # First approve token transfer
starkli invoke <token_address> approve <contract_address> <amount>
# Then fund the remittance
starkli invoke <contract_address> fund_remittance 123

  • fn release_funds(ref self: ContractState, remittance_id: u64):

    • Releases escrowed funds to the recipient after validation.
    • Parameters: remittance_id: ID of the remittance to complete
    • Emits: FundsReleased event
    • Requirements: Remittance funded, caller is recipient, not expired
    • Usage Example: 
      starkli invoke <contract_address> release_funds 123

  • fn cancel_remittance(ref self: ContractState, remittance_id: u64):

    • Cancels an unfunded remittance or refunds a funded one under specific conditions.
    • Parameters: remittance_id: ID of the remittance to cancel
    • Emits: RemittanceCancelled or RemittanceRefunded event
    • Requirements: Caller is sender, valid cancellation conditions
    • Usage Example: 
      starkli invoke <contract_address> cancel_remittance 123

Dispute Resolution Functions:

  • fn raise_dispute(ref self: ContractState, remittance_id: u64, reason: DisputeReason, description: ByteArray, evidence_hash: felt252) -> u64:
    • Initiates a dispute for a specific remittance.
    • Parameters: Remittance ID, dispute reason, description, evidence hash
    • Returns: Dispute ID
    • Emits: DisputeRaised event
    • Usage Example: 
      starkli invoke <contract_address> raise_dispute 123 0 "Payment not received" 0x...

**

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

5 stars

Watchers

1 watching

Forks

19 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages