Skip to main content

Getting Started

Tweed SDK is a one stop shop for platforms building on Web3. Platforms can offer Web3 features for their users and enable them to interact with on chain assets.

The most fundamental building block of Web3 is the self-custodial wallet, which platforms can automatically spowned on the user's device by using the sdk.wallet.create() function. The wallet opens without any interaction with the user, allowing the smoothest on-boarding experience possible.

With their wallet, the user can now interact with all kinds of on-chain features like Crypto, Tokens, NFTs, dApps etc. With Tweed's SDK the platform controll which features are exposed to the user, providing their own UI and user flows, and building open or closed environments for their users.

For security and functionality reasons, the SDK is divided into two parts: backend and frontend. The backend SDK is where the platform keeps it's data and security layers while the frontend is what interacts with the user and their device.

Both parts of the SDK communicate with each other using a message bus to exchange information about the different requests and to authorize them. The message bus is protocol agnostic and all that is needed is to pass a message string between the components.

SDK structure


The message bus is agnostic to the underlying protocol and can be implemented using any encapsulation method like:

  • REST
  • GraphQL
  • gRPC
  • WebSocket

Refer to the implementation examples for more details.

Implementing Tweed SDK is a very easy task, this manual will not only guide you on the technical details, but also about the UI and user flow that needs to be considered in order to succeed with the implementation.