@proofrails/sdk 1.0.0 → 1.2.0

package/README.md

@@ -1,29 +1,31 @@
+
+````md
 # ProofRails SDK
 
-> **Beginner-friendly SDK for creating blockchain-verifiable ISO 20022 payment receipts**
+**Beginner friendly SDK for creating blockchain verifiable ISO 20022 payment receipts**
 
-Create compliant, auditable payment receipts with just a few lines of code. No blockchain expertise required!
+Create compliant, auditable payment receipts with just a few lines of code. No blockchain expertise required.
 
 ## Features
 
--  **Zero coding knowledge required** - Use simple templates
--  **ISO 20022 compliant** - Generates standard banking messages
--  **Blockchain-verified** - Receipts anchored on Flare blockchain
--  **Tamper-proof** - Cryptographic evidence bundles
--  **Real-time updates** - Live receipt status via SSE
--  **Works everywhere** - TypeScript, JavaScript, Node.js, browsers
+- **Zero coding knowledge required**, use simple templates  
+- **ISO 20022 compliant**, generates standard banking messages  
+- **Blockchain verified**, receipts anchored on Flare blockchain  
+- **Tamper proof**, cryptographic evidence bundles  
+- **Real time updates**, live receipt status via SSE  
+- **Works everywhere**, TypeScript, JavaScript, Node.js, browsers  
 
-##  Installation
+## Installation
 
 ```bash
-npm install @proofrails/sdk
+npm i @proofrails-sdk/sdk
 # or
 yarn add @proofrails/sdk
-```
+````
 
-##  Quick Start
+## Quick Start
 
-### Option 1: Create New Project (Easiest)
+### Option 1, Create New Project (Easiest)
 
 ```javascript
 import ProofRails from '@proofrails/sdk';
@@ -33,11 +35,11 @@ const { client, apiKey, projectId } = await ProofRails.createProject({
   label: 'My App'
 });
 
-console.log('Your API Key:', apiKey); // Save this!
+console.log('Your API Key:', apiKey); // Save this
 console.log('Your Project ID:', projectId);
 ```
 
-### Option 2: Use Existing API Key
+### Option 2, Use Existing API Key
 
 ```javascript
 import ProofRails from '@proofrails/sdk';
@@ -47,7 +49,7 @@ const proofrails = new ProofRails({
 });
 ```
 
-##  Templates (Beginner-Friendly)
+## Templates (Beginner Friendly)
 
 ### Payment Receipt
 
@@ -114,16 +116,16 @@ const receipt = await proofrails.templates.refund({
 });
 ```
 
-##  Core Operations
+## Core Operations
 
 ### Get Receipt
 
 ```javascript
 const receipt = await proofrails.receipts.get('receipt-id');
 
-console.log(receipt.status); // 'pending' or 'anchored'
+console.log(receipt.status);
 console.log(receipt.amount);
-console.log(receipt.anchorTx); // Blockchain transaction (if anchored)
+console.log(receipt.anchorTx);
 ```
 
 ### List Receipts
@@ -134,8 +136,8 @@ const { items, total } = await proofrails.receipts.list({
   status: 'anchored'
 });
 
-items.forEach(receipt => {
-  console.log(receipt.id, receipt.amount);
+items.forEach(r => {
+  console.log(r.id, r.amount);
 });
 ```
 
@@ -149,7 +151,7 @@ console.log('Bundle:', artifacts.bundleUrl);
 console.log('Manifest:', artifacts.manifestUrl);
 ```
 
-##  Verification
+## Verification
 
 ### Verify Receipt
 
@@ -157,7 +159,7 @@ console.log('Manifest:', artifacts.manifestUrl);
 const verification = await proofrails.verify.byReceiptId('receipt-id');
 
 if (verification.valid && verification.onChain) {
-  console.log(' Receipt is valid and on-chain!');
+  console.log('Receipt is valid and on chain');
   console.log('Anchor TX:', verification.anchorTx);
 }
 ```
@@ -178,22 +180,20 @@ console.log('Block Number:', proof.blockNumber);
 console.log('Timestamp:', proof.timestamp);
 ```
 
-##  Live Updates
+## Live Updates
 
 ```javascript
