j832
v1.0.5
Published
SDK for J832 Protocol - Blockchain change logging
Readme
J832 Protocol SDK
Enterprise-grade blockchain audit trails and multi-admin governance — easy integration for any system.
Table of Contents
Production-ready! Contract and SDK stable for integration.
Features
- Immutable audit trails for any entity, resource, or process
- Multi-admin, on-chain approval workflow (add/remove/transfer)
- Tamper-proof, public or private by design (hash-only storage)
- Pagination, status management, and role verification
- Works with any EVM-compatible chain
Contract Address (Testnet)
- Polygon Amoy: 0x1Cb32a904b39D019bE14706D1aCA504002059d9e
Installation
git clone … && cd j832Protocolnpm install.env: define provider URL, keys, contract addressnpm run build && npm test
Quick Start
import { J832, ChangeType } from 'j832';
const sdk = new J832({ providerUrl: process.env.J832_PROVIDER_URL!, contractAddress: process.env.J832_CONTRACT_ADDRESS!, privateKey: process.env.J832_SIGNER_KEY, // Only for write actions });
Usage Examples
Create a Resource
await sdk.createResource({ resourceId: 'HR_PAYROLL', enforceUniqueness: true });
Register a Change
import { keccak256, toUtf8Bytes } from 'ethers';
const data = JSON.stringify({ employeeId: 123, bonus: 500 }); const dataHash = keccak256(toUtf8Bytes(data));
await sdk.registerChange({ resourceId: 'HR_PAYROLL', dataHash, changeType: ChangeType.UPDATE, });
Query Audit Trail
const latest = await sdk.getLatestChange('HR_PAYROLL'); const total = await sdk.getVersionCount('HR_PAYROLL'); const history = await sdk.getHistoryRange('HR_PAYROLL', 0, total);
. Multi-Admin Governance
await sdk.proposeAddAdmin('HR_PAYROLL', '0xNewAdmin...'); await sdk.approveAddAdmin('HR_PAYROLL'); await sdk.proposeRemoveAdmin('HR_PAYROLL', '0xOldAdmin...'); await sdk.approveRemoveAdmin('HR_PAYROLL');
Status and Uniqueness
await sdk.setResourceActiveStatus('HR_PAYROLL', false); const active = await sdk.isResourceActive('HR_PAYROLL'); const uniqueness = await sdk.isUniquenessEnforced('HR_PAYROLL');
Admin & Owner Query
const admins = await sdk.getAdmins('HR_PAYROLL'); const owner = await sdk.getResourceOwner('HR_PAYROLL');
Audit Log Transparency
For maximum auditability and regulatory compliance, J832 SDK exposes a method to retrieve the full on-chain change history via contract events, including transaction hash and block data.
getHistoryRange: Reads the on-chain structs for versioned data (does not include transaction metadata).getHistoryFromEvents: Reads the blockchain event logs, returning all metadata (txHash, blockNumber, etc.) for independent verification.
API Reference (Summary)
📦 Constructor
new J832(config) config: J832Config — Create SDK instance
📝 Resource Management
await sdk.createResource({ resourceId, enforceUniqueness }) await sdk.setResourceActiveStatus(resourceId, active) await sdk.isResourceActive(resourceId) await sdk.setUniqueness(resourceId, enforceUniqueness) await sdk.isUniquenessEnforced(resourceId) await sdk.getVersionCount(resourceId)
🔄 Change Tracking & Audit
await sdk.registerChange({ resourceId, dataHash, changeType }) await sdk.getLatestChange(resourceId) await sdk.getHistoryRange(resourceId, start, count)
🛡️ Admin & Governance
await sdk.getAdmins(resourceId) await sdk.isAdmin(resourceId, address) await sdk.getResourceOwner(resourceId)
await sdk.proposeAddAdmin(resourceId, newAdmin) await sdk.approveAddAdmin(resourceId) await sdk.proposeRemoveAdmin(resourceId, adminToRemove) await sdk.approveRemoveAdmin(resourceId) await sdk.proposeTransferOwnership(resourceId, newOwner) await sdk.approveTransferOwnership(resourceId)
Security Best Practices
NEVER commit private keys or secrets to any repository.
All write actions (createResource, registerChange, admin proposals) must be server-side.
Always pre-hash sensitive data off-chain; never send raw confidential data to the blockchain.
Monitor your RPC endpoint and contract address for changes.
Audit transaction receipts for every call; handle failures gracefully.
MIT
Documentation
Getting Started
API Reference
Governance
Security
FAQ
J832 SDK is open-source, designed for enterprise-grade audit and compliance, and extensible for any regulated industry.
Contributions, bug reports, and security reviews welcome!
License
MIT © 2025 mfelizweb
Support / Contact
📲 Community
