@openfort/openfort-js - v0.8.18
Website | Documentation | API Docs | Twitter
Openfort.js Library
The Openfort js library provides convenient access to handle client session keys and return signed messages back to Openfort from applications written in client-side JavaScript.
Installation
npm install @openfort/openfort-js
yarn add @openfort/openfort-js
Usage
With the Openfort Unity SDK, you can sign transaction intents using one of four methods or signers:
const sdk = new Openfort({ baseConfiguration: { publishableKey: "pk_test_XXXXXXX"} });
1. Session Signer
The Session Signer allows you to use external signing keys, without needing to provide it every time. Here's how to use it:
- Configure the Session Key: Call
configureSessionKey(). This method returns an Ethereum address and a boolean indicating whether you need to register the key from the backend.
const sessionKey = sdk.configureSessionKey();
- Register Key and Send Signature Session Request: If
sessionKey.isRegisteredboolean is false, register the key from the backend. Refer to the documentation for session management. - Send Signature Transaction Intent Request: When calling sendSignatureTransactionIntentRequest, pass the transaction intent ID and the user operation hash. The session signer will handle the signing.
2. External Sign
This method allows you to externally sign transaction intents without logging in or additional configurations:
- Call SendSignatureTransactionIntentRequest: Simply pass the transaction intent ID and the signature.
const response = await sdk.sendSignatureTransactionIntentRequest("tin_xxxx", '0xUserOperationHash');
3. Embedded Signer
The Embedded Signer uses SSS to manage the private key on the client side. To learn more, visit our security documentation.
- Login and Configure the Embedded Signer: First, ensure the user is logged in, using
LoginWithEmailPassword,AuthenticateWithOAuthor if not registredSignUpWithEmailPassword. Then callConfigureEmbeddedSigner.
const shieldAuth: ShieldAuthentication = {
auth: ShieldAuthType.OPENFORT,
token: identityToken,
authProvider: "firebase",
tokenType: "idToken",
};
await sdk.loginWithEmailPassword("email", "password");
// using automatic recovery
await sdk.configureEmbeddedSigner(chainId, shieldAuth);
For now the only two recovery method available are the PasswordRecovery and AutomaticRecovery. Learn more about the recovery methods.
- Send Signature Transaction Intent Request: Similar to the session signer, pass the transaction intent ID and the user operation hash. The embedded signer reconstructs the key and signs the transaction.
const response = await sdk.sendSignatureTransactionIntentRequest("transactionIntentId", "userOp");