prooflayer-sdk
v0.1.0
Published
JavaScript/TypeScript SDK for ProofLayer — the blockchain for digital truth
Maintainers
Readme
prooflayer-sdk
The official JavaScript/TypeScript SDK for ProofLayer — cryptographic proof of digital content authenticity.
Installation
npm install prooflayer-sdkQuick Start
import { ProofLayer } from 'prooflayer-sdk'
const client = new ProofLayer({
apiKey: 'pl_live_your_key_here',
baseUrl: 'https://your-prooflayer-instance.com'
})
// Create a proof for a file
const proof = await client.proofs.create(file)
console.log('Proof ID:', proof.proofId)
console.log('AI Score:', proof.aiScore)
console.log('Blockchain TX:', proof.blockchainTxHash)
// Verify a file by re-uploading it
const result = await client.verify.byFile(file)
if (result.result === 'AUTHENTIC') {
console.log('File is authentic!')
console.log('Original proof:', result.proof?.proofId)
}
// Get proof by ID
const proof = await client.proofs.get('PL-A1B2C3D4')
console.log('Creator:', proof.creator.name)API Reference
new ProofLayer(config)
| Option | Type | Required | Default | Description | |--------|------|----------|---------|-------------| | apiKey | string | Yes | — | Your pl_live_... API key | | baseUrl | string | No | https://prooflayer.com | API base URL | | timeout | number | No | 60000 | Request timeout in ms |
client.proofs.create(file, options?)
Create a proof certificate for a file. Returns: Promise<ProofResult>
client.proofs.get(proofId)
Get proof details by ID (format: PL-XXXXXXXX). Returns: Promise<ProofResult>
client.verify.byFile(file, options?)
Verify a file by computing and matching its hash. Returns: Promise<VerifyResult>
client.verify.byId(proofId)
Get and verify a proof by its ID. Returns: Promise<ProofResult>
Error Handling
import { ProofLayer, ProofLayerError } from 'prooflayer-sdk'
try {
const proof = await client.proofs.create(file)
} catch (error) {
if (error instanceof ProofLayerError) {
console.error('Code:', error.code)
console.error('Status:', error.status)
console.error('Message:', error.message)
}
}Get an API Key
Visit https://prooflayer.com/developer to generate your API key.
License
MIT