-// Listen to receipt status changes in real-time
-const listener = proofrails.events.listen('receipt-id', (update) => {
+const listener = proofrails.events.listen('receipt-id', update => {
   console.log('Status:', update.status);
-  
+
   if (update.status === 'anchored') {
-    console.log('Receipt is now on-chain!');
-    console.log('Anchor TX:', update.anchorTx);
-    listener.stop(); // Stop listening
+    console.log('Receipt is now on chain');
+    listener.stop();
   }
 });
 ```
 
-##  Embeddable Widgets
+## Embeddable Widgets
 
 ### Generate Widget
 
@@ -204,7 +204,6 @@ const widget = proofrails.embed.widget('receipt-id', {
   height: '400px'
 });
 
-// Use in HTML
 document.getElementById('receipt').innerHTML = widget.iframeHtml;
 ```
 
@@ -212,201 +211,34 @@ document.getElementById('receipt').innerHTML = widget.iframeHtml;
 
 ```javascript
 const pageUrl = proofrails.embed.fullPage('receipt-id');
-// https://middleware.com/receipt/receipt-id
-```
-
-##  Statements
-
-### Generate Intraday Statement
-
-```javascript
-const statement = await proofrails.statements.intraday({
-  dateFrom: '2024-01-01',
-  dateTo: '2024-01-31',
-  accountId: 'my-account'
-});
-
-console.log('Download:', statement.downloadUrl);
-```
-
-### Generate End-of-Day Statement
-
-```javascript
-const statement = await proofrails.statements.endOfDay({
-  dateTo: '2024-01-31',
-  accountId: 'my-account'
-});
 ```
 
-##  Project Management
-
-### Get Project Info
+## Networks
 
 ```javascript
-const info = await proofrails.project.getInfo();
-console.log('Project ID:', info.projectId);
-```
-
-### Rotate API Key
-
-```javascript
-const newKey = await proofrails.project.rotateKey();
-console.log('New API Key:', newKey.apiKey); // Save this!
-
-// Update client with new key
-proofrails.setApiKey(newKey.apiKey);
-```
-
-##  Admin Operations
-
-```javascript
-const admin = new ProofRails({ adminToken: 'your-admin-token' });
-
-// Create API key for specific project
-const key = await admin.admin.createKey({
-  projectId: 'proj-123',
-  label: 'Production Key'
-});
-
-  label: 'Production Key'
-});
-
-// Delete API key
-await admin.admin.deleteKey('key-id');
-```
-
-##  Networks
-
-```javascript
-// Testnet (default)
 const proofrails = new ProofRails({
   apiKey: 'your-key',
   network: 'coston2'
 });
-
-// Mainnet
-const proofrails = new ProofRails({
-  apiKey: 'your-key',
-  network: 'flare'
-});
 ```
 
-##  Advanced Configuration
-
 ```javascript
 const proofrails = new ProofRails({
   apiKey: 'your-key',
-  network: 'coston2',
-  baseUrl: 'https://custom-middleware.com', // Optional
-  timeout: 60000 // Request timeout in ms (default: 30000)
-});
-```
-
-##  React Hooks (New!)
-
-The SDK exports dedicated React hooks for the easiest integration experience.
-
-### Setup
-
-```typescript
-import { useProofRails } from '@proofrails/sdk/react';
-
-// Initialize the hook
-const sdk = useProofRails({ 
-  apiKey: 'your-api-key' 
-});
-```
-
-### Sending Payments (Zero Boilerplate)
-
-```typescript
-import { useProofRailsPayment } from '@proofrails/sdk/react';
-
-const { send, loading, receipt, status } = useProofRailsPayment(sdk);
-
-const handleMyButton = async () => {
-    await send({
-        amount: "10.0",
-        to: "0xReceiverAddress...",
-        purpose: "Payment for Services"
-    });
-};
-```
-
-### Self-Serve Project Creation
-
-```typescript
-import { useCreateProject } from '@proofrails/sdk/react';
-
-const { create, loading } = useCreateProject();
-
-const setup = async () => {
-    const { apiKey, projectId } = await create("My New dApp");
-    console.log("My new key:", apiKey);
-};
-```
-
-##  TypeScript Support
-
-Full TypeScript support with type definitions included:
-
-```typescript
-import ProofRails, { Receipt, VerificationResult } from '@proofrails/sdk';
-
-const proofrails = new ProofRails({ apiKey: 'your-key' });
-
-const receipt: Receipt = await proofrails.templates.payment({
-  amount: 100,
-  from: 'Alice',
-  to: 'Bob',
-  purpose: 'Payment',
-  transactionHash: '0x123...'
+  network: 'flare'
 });
-
-const verification: VerificationResult = await proofrails.verify.byReceiptId(receipt.id);
 ```
 
-##  JavaScript (No TypeScript)
-
-Works perfectly in plain JavaScript too:
-
-```javascript
-const ProofRails = require('@proofrails/sdk');
-
-const proofrails = new ProofRails({ apiKey: 'your-key' });
-
-// Same API, no types needed!
-```
-
-##  Error Handling
-
-```javascript
-import { ProofRailsError } from '@proofrails/sdk';
-
-try {
-  const receipt = await proofrails.receipts.get('invalid-id');
-} catch (error) {
-  if (error instanceof ProofRailsError) {
-    console.error('Error:', error.message);
-    console.error('Code:', error.code);
-    console.error('Status:', error.statusCode);
-  }
-}
-```
-
-##  License
+## License
 
 MIT
 
-##  Support
+## Support
 
-- Documentation: [docs.proofrails.com](https://docs.proofrails.com)
-- Issues: [GitHub Issues](https://github.com/proofrails/proofrails-sdk/issues)
-- Email: support@proofrails.com
-
----
+* Documentation, [https://www.flarestudio.xyz/sdk/proofrails-sdk/overview](https://www.flarestudio.xyz/sdk/proofrails-sdk/overview)
+* Repository, [https://github.com/Elite-tch/Proofrails-sdk.git](https://github.com/Elite-tch/Proofrails-sdk.git)
+* Email, [izuchukwujohnbosco95@gmail.com](mailto:izuchukwujohnbosco95@gmail.com)
 
 **Made with ❤️ by ProofRails**
-# Proofrails-sdk
-
-
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@proofrails/sdk",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "description": "Beginner-friendly SDK for ProofRails ISO 20022 Middleware - Create blockchain-verifiable payment receipts with zero coding knowledge",
     "main": "dist/index.js",
     "module": "dist/index.mjs",