Why Build on ShieldFlow?
Everything you need to add privacy to your application.
{ }
TypeScript SDK
Full-featured SDK with type definitions for easy integration.
⛓
Multi-chain Support
Deploy on Ethereum, Gnosis, and other EVM chains.
📦
Modular Architecture
Use only the components you need for your application.
📚
Comprehensive Docs
Detailed documentation with examples and tutorials.
🔓
Open Source
Apache 2.0 licensed. Audit the code yourself.
👥
Active Community
Get help from our Discord and GitHub community.
Quick Start
Get started with just a few lines of code.
example.ts
import { ShieldFlow } from '@shieldflow/sdk';
// Initialize client
const shieldflow = new ShieldFlow({
chainId: 1, // Ethereum mainnet
rpcUrl: process.env.RPC_URL,
});
// Create a deposit
const deposit = await shieldflow.deposit({
asset: 'ETH',
amount: '1.0',
});
// Save the recovery phrase
console.log('Recovery phrase:', deposit.mnemonic);
// Later: withdraw with ZK proof
const withdrawal = await shieldflow.withdraw({
mnemonic: savedMnemonic,
recipient: '0x...',
amount: '1.0',
});Install the SDK:
npm install @shieldflow/sdkArchitecture Overview
Modular components you can use independently or together.
1
Contracts
Solidity smart contracts (Foundry)
Solidity 0.8.282
Circuits
ZK circuits for proof generation
Circom / Groth163
SDK
TypeScript SDK for integration
TypeScript4
ASP Service
Compliance verification service
Node.js5
Relayer
Transaction relay service
Express.js