reclaim_sdk 1.8.0

Reclaim 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 Flutter Application.

Reclaim Flutter Sdk

This README provides a step-by-step guide on integrating the Reclaim Protocol Flutter SDK into application

Pre-requisites

• An application ID from Reclaim Protocol. You can get one from the Reclaim Developer Protocol

Create a new Flutter application

flutter create reclaim_app
cd reclaim_app

Install the Reclaim Protocol Flutter SDK

flutter pub add reclaim_sdk

Import dependencies

In your lib/main.dart file, import the Reclaim SDK

import 'package:reclaim_sdk/flutter_reclaim.dart';
import 'package:reclaim_sdk/types.dart';

Initialize the Reclaim SDK

Declare your application ID and initialize the Reclaim Protocol client. Replace YOUR_APPLICATION_ID_HERE with the actual application ID provided by Reclaim Protocol.

File: lib/main.dart

import 'package:reclaim_sdk/flutter_reclaim.dart';
import 'package:reclaim_sdk/types.dart';

class _MyHomePageState extends State<MyHomePage> {
    String data = "";

    ProofRequest proofRequest = ProofRequest(applicationId: 'YOUR_APPLICATION_ID_HERE');
    @override
    Widget build(BuildContext context) {
        return Scaffold(
            appBar: AppBar(
                backgroundColor: Theme.of(context).colorScheme.inversePrimary,
                title: Text(widget.title),
            ),
            body: Center(
                child: Column(
                    mainAxisAlignment: MainAxisAlignment.center,
                    children: <Widget>[
                        const Text(
                            'Prove that you have Steam ID By clicking on Verify button:',),
                        Text(data,
                            style: Theme.of(context).textTheme.headlineMedium,
                        ),
                    ],
                ),
            ),

        );
    }
}

Add your app deep link

You'll need to add a deep link to your app. This will be used to redirect the user back to your app after they have completed the verification process.

• Guide to setup deep link on react-native can be found here.

import 'package:reclaim_sdk/flutter_reclaim.dart';
import 'package:reclaim_sdk/types.dart';

class _MyHomePageState extends State<MyHomePage> {
    String data = "";

    ProofRequest proofRequest = ProofRequest(applicationId: 'YOUR_APPLICATION_ID_HERE');

    void startVerificationFlow() async {
        proofRequest.setAppCallbackUrl('YOUR_DEEP_LINK'); // here is deep link
    }

    @override
    Widget build(BuildContext context) {
        return Scaffold(
            appBar: AppBar(
                backgroundColor: Theme.of(context).colorScheme.inversePrimary,
                title: Text(widget.title),
            ),
            body: Center(
                child: Column(
                    mainAxisAlignment: MainAxisAlignment.center,
                    children: <Widget>[
                        const Text(
                            'Prove that you have Steam ID By clicking on Verify button:',),
                        Text(data,
                            style: Theme.of(context).textTheme.headlineMedium,
                        ),
                    ],
                ),
            ),

        );
    }
}

Implement Verification Request Function

Create functions to handle the verification request. You'll need separate functions for prototype and production modes due to the different handling of the application secret and signature.

Prototype Mode

For testing purposes, use the prototype mode. Note that in production, you should handle the application secret securely on your server.

File: lib/main.dart

import 'package:reclaim_sdk/flutter_reclaim.dart';
import 'package:reclaim_sdk/types.dart';

class _MyHomePageState extends State<MyHomePage> {
    String data = "";

    ProofRequest proofRequest = ProofRequest(applicationId: 'YOUR_APPLICATION_ID_HERE');

    void startVerificationFlow() async {
        proofRequest.setAppCallbackUrl('YOUR_DEEP_LINK'); // here is deep link

        await proofRequest
            .buildProofRequest("YOUR_PROVIDER_ID");

        proofRequest.setSignature(proofRequest.generateSignature(
            'YOUR_PRIVATE_KEY'));

        await proofRequest.createVerificationRequest();

        final startSessionParam = StartSessionParams(
            onSuccessCallback: (proof) => setState(() {
                data = jsonEncode(proof.extractedParameterValues);
            }),
            onFailureCallback: (error) => {
                setState(() {
                data = 'Error: $error';
                })
            },
        );

        await proofRequest.startSession(startSessionParam);

    }

    @override
    Widget build(BuildContext context) {
        return Scaffold(
            appBar: AppBar(
                backgroundColor: Theme.of(context).colorScheme.inversePrimary,
                title: Text(widget.title),
            ),
            body: Center(
                child: Column(
                    mainAxisAlignment: MainAxisAlignment.center,
                    children: <Widget>[
                        const Text(
                            'Prove that you have Steam ID By clicking on Verify button:',),
                        Text(data,
                            style: Theme.of(context).textTheme.headlineMedium,
                        ),
                    ],
                ),
            ),
            floatingActionButton: FloatingActionButton(
                onPressed: startVerificationFlow,
                tooltip: 'Verify ',
                child: const Text('Verify'),
            ),
        );
    }
}

Production Mode

In production mode, securely fetch and set the signature from your backend instead of using the application secret directly in the client.

Similar to the prototype mode but ensure to fetch and set the signature securely

void startVerificationFlow() async {
    proofRequest.setAppCallbackUrl('YOUR_DEEP_LINK'); // here is deep link

    await proofRequest
        .buildProofRequest("YOUR_PROVIDER_ID");

    proofRequest.setSignature(
        // TODO: fetch signature from your backend
        // On the backend, generate signature using:
        // await Reclaim.getSignature(requestedProofs, APP_SECRET)
    );

    await proofRequest.createVerificationRequest();

    final startSessionParam = StartSessionParams(
        onSuccessCallback: (proof) => setState(() {
            data = jsonEncode(proof.extractedParameterValues);
        }),
        onFailureCallback: (error) => {
            setState(() {
            data = 'Error: $error';
            })
        },
    );

    await proofRequest.startSession(startSessionParam);

}