Home

Embedded Signer

Openfort enables players to create a secure, self-custodial embedded signer associated with their login method.

With both kinds of wallets, you can easily request signatures and transactions from your users to have them interact with your product onchain. The logic for making these requests is similar across wallet types, though embedded signers allow for extra customization in terms of how signature and transaction prompts are presented to users.

embedded signers are self-custodial wallets provisioned by Openfort itself for a wallet experience that is directly embedded in your application. embedded signers do not require a separate wallet client, like a browser extension or a mobile app, and can be accessed directly from your product. These are primarily designed for users of your app who may not already have an external wallet, or don't want to connect their external wallet.

Today, users will have at most one embedded signer linked to their account.

Setting up Shield#

1. Getting your Shield API keys#

Generate your Shield API keys from the Openfort dashboard.

generate-delete-api-keys

caution

Encryption share: You mustn't lose your encryption share. If you lose it, you will not be able to recover your recovery shares.

2. Linking your project to shield#

Visit your dashboard settings panel and press on Link Shield to link your project to Shield.

Initialization#

After installing the Openfort SDK in your project, you can initialize the SDK with your Openfort publishable key and Shield API key.

info

This guide shows you through using a hosted Shield instance. If you'd like to host your own Shield instance, please refer to the Advanced self-hosted documentation.

After your project is ready, grab your publishable_key, shield_api_key and shield_encryption_share from your Openfort dashboard.


_10
import Openfort from "@openfort/openfort-js";
_10
const openfort = Openfort('YOUR_OPENFORT_PUBLISHABLE_KEY', "YOUR_SHIELD_API_KEY", "YOUR_SHIELD_ENC_SHARE");

Resources#