👩‍💻 Dev Guide

Previous🏅 Code Audit by Movebit Next🌟 BlockBolt’s First Step — And How Far We’ve Come

Last updated 1 month ago

👩‍💻 Dev Guide

To ensure a seamless and secure integration of the BlockBolt SDK, developers are advised to follow the structured process outlined below.

The BlockBolt SDK package, along with comprehensive technical documentation and release notes, is available here.

1. Installation

The BlockBolt SDK will be published as a standard package. Developers can install it into their project using npm or yarn:

npm install @blockbolt/boltpay-wallet

yarn add @blockbolt/boltpay-wallet

Alternatively, the source code and release archive are available for if manual installation is necessary.

2. Documentation Review

Comprehensive and versioned SDK documentation will be provided to assist developers in:

Understanding the SDK’s architecture
Exploring key features and modules
Reviewing environment requirements and dependencies
Following security best practices for key management and transaction handling

Technical diagrams, transaction flowcharts, and QR payload structures will also be included for clarity.

3. Integration

Developers should refer to the API Reference Guide for precise details on:

SDK class instantiation
Required and optional parameters for each method
Error classes and their handling
Transaction broadcasting and confirmation workflows

Sample code snippets and full integration examples (in ReactJS) will be available to expedite onboarding.

🛠️ The BlockBolt SDK is designed with modularity in mind and can be extended to other frameworks such as Flutter in future releases.

4. Testing

Prior to production deployment, developers must:

Validate SDK functionality in testnet environments
Simulate different QR payment requests and transaction scenarios
Handle edge cases, including transaction failures, QR parsing errors, and network interruptions
Confirm transaction statuses on-chain using digest tracking

Automated test suites and recommended manual test cases will be provided in the repository.

5. Deployment

After successful integration and validation:

Migrate the environment settings from testnet to Sui Mainnet
Ensure secure key management practices are enforced in production
Monitor transaction logs and SDK updates for ongoing improvements

BlockBolt SDK versions will follow Semantic Versioning (SemVer) to ensure predictable upgrade paths.

6. Support

If you encounter any technical issues, require integration assistance, or would like to report bugs, BlockBolt provides multiple support channels:

The BlockBolt team actively monitors support requests and aims to provide timely responses to all developer inquiries.

Additional Notes

Security First: Never expose seed phrases or private keys in the client application. Use secure encrypted storage where needed.
Versioning: Always reference the latest stable SDK release for new applications unless specifically testing beta features.
Chain Compatibility: BlockBolt SDK currently supports Sui Mainnet and Sui Testnet environments. Other network support will be announced in future releases.