Merge pull request #15 from codescalers/main_stellar_wallet

add stellar client

Author: AlaaElattar

.github/workflows/analyze.yaml

@@ -19,7 +19,11 @@ jobs:
       - name: Setup Dart SDK
         uses: dart-lang/setup-dart@v1.6.0
         with:
-          sdk: "stable"
+          sdk: "3.2.3"
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: "3.16.4"    
       - name: Install Melos
         run: dart pub global activate melos
 

.github/workflows/coverage.yaml

@@ -15,7 +15,6 @@ jobs:
     steps:
       - name: Set up Repository
         uses: actions/checkout@v2
-
       - name: List Files
         run: ls -R
 
@@ -37,13 +36,12 @@ jobs:
       - name: Start TFChain Docker Container
         run: |
           sudo docker run -d --network host ghcr.io/threefoldtech/tfchain  --dev --rpc-cors all --rpc-external --rpc-methods=safe
-      
       - name: Wait for TFChain to be ready
         run: |
           while ! nc -z localhost 9944; do
             echo "Waiting for TFChain to be ready..."
             sleep 5
-          done    
+          done
 
       - name: Run unit tests and generate coverage
         run: |

packages/stellar_client/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

packages/stellar_client/README.md

@@ -0,0 +1,68 @@
+# Stellar Client
+
+This Dart client allows you to communicate with the Stellar network, enabling the creation or loading of existing Stellar accounts. It supports interactions with both the testnet and public network, and the assets currently supported are TFT (Threefold Token) and XLM (Stellar Lumens).
+
+## Installation
+
+To install the necessary dependencies, run:
+
+```bash
+dart pub get
+```
+
+## Usage
+
+This client enables you to create new Stellar accounts or load existing ones on the testnet or public network. Once an account is created or loaded, you can manage assets such as TFT and XLM.
+
+### TESTNET
+
+Create new testnet account:
+
+- Use `Client.create(NetworkType.TESTNET)` to create a new client.
+- Use `Client.createFromMnemonic(NetworkType.TESTNET, "mnemonic")` to create a client from an existing mnemonic.
+- Account can be activated through friendbot (only for testnet).
+- After activation, trustlines can be added to the account.
+
+```dart
+  import 'package:stellar_client/stellar_client.dart';
+
+  final stellarClient = Client.create(NetworkType.TESTNET);
+  // final stellarClient = await Client.createFromMnemonic(NetworkType.TESTNET, "mnemonic");
+
+  await stellarClient.activateThroughFriendBot(accountId: stellarClient.accountId);
+  await stellarClient.addTrustLine();
+
+  final balance = await stellarClient.getBalance();
+  print(balance);
+```
+
+Load previously created account:
+
+- Accounts can be loaded from secret seed.
+
+```dart
+  import 'package:stellar_client/stellar_client.dart';
+
+  final stellarClient = Client(NetworkType.TESTNET, secretSeed);
+  final transactions = await stellarClient.getTransactions();
+  print(transactions);
+```  
+
+### PUBLIC
+
+- Activation through Threefold service will add assets automatically.
+
+```dart
+  import 'package:stellar_client/stellar_client.dart';
+
+  final stellarClient = Client.create(NetworkType.PUBLIC);
+  await stellarClient.activateThroughThreefoldService();
+
+  await stellarClient.transfer(
+      destinationAddress: "destination-public-key",
+      amount: "20",
+      currency: "TFT",
+      memoText: "Memo Text");
+
+  await stellarClient.getTransactions();
+```

packages/stellar_client/bin/stellar_client.dart

@@ -0,0 +1,14 @@
+import 'package:stellar_client/stellar_client.dart';
+
+void main() async {
+  final stellarClient = Client.create(NetworkType.PUBLIC);
+  await stellarClient.activateThroughThreefoldService();
+
+  await stellarClient.transfer(
+      destinationAddress: "destination-public-key",
+      amount: "20",
+      currency: "TFT",
+      memoText: "Memo Text");
+
+  await stellarClient.getTransactions();
+}

