Skip to main content

What is Portkey?

What is Portkey?

Portkey is the first AA wallet from aelf's ecosystem, migrating users, developers and projects from Web2 to Web3 with DID solution.

Users can swiftly log into Portkey via their Web2 social info with no private keys or mnemonics required. Underpinned by social recovery and decentralized guardian design, Portkey safeguards users' assets from centralized control and theft. Portkey has a unique payment delegation mechanism which enables interested parties to function as delegatees to pay for user activities on users' behalf. This means that users can create accounts for free and fees for other usages may also be covered in Portkey.

Portkey also provides crypto on/off-ramp services, allowing users to exchange fiat with crypto freely. It supports the storage and management of various digital assets such as tokens, NFTs, etc. The compatibility with multi-chains and seamless connection to all kinds of DApps makes Portkey a great way to enter the world of Web3.

With DID solution as its core, Portkey provides both Portkey Wallet and Portkey SDKs.

What is Portkey DID solution?

Portkey DID provides the solution for Web2 games and projects to establish Web3 identities and create on-chain addresses for their users, via the process of verifying users' Web2 accounts, and assigning managing addresses to be linked to their accounts, and further control and manage the private keys of user's wallet accounts being stored on users' local device via the managing addresses.

It is also the key mechanism for social recovery. Whenever a user logs in for the first time on a device or logs back in after logging out, he needs to verify himself in a decentralized way, to ensure no one has control of his account.

The identity verification process can be divided into two parts. First, the user's social account needs to be verified by “verifiers,” the external service providers sending verification codes to the corresponding social accounts of the guardians, and guardians will release approvals for account registration or login depending on the verification results. Secondly, when the number of guardians is no more than three and all provide approval, or a proportional percentage of the total number of guardians provide approval when the number of guardians exceeds three, a manager address on the device will be generated and linked to the users’ AA wallet account, which can then be controlled.

What does Portkey SDK provide?

Portkey SDK offers a comprehensive array of kits designed to cater to the diverse requirements of developers transitioning to Web3 and seamlessly integrating Web3 wallets. These SDKs empower developers to effortlessly create or issue digital assets and equip them with a wide spectrum of capabilities, including on/off-ramp services, NFT check-out, cross-chain bridges, swaps, and more, ensuring they can tailor their solutions to meet specific demands.

Broadly speaking, there are two types of SDKs: Portkey Core SDK and Portkey UI/UX SDK. Both support the same functionalities, but they cater to different development needs. Portkey Core SDK facilitates API calls, while Portkey UI/UX SDK allows for direct referencing.

Portkey SDKs are also available in multiple programming languages and across various platforms, encompassing TypeScript, Unity, Android, and iOS. This diverse range of SDKs accommodates developers with different demands, offering them the tools to execute both fundamental and customizable functionalities.

Portkey Core SDK:

Portkey SDK comes equipped with the baisc features such as Signup, Login, and Social Recovery. With Portkey DID SDK, projects and developers can easily bridge the Web2 accounts of their users with the Web3 identities their users create and own via Portkey.

Portkey UI/UX SDK:

Developers can leverage the Portkey UI/UX SDK to build the wallet interface for their own applications with customized designs. They can also customize user login methods, enhancing user accessibility and convenience within the application.

Other SDKs Portkey integrates with:

Portkey SDK extends its functionality through integration with a range of other diverse SDKs. These include the On-off Ramp for effortless fiat and crypto exchanges, the NFT Marketplace for trading digital assets, and the forthcoming cross-chain bridge and swap functionalities. These integrations offer developers a versatile toolkit to build innovative and feature-rich applications.

What can you build with Portkey SDKs?

As the preferred solution for projects to enter Web3, Portkey enables Web2 projects to build applications on layer-1 network aelf by integrating with its developer tools. Portkey can help developers achieve easy-onboarding, low-cost, rapid, and secure blockchain integration.

Features of integrating Portkey SDKs:

Use CasesDescription
GamesIntegrate a AA wallet at no cost
Familiar web2 login for easy user onboarding
Effortlessly take your game assets on-chain
Fast and cheap in-game transactions
Full control and ownership of players in-game assets
Access to the user resources within aelf ecosystem
Swap and DEX PlatformsEasy-to-use wallet simplifying operations
Fast, cheap and secure transactions between users
Cross-chain interoperability
Safety ensured by standardized and audited code practices
High-performance network aelf ensures scalability
NFT MarketplacesEasy-to-use wallet, tailored to users' needs
Facilitation of non-fungible token trading and presentation
Significant reduction in development expenditures
Other types of Web3 tools and DappsFree exploration of any type of BUIDL with Portkey SDK and its functionalities
Supported by high performance and low cost layer 1 network, aelf

Whether it's a game studio or an independent developer, you can quickly build and deploy games. We've crafted comprehensible developer documentation, providing DEMOs for each crucial step to streamline your game development journey. You can focus on creating engaging gaming experiences, bring your games to the market as soon as possible.

Example functionality matrix

Connect to user wallet Manage user asset on/off rampNFT checkout
Sign-up, Login Logout Get list of assets Send/receive assets
Core SDK Typescript
Unity 🚀 🚀
Android SDK 🚀 🚀 🚀 🚀 🚀 🚀
iOS SDK 🚀 🚀 🚀 🚀 🚀 🚀
UI SDK Typescript
Unity 🚀 🚀 🚀
Android SDK 🚀 🚀 🚀 🚀 🚀 🚀
iOS SDK 🚀 🚀 🚀 🚀 🚀 🚀
ReactNative SDK

🚀 : coming soon

Why Portkey solution?

Easy onboarding

Portkey SDK helps developers, applications and projects onboard users as easily and fast as possible. It allows users to create and log into Web3 wallet accounts with just their Web2 existing accounts, without having to memorizing the complicated and easy-to-lose seed phrases.

Free to use

Portkey SDK is totally open-sourced and free-to-use for developers.

Enhanced Security

Portkey DID SDK encompasses social recovery logic SDK which projects and developers can leverage to protect their users' Web3 assets. Social recovery decouples users accounts with their private keys to eliminate the risk of singular point. Under social recovery mechanism, user accounts are safeguarded by decentralized guardians imparting users' accounts with not only total self-custody but also upgraded security. On top of that, as indicated by its name, social recovery makes Web3 wallets recoverable and prevent users from losses when when they accidentally lose devices which have their accounts.

Unlimited Scalability and Interoperability

Backed by high performance layer 1 network, aelf, using Portkey SDK also comes with enjoying unlimited scalability. In the meantime, Portkey SDK will also support multiple chains in the future, providing interoperability to developers and applications.