Portkey Developer Documentation Upgraded, Facilitating Projects’ Transition to Web3 and Unlocking Versatile Functionalities
Portkey is more than thrilled to announce the comprehensive upgrade of Portkey developer documentaion for the software development kits (SDKs), an extensive suite of tools crafted to facilitate the transition from Web2 to Web3 for developers and projects. By integrating Portkey SDKs, developers gain the ability to rapidly create Web3 accounts for users, featuring customisable functionalities such as crypto asset management, social recovery, payment delegation, fiat-crypto on/off-ramps, and more. The live documentation for the SDKs is readily available on the Portkey website under “Developers” > “Documentation.”
Seamless Integration and Powerful Functionalities
Portkey offers a range of SDKs tailored to diverse needs, each embedding the same robust set of functionalities. Whether developers choose any of the SDK options, they can effortlessly incorporate the following features into their projects:
- Creating Web3 accounts
- Delivering a frictionless Web2 login experience
- Managing digital assets
- Issuing tokens or NFTs
- Facilitating fiat-to-crypto conversions and vice versa
- Enabling NFT checkouts
- Plus, more versatile features under development!
Thanks to Portkey SDKs, developers can harness a plethora of Web3 benefits, including heightened decentralisation and boundless innovation, without the hassels of building from scratch. The plug-and-play design empowers developers to launch a Web3-native DApp or transition existing projects to Web3 within hours.
Beyond expediting development, Portkey SDKs unlock additional functionalities that elevate security and enrich the users experience in Web3. For instance, all user accounts created with Portkey SDKs enjoy the social recovery mechanism where decentralised service providers add an extra layer of protection, compared to other wallet infrastructures. Moreover, projects have the option to leverage the payment delegation mechanism. This feature allows projects to cover transaction fees on behalf of users, alleviating the burden of users having to pay substantial sums to engage with Web3.
Core SDK and UI SDK
Portkey offers two main types of SDKs: Core SDK and UI SDK, each tailored to distinct scenarios:
Core SDK:
- Ideal for developers looking to implement fundamental features while having the flexibility to define and develop specific workflows independently.
- Provides convenient access to Portkey’s APIs and smart contracts, catering to more sophisticated needs for developers and enterprises.
- Suited for those who prefer a more hands-on approach in shaping their application’s functionality.
UI SDK:
- Designed for developers seeking higher efficiency with pre-defined UI and UX flows.
- Allows developers to utilise Portkey’s wallet interface while retaining the ability to customise designs to align with their preferences.
- Particularly suitable for developers who haven’t built their own UI/UX or prefer to use Portkey’s UI/UX, offering a seamless integration.
Moreover, these two SDKs differ in the way they are used: Core SDK facilitates API calls, providing greater flexibility, while Portkey UI SDK allows for direct referencing, streamlining the integration process for developers.
Comprehensive Support Across Multiple Languages and Platforms
In addition to the general classification into Core SDK and UI SDK based on usage scenarios, both SDK types further branch into various categories depending on the languages used or platforms supported. Currently, Portkey offers SDKs in TypeScript, Unity, Android, and iOS, with plans to expand based on developer feedback.
This diverse array of SDKs caters to developers with varying requirements, providing them with versatile tools to implement both fundamental and customisable functionalities. The realised and upcoming features for each SDK are detailed in the table below.
It’s noteworthy that Portkey offers substantial support to developers, especially those working on gaming projects. All these features are designed to be efficiently utilised by game developers, enabling a user-friendly sign-up/login experience, seamless asset management services, and hassle-free in-game asset creation, distribution, and conversion.
As a testament to the capabilities of Portkey SDK, it has been successfully implemented in developing a Web3 game, BeanGo Town — a monopoly-inspired on-chain game. You can play the game and witness how Portkey SDK effortlessly introduces the smooth Web2 experience to the Web3 landscape.
Distinctive Advantages of Portkey SDKs
Portkey SDKs outperform competitors through its Web2-like user experience, unique approach to account abstraction (AA), robust security via social recovery, and the cost-effective usage facilitated by the payment delegation mechanism.
- Web2-like user experience: Portkey allows users to create accounts without the need to memorise private keys and seed phrases. By providing Web2 social information and verifying identities through codes sent to their Web2 accounts, users experience a simplified sign-up/login process. This approach is markedly user-friendly and more secure compared to traditional externally owned account (EOA) wallets, which involve managing private keys and pose a risk of theft or hacking if keys are compromised.
- Unique approach to AA: Unlike Ethereum projects transitioning to AA via ERC-4337, Portkey takes a distinctive approach by implementing AA through aelf’s groundbreaking Virtual Address (VA) design. VA utilises algorithms to generate unique virtual accounts, eliminating the necessity to deploy individual smart contracts as mandated by ERC-4337. This innovative method significantly reduces the cost associated with account creation. Furthermore, the transaction processing flow in VA is streamlined compared to ERC-4337, involving a smaller number of roles in the process.
- Social recovery: Portkey’s social recovery mechanism allows users to designate trusted parties or their other social accounts as guardians. These guardians secure the user’s wallet and help in the social recovery process by collecting identity verification results. Additionally, Portkey introduces verifiers, external verification service providers, enhancing overall security and decentralisation in social recovery.
- Payment delegation mechanism: Acknowledging that fees associated with account creation and other usages might be intimidating for users, Portkey offers the payment delegation mechanism as a solution. Voluntary delegatees can cover fees generated by user activities, effectively reducing costs for users and removing barriers to user acquisition for projects. Whether projects themselves or third-party entities that agree to serve as this role, delegatees can choose the specific types of transaction fees they want to cover. This establishes a mutually beneficial delegation process that benefits users, projects, and delegatees alike.
As part of Portkey’s developer-centric services, we offer comprehensive SDKs along with essential APIs. Our commitment to assisting developers is further exemplified through step-by-step documentation. Here, we not only delve into the intricacies of the code in detail but also complement it with sample codes and references for easier comprehension.
If you find these features aligning with your development goals, we encourage you to explore the docs thoroughly and leverage it to facilitate your transition to Web3. Should you have any questions or encounter difficulties, feel free to reach out to our team via the provided social channels.
Explore the vast possibilities and embrace the future of decentralised Web3 with Portkey SDKs. Your journey into Web3 development starts here.
