How to Use FlareStudio ProofRails-SDK

What is ProofRails?

Think of it as a receipt printer for blockchain payments, but these receipts are:

-  Tamper proof (stored on blockchain)

-  Internationally compliant (ISO 20022 standard)

-  Instantly verifiable (anyone can check them)

-  Permanent (cannot be deleted or modified)

Who Should Use This?

- DApp developers who need payment receipts

- DeFi platforms requiring transaction records

- NFT marketplaces tracking sales

- Payment processors needing compliance

- Anyone who wants verifiable proof of blockchain payments

No blockchain expertise required.

If you can write JavaScript, you can use ProofRails.

 What You Get

Every transaction processed through ProofRails generates:

1. ISO 20022 XML document

2. Unique receipt ID

3. Blockchain anchor on Flare

4. Verification proof

5. Downloadable files (XML, bundle hash, manifest)

 Getting Started with FlareStudio Proofrails-SDK

Step 1: Install the SDK

```bash

npm install @proofrails/sdk

No backend setup required.

Step 2: Get Your API Key

Option A: Automatic

import ProofRails from '@proofrails/sdk';

const { client, apiKey, projectId } =

await ProofRails.createProject({ label: 'My App' });

console.log(apiKey);

Option B: Manual

1. Visit the ProofRails dashboard
2. Create a project
3. Copy your API key
   

import ProofRails from '@proofrails/sdk';

const proofrails = new ProofRails({

apiKey: 'your-api-key'

});

Creating Your First Receipt

const receipt = await proofrails.templates.payment({

amount: 100,

from: 'Alice',

to: 'Bob',

purpose: 'Freelance work',

transactionHash: '0x123'

});

console.log(receipt.id);

Ready Made Templates

Payment Receipt

await proofrails.templates.payment({...});

Donation Receipt

await proofrails.templates.donation({...});

Escrow Release

await proofrails.templates.escrow({...});

Grant Disbursement

await proofrails.templates.grant({...});

Refund

await proofrails.templates.refund({...});

Working With Receipts

Get Receipt Details

const receipt = await proofrails.receipts.get('receipt-id');

List All Receipts

const { items, total } =

await proofrails.receipts.list({

limit: 10,

status: 'anchored'

});

Download Receipt Files

const artifacts =

await proofrails.receipts.getArtifacts('receipt-id');

Verification

Verify by Receipt ID

await proofrails.verify.byReceiptId('receipt-id');

Verify by Bundle Hash

await proofrails.verify.byHash('0x123...');

Real Time Updates

proofrails.events.listen('receipt-id', (update) => {

console.log(update.status);

});

Using with React

Wrap Your App

<ProofRailsProvider apiKey={process.env.NEXT_PUBLIC_PROOFRAILS_API_KEY}>

{children}

</ProofRailsProvider>

Networks

Coston2 Testnet

new ProofRails({

apiKey: 'key',

network: 'coston2'

});

Flare Mainnet

new ProofRails({

apiKey: 'key',

network: 'flare'

});

Receipt Lifecycle

Create
Process
Anchor
Verify

Receipt Status

pending
anchored
 failed

Best Practices

• Store API keys in environment variables
• Wait for blockchain confirmation
• Save receipt IDs in your database
• Handle errors gracefully

Quick Start Checklist

Install SDK
Get API key
Create receipt
Verify on blockchain
Deploy to mainnet

Why FlareStudio ProofRails-SDK?

For developers
 Fast setup
 No blockchain
 complexity
Production ready

For users

Transparent
Compliant
Permanent

For businesses

Audit trail
 Fraud prevention
Customer trust

Final Note

ProofRails-SDK helps developers and businesses create transparent, compliant, and verifiable payment receipts on blockchain with minimal effort.
For more details visit our repo : https://github.com/Elite-tch/Proofrails-sdk/blob/main/BEGINNER_GUIDE.md