Quick Start

Get Started with the Hyphen Flutter SDK

Create an App in the Dashboard

You need to create an app in the Hyphen Dashboard before using Hyphen SDK. After creating an app, an app secret will be issued. The app secret is required to initialize the SDK.

Installing the SDK

1. Open your project's pubspec.yaml file.

2. Add Dependency: Under the dependencies section of your pubspec.yaml file, add the "hyphen_flutter_sdk" plugin as follows:

dependencies:
  flutter:
    sdk: flutter
  hyphen_flutter_sdk: ^1.0.0

Replace ^1.0.0 with the desired version of the plugin. The ^ symbol indicates that your project can use any compatible version greater than or equal to the specified version.

1. Run flutter pub get: After adding the dependency, save the pubspec.yaml file, and run the following command in your terminal to fetch the plugin:

flutter pub get

This command will download the plugin and its dependencies into your Flutter project.

Initializing the SDK

Initialize the Hyphen SDK within your Flutter app's main.dart file or in the initialization code of your Flutter app. Here's an example of how you might initialize the SDK:

import 'package:flutter/material.dart';
import 'package:hyphen_flutter_sdk/core/hyphen.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {

  @override
  Widget build(BuildContext context) {

    // Initialize the Hyphen SDK
    Hyphen.initialize(context);
    Hyphen.appSecret = "<YOUR-APP-SECRET>";
    Hyphen.network = NetworkType.TESTNET;

    return MaterialApp(
      title: 'My App',
      home: MyHomePage(),
    );
  }
}