# Into the Hybrid Custody
```
#allowAccountLinking
import FungibleToken from "../contracts/utility/FungibleToken.cdc"
import FlowToken from "../contracts/utility/FlowToken.cdc"
import MetadataViews from "../contracts/utility/MetadataViews.cdc"
import HybridCustody from "../contracts/utility/HybridCustody.cdc"
import CapabilityFactory from "../contracts/utility/CapabilityFactory.cdc"
import CapabilityFilter from "../contracts/utility/CapabilityFilter.cdc"
/// Links child account to the parent account.
/// Parent account gets capabilities of managing Swirl tokens and NFTs.
transaction(
pubKey: String,
factoryAddress: Address,
filterAddress: Address
) {
prepare(child: AuthAccount, parent: AuthAccount) {
/* --- Link the AuthAccount Capability --- */
//
var acctCap = child.linkAccount(HybridCustody.LinkedAccountPrivatePath)
?? panic("problem linking account Capability for new account")
// Create a OwnedAccount & link Capabilities
let ownedAccount <- HybridCustody.createOwnedAccount(acct: acctCap)
child.save(<-ownedAccount, to: HybridCustody.OwnedAccountStoragePath)
child
.link<&HybridCustody.OwnedAccount{HybridCustody.BorrowableAccount, HybridCustody.OwnedAccountPublic, MetadataViews.Resolver}>(
HybridCustody.OwnedAccountPrivatePath,
target: HybridCustody.OwnedAccountStoragePath
)
child
.link<&HybridCustody.OwnedAccount{HybridCustody.OwnedAccountPublic, MetadataViews.Resolver}>(
HybridCustody.OwnedAccountPublicPath,
target: HybridCustody.OwnedAccountStoragePath
)
// Get a reference to the OwnedAccount resource
let owned = child.borrow<&HybridCustody.OwnedAccount>(from: HybridCustody.OwnedAccountStoragePath)!
// Get the CapabilityFactory.Manager Capability
let factory = getAccount(factoryAddress)
.getCapability<&CapabilityFactory.Manager{CapabilityFactory.Getter}>(
CapabilityFactory.PublicPath
)
assert(factory.check(), message: "factory address is not configured properly")
// Get the CapabilityFilter.Filter Capability
let filter = getAccount(filterAddress).getCapability<&{CapabilityFilter.Filter}>(CapabilityFilter.PublicPath)
assert(filter.check(), message: "capability filter is not configured properly")
// Configure access for the delegatee parent account
owned.publishToParent(parentAddress: parent.address, factory: factory, filter: filter)
/* --- Add delegation to parent account --- */
//
// Configure HybridCustody.Manager if needed
if parent.borrow<&HybridCustody.Manager>(from: HybridCustody.ManagerStoragePath) == nil {
let m <- HybridCustody.createManager(filter: filter)
parent.save(<- m, to: HybridCustody.ManagerStoragePath)
}
// Link Capabilities
parent.unlink(HybridCustody.ManagerPublicPath)
parent.unlink(HybridCustody.ManagerPrivatePath)
parent.link<&HybridCustody.Manager{HybridCustody.ManagerPrivate, HybridCustody.ManagerPublic}>(
HybridCustody.ManagerPrivatePath,
target: HybridCustody.ManagerStoragePath
)
parent.link<&HybridCustody.Manager{HybridCustody.ManagerPublic}>(
HybridCustody.ManagerPublicPath,
target: HybridCustody.ManagerStoragePath
)
// Claim the ChildAccount Capability
let inboxName = HybridCustody.getChildAccountIdentifier(parent.address)
let cap = parent
.inbox
.claim<&HybridCustody.ChildAccount{HybridCustody.AccountPrivate, HybridCustody.AccountPublic, MetadataViews.Resolver}>(
inboxName,
provider: child.address
) ?? panic("child account cap not found")
// Get a reference to the Manager and add the account
let managerRef = parent.borrow<&HybridCustody.Manager>(from: HybridCustody.ManagerStoragePath)
?? panic("manager no found")
managerRef.addAccount(cap: cap)
}
}
```
# Authenticating Users
Using REST API directly to sign in or up with Hyphen account.
{% hint style="info" %}
Currently, Hyphen only supports [**Firebase Auth**](https://firebase.google.com/docs/auth) for OAuth 2.0 Provider. To add your own provider, please get in touch with us!
{% endhint %}
## Process
1. **Request Firebase Auth to the user.** The client will get a Firebase ID token.
2. In the client, **check that *****the device key***** exists on the keystore.**
1. If It does, go to [**A. Signing In with Challenge**](#a.-signing-in-with-challenge)
2. Else, go to [**B. Signing In with 2FA.**](#b.-signing-in-with-2fa)
### A. Signing In with Challenge
1. **Call Auth Request Challenge API.** The client needs to send a request with the device's public key and the Firebase ID token.
1. If HTTP 200 -> The server will respond with random challenge data. Go to A.2.
2. If HTTP 400 with `PleaseSignUp` -> Go to [**C. Creating an Account.**](#c.-creating-an-account)
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/challenge" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
2. **Sign the Challenge Data with the Device Key**. The client should request the device keystore to sign the challenge data received from the server. The data is hex-encoded but don't decode the hex before signing it— just sign the UTF-8 binary data directly.\
\
The signature should be ECDSA P-256 signature with SHA2-256 digest, encoded in [IEEE P.1363](https://datatracker.ietf.org/doc/draft-ietf-httpbis-message-signatures/) format (a.k.a. r||s concat format).
3. **Call Auth Finish SignIn Challenge API**. Send the signature along with the original challenge data. The signature should be encoded in a hex string.
1. If HTTP 200 -> Go to [**D. Finishing Authorization**](#d.-finishing-authorization)
2. If HTTP 400 with PleaseDeploy: The account contract needs to be set up on the chain you're using.
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/challenge/respond" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### B. Signing In with 2FA
On the source device (i.e. who currently tries to sign in), It should request 2FA Sign-in.
1. **Generate a Device Key**. The device key needs to be stored on the device's HSM keystore, such as Secure Enclave or Android Keystore. The keypair should be ECDSA with P-256 (secp256p1) curve.
2. **Call Auth Request 2FA API**: Send a request with the device registration data, including the public key generated in the previous step and the push token of the device.
* If HTTP 200 -> The server will respond with the 2FA request data. A push will be sent on the random device registered on the user's account.
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/2fa" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
On the other device which is selected for 2FA target, it should receive a Firebase push with the 2FA request data.
1. **Request user's approval**: Make sure that the client is displaying enough information for the user to know about the request.
1. If approves -> Go to step 2.
2. If denies -> **Call Deny 2FA request API** to cancel the request.
2. **Send the transaction in the request using the device key.**
3. **Sign the payload in the request using the device key.** Note that the payload is hex-encoded, so you need to decode it before signing it.
4. **Call Approve 2FA request API**: with the signature.
5. Close the screen.
Now go back to the source device. It will receive a foreground data push as the status changes.
1. **Receive the silent push: `2fa-status-update`.**
1. If approved -> a transaction ID, credentials, and account info will be given. Go to step 2.
2. If denied -> Show the user an error message that the other device rejected the request.
2. **Wait for the transaction ID to confirm**. The transaction registers your new key to the account.
3. **Go to** [**D. Finishing Authorization.**](#d.-finishing-authorization)
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/2fa/finish" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### C. Creating an Account
1. **Generate a Device Key**. The device key needs to be stored on the device's HSM keystore, such as Secure Enclave or Android Keystore. The keypair should be ECDSA with P-256 (secp256p1) curve.
2. **Call Sign Up API**. Send a request with the device registration data, including the public key generated in the previous step and the push token of the device.
* *If HTTP 200* -> Go to [**D. Finishing Authorization**](broken://pages/kmnbaEaCk5zv3iVEdcqM)
* *If HTTP 400* with PleaseDeploy: The account contract needs to be set up on the chain you're using.
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signup" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### D. Finishing Authorization
1. The server will respond with the credentials and account info.
2. **Store the credential data in the local storage**. The credential object consists of a JWT access token and a refresh token.
All done! The client can redirect the user to the home screen of your application.
# Handling 2FA Push
Use Hyphen API to handle 2FA request push
Hyphen uses Firebase Messaging to send a 2-factor authorization request to the user's device. Without using SDK, your client needs to handle and implement the data sent along with the push message and display appropriate UI to the user.
## Common Data Format
In the push message, there are fields that indicate whether the message is from Hyphen and which type is it. The actual data is always encoded as JSON and wrapped in a `hyphen:data` key in the push message.
| Key | Description | Example |
|---|
hyphen:type | The message type | "2fa-request" |
hyphen:data | JSON-encoded data object | "{\"twoFactorAuth\":...}" |
For example, on iOS, the data can be decoded like this:
{% tabs %}
{% tab title="iOS (Swift) Example" %}
```swift
struct TwoFactorAuthStatusPayload: Codable { ...}
func application(
_ application: UIApplication,
didReceiveRemoteNotification userInfo: [AnyHashable : Any],
fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void
) {
guard let msgType = userInfo["hyphen:type"] as? String,
let msgDataString = userInfo["hyphen:data"] as? String,
let msgData = msgDataString.data(using: .utf8) else {
// The payload was not a string or the string could not be converted to Data
completionHandler(.failed)
return
}
do {
let decoder = JSONDecoder()
switch msgType {
case "2fa-status-change":
let myData = try decoder.decode(TwoFactorAuthStatusPayload.self, from: msgData)
completionHandler(.myData)
}
} catch {
print("Decoding error: \(error)")
completionHandler(.failed)
}
}
```
{% endtab %}
{% tab title="Android (Kotlin) Example" %}
import com.google.firebase.messaging.FirebaseMessagingService
import com.google.firebase.messaging.RemoteMessage
import kotlinx.serialization.*
import kotlinx.serialization.json.*
class YourFCMService: FirebaseMessagingService {
override fun onMessageReceived(remoteMessage: RemoteMessage) {
if (remoteMessage.data.isNotEmpty()) {
val type = remoteMessage.data["hyphen:type"]
val hyphenData = remoteMessage.data["hyphen:data"]
val json = Json {}
if (type == "2fa-status-change") {
val myData = json.decodeToString<TwoFactorAuthStatusPayload>(hyphenData)
// write your logic
}
}
}
}
{% endtab %}
{% endtabs %}
## List of Push Message Data
### 2FA Request (On Destination Device)
This message is being sent to the destination device which approves/denies the 2FA request (e.g. the existing device having a key registered). It's sent as a notification with the highest priority.
#### Data Format
The **`hyphen:type`** is `"2fa-request"` .
| Key | Description | Example |
|---|
twoFactorAuth | TwoFactorAuthStatus object used same as REST API's. | {"id": "faceb00c-cafe-babe-badd-deadbeef1234", "app": ...} |
#### Example
{
"twoFactorAuth": {
"id": "faceb00c-cafe-babe-badd-deadbeef1234",
"status": "pending",
"expiresAt": "2023-07-21T18:36:27.872Z",
"request": {
"id": "faceb00c-cafe-babe-badd-deadbeef1234",
"app": {"appId": "swirl-dev", "appName": "Swirl"},
"userOpInfo": {
"type": "sign-in",
"signIn": {
"email": "john@acme.com",
"ip": "127.0.0.1",
"location": "Seoul, Korea"
}
},
"message": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
"srcDevice": {
"publicKey": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
"pushToken": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
"name": "iPhone 14",
"osName": "iOS",
"osVersion": "16.2",
"deviceManufacturer": "Apple",
"deviceModel": "SM-265N",
"lang": "en",
"type": "mobile"
},
"destDevice": {
"publicKey": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
"pushToken": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
"name": "iPhone 14",
"osName": "iOS",
"osVersion": "16.2",
"deviceManufacturer": "Apple",
"deviceModel": "SM-265N",
"lang": "en",
"type": "mobile"
},
"requestedAt": "2023-07-21T18:31:27.872Z"
}
}
}
### 2FA Status Change (On Source Device)
This message is being sent to the source device which requested the 2FA (e.g. the new device tries to sign in). It's sent as a [Background Update](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) push without any notification.
#### Data Format
The **`hyphen:type`** is `"2fa-status-change"` .
| Key | Description | Example |
|---|
twoFactorAuth | TwoFactorAuthStatus object used same as REST API's. | {"id": "faceb00c-cafe-babe-badd-deadbeef1234", "app": ...} |
#### Example
If the user approves, the `twoFactorAuth.result.txId` field will contain the new key registration transaction sent from the destination device.
```json
{
"twoFactorAuth": {
"id": "faceb00c-cafe-babe-badd-deadbeef1234",
"status": "approved",
"result": {
"txId": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de"
}
"expiresAt": "2023-07-21T18:36:27.872Z",
"request": {
"id": "faceb00c-cafe-babe-badd-deadbeef1234",
"app": {"appId": "swirl-dev", "appName": "Swirl"},
"userOpInfo": {
"type": "sign-in",
"signIn": {
"email": "john@acme.com",
"ip": "127.0.0.1",
"location": "Seoul, Korea"
}
},
"message": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
"srcDevice": {
"publicKey": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
"pushToken": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
"name": "iPhone 14",
"osName": "iOS",
"osVersion": "16.2",
"deviceManufacturer": "Apple",
"deviceModel": "SM-265N",
"lang": "en",
"type": "mobile"
},
"destDevice": {
"publicKey": "faceb00ccafebabedeadbeefbadf00defaceb00ccafebabedeadbeefbadf00de",
"pushToken": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
"name": "iPhone 14",
"osName": "iOS",
"osVersion": "16.2",
"deviceManufacturer": "Apple",
"deviceModel": "SM-265N",
"lang": "en",
"type": "mobile"
},
"requestedAt": "2023-07-21T18:31:27.872Z"
}
}
}
```
# API Reference
Using REST API Directly
# Account
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/account/v1/me" method="get" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/account/v1/parent" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
# Auth
### Authentication
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/refresh" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### Sign Up
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signup" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### Sign In (with 2FA)
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/2fa" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/2fa/finish" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### Sign In (with Challenge)
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/challenge" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/signin/challenge/respond" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### Recover Account
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/auth/v1/recover" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
# Device
### Device Management
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/device/v1/devices" method="get" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/device/v1/devices/{publicKey}" method="put" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
### 2FA (Two-Factor Authorization)
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/device/v1/2fa/{id}" method="get" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/device/v1/2fa/{id}" method="put" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/device/v1/2fa/{id}" method="delete" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/device/v1/2fa/{id}/approve" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
# Key
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/key/v1/keys" method="get" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/key/v1/recovery" method="post" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
# Sign
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/sign/v1/cadence/transaction" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}
{% openapi src="/files/fga64SW2USHfQ96R2eO1" path="/sign/v1/cadence/paymaster" method="post" expanded="true" %}
[swagger.json](https://2622738714-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoXzDQclFMZX61nsrgiVE%2Fuploads%2FeAwTMXbA20yh1IgDdtbC%2Fswagger.json?alt=media\&token=a0c57374-3eaa-4701-a283-21b37d0bec21)
{% endopenapi %}