reclaim_flutter 0.0.6

reclaim_flutter SDK provides a way to let your users import data from other websites into your app in a secure, privacy preserving manner using zero knowledge proofs right in your React Native Application.

Reclaim Flutter SDK

Use the reclaim_flutter SDK to enable your users import data securely from other websites into your Flutter application in a privacy-preserving manner using zero-knowledge proofs.

📚 Table of Contents

1. Installation
2. Usage
3. Example

💻 Installation

You can add reclaim_flutter to your Flutter project using Dart or Flutter.

Dart

Run the following command in your terminal:

$ dart pub add reclaim_flutter

Flutter

Alternatively, you can use Flutter to install the package:

$ flutter pub add reclaim_flutter

Running the command will add this line to your pubspec.yaml:

dependencies:
  reclaim_flutter: any

After installation, you can import the package in your Dart code:

import 'package:reclaim_flutter/reclaim_flutter.dart';

🚀 Usage

Once the package is installed, you can start using ReclaimHttps in your application as follows:

import 'package:flutter/material.dart';
import 'package:reclaim_flutter/reclaim_flutter.dart';

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

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: ListView.builder(
          itemCount: 1, // Only one item
          itemBuilder: (BuildContext context, int index) {
            return Center(
              child: ReclaimHttps(
                requestedProofs: [
                  RequestedProof(
                    url: 'https://bookface.ycombinator.com/home',
                    loginUrl: 'https://bookface.ycombinator.com/home',
                    loginCookies: ['_sso.key'],
                    responseSelections: [
                      ResponseSelection(
                        responseMatch: '\{\"id\":{{YC_USER_ID}},.*?waas_admin.*?:{.*?}.*?:\\{.*?}.*?(?:full_name|first_name).*?}',
                      ),
                    ],
                  ),
                ],
                title: "YC Login",
                subTitle: "Prove you have a YC Login",
                cta: "Prove",
                onSuccess: (proofs) {
                  // do something
                  print('proofs: $proofs');
                },
                onFail: (Exception e) {
                  // do something
                  print('Error: $e');
                },
              ),
            );
          },
        ),
      ),
    );
  }
}

📁 Example

We have included an example project in the root directory to implement a https provider. You can find this here.

Running this example will showcase how reclaim_flutter can be implemented in a Flutter project. Simply clone the repository, navigate to the example folder, install the dependencies, and run the project.