Developers

/

November 20, 2023

Portkey Developer Documentation Upgraded, Facilitating Projects’ Transition to Web3 and Unlocking Versatile Functionalities

Blog Image

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.

🐦 Twitter | 🎮 Discord | 💬 Telegram | 🏠 Website | 💻 Youtube

Author Image
Portkey
WalletWhy It Stands OutSupported Assets
Coinbase- Publicly-listed on the Nasdaq stock exchange- Holds your assets in a 1:1 ratio and does not repurpose them200+ cryptocurrencies, including BTC, ETH, XRP, and SOL
OKX- Supports 300+ cryptocurrencies and NFTs across multiple networks- Available as a mobile or desktop app, and browser extensionBTC, ETH, XRP, SOL, and 300+ more cryptocurrencies, along with NFTs on Ethereum, Solana, BASE, and more
Crypto.com App- Rewarding if you hold and build a cryptocurrency portfolio over time- Nifty features like Crypto Earn and Recurring Buy help you grow your holding easilyMore than 350 cryptocurrencies, including BTC, ETH, XRP, and SOL
Trust Wallet- Very wide range of assets- Available as a mobile app and browser extensionOver 10 million cryptocurrencies and 600 million NFTs from Bitcoin, Ethereum, Solana, Cosmos, and more
MetaMask- Can be used to complement your main Web3 wallet- Perfect for ownership of Ethereum-based tokens and NFTsAny asset on the Ethereum blockchain
Exodus- Over 100,000 cryptocurrencies supported- Buy any of them within the Exodus walletMore than 100,000 cryptocurrencies and NFTs across 16 blockchains
Ledger Stax- 5,500+ cryptocurrencies and NFTs supported- Certified Secure Element chip to shield it from online attacks5,500+ cryptocurrencies and NFTs
Trezor Safe 5- A compact device at 23g with a 1.54-inch touchscreen- Supports over 1,000 cryptocurrencies, and has a CC EAL6+-certified chipOver 1,000 cryptocurrencies, including BTC, ETH, XRP, and SOL
SafePal S1 Pro- Slim and sleek, with a 1.3-inch colour screen to show your holdings- Can be paired with the SafePal Wallet app and browser extension to grow your portfolio30,000 cryptocurrencies and more across 100+ blockchains
ZKPsMultisig WalletsTEE
StrengthsZKPs provide wallet owners with security and privacy at one goMultisig wallets are hassle-free and secure; easy to implement for any group or organisationTEEs allow Web3 wallets to achieve a similar level of security as hardware wallets
WeaknessesTransacting parties need to interact multiple times. It’s not ideal for non-real-time applications.Transaction costs are higher due to the multiple signatures – and gas fees – needed. Transaction speeds are lower too.Cannot be easily implemented for software-based Web3 wallets as it is operating system-dependent
Wallet TypeHardware WalletBrowser ExtensionMobile App Wallet
Pros- Offers the best security for Web3 digital assets- Many brands and models to choose from- You can conveniently add it to your web browser- It doesn’t take up much storage space on your PC- You can access your assets from anywhere- You can easily transfer assets between apps
Cons- You risk losing your assets when you lose the device- The cost can be prohibitive for some- Susceptible to security breaches if your browser is compromised- Functionality may be limited for some- Vulnerable to similar security breaches as browser extension wallets- You also bear the same risk of losing your assets if you lose your mobile device
Web2 PhishingWeb3 Phishing
MethodPurely reliant on offline or Web2 platforms. For example, phone calls, SMSes, publishing fake websites, etc.Utilises a mix of Web2 and Web3 platforms. For example, hackers impersonating a key opinion leader or deploying malicious smart contracts.
PurposeTo steal cash, personal information, and sensitive data.To steal digital assets and sensitive data, and control Web3 projects.
ProsCons
MPC wallets are incredibly safe thanks to their novel security mechanism.There are relatively fewer MPC wallet solutions available, as compared to multisig wallets.
MPC wallets provide you with more flexibility in managing your assets, especially if it’s a wallet for institutions or investment groups.MPC wallets appear easy to use on the outset, but they still require a level of technical expertise and cryptography knowledge.
MPC wallets greatly reduce the risk of a single point of failure.MPC wallets can take slightly longer to execute transactions because its security mechanism is fairly resource-intensive.
MPC wallets are highly decentralised, adhering to cryptocurrency’s core principles.You’d still need to manage each private key fragment carefully. After all, each one is crucial to forming the full key.