simplicity_sdk

Simplicity SDK for Flutter

The official SDK for interacting with the Simplicity Blockchain, designed specifically for Flutter developers. This SDK simplifies the process of deploying smart contracts and interacting with their functions, abstracting complexities such as signature management.

The SDK supports smart contracts written in Simply-lang, a user-friendly programming language for the Simplicity Blockchain. With this package, you can focus on building innovative blockchain solutions without dealing with low-level details.

Learn more about Simply-lang and Simplicity Blockchain here:

• Simply-Lang
• Simplicity Blockchain

Features

• 🚀 Easy contract deployment
• 🔄 Simple function calls
• 🔐 Automatic signature handling
• 🔑 Public key derivation
• ⚡ Async/await support
• 🛡️ Comprehensive error handling

Installation

To install the SDK, add it to your pubspec.yaml file:

dependencies:
  simplicity_sdk: ^1.0.0

Then, run:

flutter pub get

Quick Start

Initialize the SDK

import 'package:simplicity_sdk/simplicity_sdk.dart';

final sdk = SmartContractSDK();

Deploy a Contract

try {
  final deploymentResult = await sdk.deployContract(
    privateKey: 'your_private_key',
    contractName: 'MyWallet',
    contractCode: '''
      contract wallet with amount, address does
        deposit takes amount does
          save balance is balance + amount
          return balance
        .
      .
    ''',
  );
  
  print('Contract deployed at: ${deploymentResult.contractAddress}');
} on SmartContractException catch (e) {
  print('Deployment failed: $e');
}

Call Contract Functions

try {
  final callResult = await sdk.callContract(
    privateKey: 'your_private_key',
    contractAddress: 'contract_address',
    functionName: 'deposit',
    parameters: {'amount': 100},
  );
  
  print('Call result: ${callResult.result}');
} on SmartContractException catch (e) {
  print('Contract call failed: $e');
}

Advanced Usage

Custom Server Configuration

You can configure custom server URLs for both ECDSA and contract services:

final sdk = SmartContractSDK(
  ecdsaServerUrl: 'https://your-ecdsa-server.com',
  contractServerUrl: 'https://your-contract-server.com',
);

Error Handling

The SDK provides a custom SmartContractException for detailed error messages:

try {
  // SDK operations
} on SmartContractException catch (e) {
  print('Operation failed: ${e.message}');
} catch (e) {
  print('Unexpected error: $e');
}

Response Types

DeploymentResult

DeploymentResult {
  String contractAddress;    // The deployed contract's address
}

ContractCallResult

ContractCallResult {
  bool success;             // Whether the call was successful
  dynamic result;           // The function call result
}

Example Project

Check out the example directory for a complete sample project that demonstrates the features of the SDK.

Contributing

Contributions are welcome! If you encounter a bug or want to suggest a feature:

1. Check existing issues and pull requests
2. Create an issue to discuss the change
3. Submit a pull request

Please read CONTRIBUTING.md for details on our code of conduct and development process.

License

This project is licensed under the MIT License. See the LICENSE file for details.