Changelog
Version 0.6 - February 21, 2025
This release delivers consolidated TPP APIs with enriched documentation. Note that the TPP payload structure may change in future releases and pagination improvements for real-time updates are ongoing. For details, please refer to each feature’s description.
New Features
- Tokenized Product Passport (TPP) APIs: Implemented TPP APIs to manage the complete lifecycle of tokenized product passports, including job creation, monitoring, and real-time updates via SSE.
Improvements
- Uniform Pagination During Real-Time Updates: Ensure that pagination remains stable and intuitive even as live data changes occur, such as when new tokens or NFTs are added.
Known Issues
- Unstable TPP Payload: The structure of the TPP API payload is evolving and may be adjusted in future releases.
Version 0.5 - February 10, 2025
This release introduces key improvements and new features: upgradeable Starknet contracts with meta transaction support; extended multilingual support across various components; built-in client share storage; and a new customizable sign-in component for flexible authentication. These updates enhance functionality, security, and usability across different environments.
New Features
- Starknet Support: Keyban Wallet now supports the Starknet blockchain, enabling users to interact with Starknet-based tokens, NFTs, and smart contracts.
- Built-in Client Share Storage: Introduced a built-in solution for secure client share storage. This feature allows integrators to easily store and manage client shares without requiring a custom implementation, improving security and simplifying integration processes.
- New Sign-In Component: Added a new `SignIn` component designed to provide flexible authentication options. The component supports multiple authentication methods, including Google, Facebook, and username/password login. It is customizable and includes multilingual support to improve accessibility and user experience in various regions.
Version 0.4 - January 20, 2025
This release introduces a new authentication system with improved user management and session handling, alongside several quality-of-life enhancements.
New Features
- New Authentication System: Implemented a robust authentication system with Auth0, including login, logout, and session management. Features include a smoother login flow, support for refresh tokens, and integration with Google sign-in.
Non-Functional Requirements
- Dependency Updates: Updated dependencies to React 19, React DOM 19, and other packages to ensure compatibility and performance.
Known Issues
- Core Features Missing: This initial release does not include several core features planned for future versions. These features are scheduled for version 1.0
- Limited Testing in Production Environments: This initial release has not been extensively tested in production environments. Users may encounter unforeseen issues and are encouraged to provide feedback.
Version 0.3 - December 11, 2024
This release focuses on significant system infrastructure upgrades and enhancements to transaction management
New Features
- Transaction History: Provided users with transaction history categorized by different token types for better tracking and management. Additionally, implemented pagination to improve load times and user experience when dealing with large amounts of data.
- Pagination for ERC-20 Tokens and Balances: Added pagination support for ERC-20 token lists and balances to enhance performance and usability.
- Pagination for NFTs, Metadata, and Balances: Implemented pagination for NFTs, their metadata, and balances to handle large collections efficiently.
Non-Functional Requirements
- No more Earthly Cloud: Migrated away from Earthly Cloud to improve infrastructure reliability and performance.
- Blockscout to Subquery Migration: Migrated from Blockscout to Subquery to enhance indexing capabilities and performance for blockchain data retrieval.
Known Issues
- Limitation on Retrieving NFTs in Large Wallets: This limitation has been resolved through the implementation of pagination.
- Core Features Missing: This initial release does not include several core features planned for future versions. Features such as ERC-721 & ERC-1155 support, environment segregation by AWS accounts, Zero Trust Architecture, transaction history components, and others are not yet available. These features are scheduled for version 1.0.0.
- Limited Testing in Production Environments: This initial release has not been extensively tested in production environments. Users may encounter unforeseen issues and are encouraged to provide feedback.
Version 0.2 - October 11, 2024
This version introduces support for ERC-721 and ERC-1155 tokens, along with enhanced NFT handling and transfer features.
New Features
- Use of useKeybanAccountNfts Hook to Retrieve NFT Balances: Implemented the React hook useKeybanAccountNfts to retrieve ERC721 and ERC1155 tokens from an account.
- ERC-721 and ERC-1155 Fee Estimation, and Transfers: Implemented functionality to estimate fees and transfer ERC-721 and ERC-1155 tokens in the SDK. Added associated methods in the KeybanAccount class, including estimateNftTransfer(), getNfts(), getNft(), and transferNft().
- Addition of 'Retrieve NFT Data by ID' Feature: Added a new test feature to retrieve data for a specific NFT by its ID. Note: This feature has a current limitation where it may fail to retrieve an NFT if the user's wallet contains more than 50 NFTs. This behavior is not ideal but is sufficient for now.
Known Issues
- Limitation on Retrieving NFTs in Large Wallets: The feature that retrieves an NFT by its ID may fail if the user's wallet contains more than 50 NFTs. A more robust solution is planned for a future version.
- Core Features Missing: This initial release does not include several core features planned for future versions. Features such as ERC-721 & ERC-1155 support, environment segregation by AWS accounts, Zero Trust Architecture, transaction history components, and others are not yet available. These features are scheduled for version 1.0.0.
- Limited Testing in Production Environments: This initial release has not been extensively tested in production environments. Users may encounter unforeseen issues and are encouraged to provide feedback.
Version 0.1 - October 04, 2024
Initial release of the Keyban SDK. This release includes foundational features and is intended for early testing and development. Production use is not recommended until core features are fully integrated.
New Features
- SDK Quick Start Guide: A comprehensive guide for developers to get started with the Keyban SDK, including setup instructions and usage examples.
- ECDSA MPC TSS Signer: A component for ECDSA-based transaction signing using MPC TSS. It supports secure signature generation for blockchain transactions.
- Unified Error Handling and Loggers for ECDSA Signer: A unified error handling system with logging mechanisms compliant with RFC 9457, ensuring consistent and comprehensive logging across the system.
- React EOA Account: A React component for managing and interacting with Externally Owned Accounts (EOA).
- React Native Currency Balance Display with RPC Node: A React hook that displays native currency account balances by interacting with an RPC node.
- React Cryptocurrency Send Method: A method enabling users to send cryptocurrency from an Externally Owned Account (EOA).
- MPC TSS EOA Wallet Demo: A demonstration of how to manage Externally Owned Accounts (EOAs) using MPC TSS.
- React Non-Native Balance (ERC-20) Display: A React hook that displays ERC-20 token balances by querying an indexer for real-time data.
- React Network Selection Component: A component that allows users to select the network for blockchain interactions, supporting Ethereum Sepolia and more to come.
- Transaction Fee Estimation for Native and ERC-20 Transfers: A feature that estimates transaction fees for both native tokens and ERC-20 token transfers, helping users anticipate costs.
- React Token Send (ERC-20) Component: A React component that allows users to securely send ERC-20 tokens between wallets.
- Secure EOA Management and Token-Based Access Control: A secure mechanism for managing Externally Owned Accounts (EOA) with token-based access control, enhancing user security.
Known Issues
- Core Features Missing: This initial release does not include several core features planned for future versions. Features such as ERC-721 & ERC-1155 support, environment segregation by AWS accounts, Zero Trust Architecture, transaction history components, and others are not yet available. These features are scheduled for version 1.0.0.
- Limited Testing in Production Environments: This initial release has not been extensively tested in production environments. Users may encounter unforeseen issues and are encouraged to provide feedback.