packages/stellar_client/lib/models/balance.dart

@@ -0,0 +1,18 @@
+abstract class BalanceInfo {
+  String get assetCode;
+  String get balance;
+}
+
+class BalanceData implements BalanceInfo {
+  @override
+  final String assetCode;
+  @override
+  final String balance;
+
+  BalanceData({required this.assetCode, required this.balance});
+
+   @override
+  String toString() {
+    return 'BalanceData(assetCode: $assetCode, balance: $balance)';
+  }
+}

packages/stellar_client/lib/models/currency.dart

@@ -0,0 +1,27 @@
+class Currency {
+  final String assetCode;
+  final String issuer;
+
+  Currency({required this.assetCode, required this.issuer});
+
+  Map<String, dynamic> toJson() {
+    return {
+      'asset_code': assetCode,
+      'issuer': issuer,
+    };
+  }
+}
+
+class Currencies {
+  late final Map<String, Currency> currencies;
+
+  Currencies(this.currencies);
+
+  Map<String, dynamic> toJson() {
+    Map<String, dynamic> jsonMap = {};
+    currencies.forEach((key, value) {
+      jsonMap[key] = value.toJson();
+    });
+    return jsonMap;
+  }
+}

packages/stellar_client/lib/models/transaction_data.dart

@@ -0,0 +1,24 @@
+class TransactionData {
+  final String asset;
+  final String feeAccountId;
+  final String feeFixed;
+
+  TransactionData({
+    required this.asset,
+    required this.feeAccountId,
+    required this.feeFixed,
+  });
+
+  factory TransactionData.fromJson(Map<String, dynamic> json) {
+    return TransactionData(
+      asset: json['asset'],
+      feeAccountId: json['fee_account_id'],
+      feeFixed: json['fee_fixed'],
+    );
+  }
+
+  @override
+  String toString() {
+    return 'TransactionData{asset: $asset, feeAccountId: $feeAccountId, feeFixed: $feeFixed}';
+  }
+}

packages/stellar_client/lib/models/transactions.dart

@@ -0,0 +1,58 @@
+class PaymentOperationDetails {
+  final String from;
+  final String to;
+  final double amount;
+  final String assetCode;
+  final bool isSuccessful;
+
+  PaymentOperationDetails({
+    required this.from,
+    required this.to,
+    required this.amount,
+    required this.assetCode,
+    required this.isSuccessful,
+  });
+
+  @override
+  String toString() {
+    return 'PaymentOperationDetails(from: $from, to: $to, amount: $amount, assetCode: $assetCode, isSuccessful: $isSuccessful)';
+  }
+}
+
+class CreateAccountOperationDetails {
+  final String account;
+  final double startingBalance;
+
+  CreateAccountOperationDetails({
+    required this.account,
+    required this.startingBalance,
+  });
+
+  @override
+  String toString() {
+    return 'CreateAccountOperationDetails(account: $account, startingBalance: $startingBalance)';
+  }
+}
+
+class PathPaymentStrictReceiveOperationDetails {
+  final String from;
+  final String to;
+  final double sourceAmount;
+  final String sourceAssetCode;
+  final double destinationAmount;
+  final String destinationAssetCode;
+
+  PathPaymentStrictReceiveOperationDetails({
+    required this.from,
+    required this.to,
+    required this.sourceAmount,
+    required this.sourceAssetCode,
+    required this.destinationAmount,
+    required this.destinationAssetCode,
+  });
+
+  @override
+  String toString() {
+    return 'PathPaymentStrictReceiveOperationDetails(from: $from, to: $to, sourceAmount: $sourceAmount, sourceAssetCode: $sourceAssetCode, destinationAmount: $destinationAmount, destinationAssetCode: $destinationAssetCode)';
+  }
+}