Embed API

Getting Started

First, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Architecture

The backend uses a PostgreSQL DB hosted on Supabase behind Supavisor.

For analytics events (e.g. to get usage data and bill developers), we'll be using DynamoDB (TBD). In order to bill developers by MAS (Monthly Active Session), we'll have to keep track of all unique user IDs that accessed their account and/or activated a wallet on their application.

We can probably remove/reset those records every month and only keep aggregated data around in the tables related to billing (to be added).

Server Config & Cronjobs

Challenges:

• ✅ CHALLENGE_TYPE
• ❌ CHALLENGE_VERSION - Moved to the individual clients.
• ✅ CHALLENGE_BUFFER_SIZE
• ❌ CHALLENGE_TTL_MS - Moved to the individual clients.
• ❌ CHALLENGE_ROTATION_TTL_MS - Move to the individual clients.

Shares:

• ✅ SHARE_ACTIVE_TTL_MS: Time before a share rotation is requested.

• ✅ SHARE_INACTIVE_TTL_MS: Time before an inactive share is deleted (if it hasn't been rotated in a long time).

• ✅ SHARE_MAX_ROTATION_IGNORES

• ❌ SHARE_MAX_FAILED_ACTIVATION_ATTEMPTS - What happens then? De-auth user?

• ❌ SHARE_MAX_FAILED_RECOVERY_ATTEMPTS - What happens then? De-auth user?

• Maybe replace the 2 above with a single MAX_SUSPICIOUS_ACTIVITY (DB User needs maxSuspiciousActionCount and lastSuspiciousActionDate).

Auth Method, Wallet & Share Limits:

• ❌ MAX_AUTH_METHODS_PER_USER
• ❌ MAX_WALLETS_PER_USER
• ❌ MAX_WORK_SHARES_PER_WALLET (or per user) - What happens then?
• ❌ MAX_RECOVERY_SHARES_PER_WALLET (or per user) - What happens then?

Activity Log Limits:

• ❌ MAX_ACTIVATIONS_PER_WALLET
• ❌ MAX_RECOVERIES_PER_WALLET
• ❌ MAX_EXPORTS_PER_WALLET

Cronjobs:

• ❌ All Activity Log Limits above could instead be capped by date (e.g. older than a month).
• ❌ Orphan DeviceAndLocation (not referenced by any other table).
• ❌ Inactive WorkKeyShare (deleted passively using SHARE_INACTIVE_TTL_MS).

SDK API:

Authentication:

• ❌ authenticate
• ❌ refreshSession
• ❌ fakeAuthenticate
• ❌ fakeRefreshSession

Wallets:

• ✅ fetchWallets
• ❌ createWallet, instead:
  • ✅ createPublicWallet
  • ✅ createPrivateWallet
  • ✅ createReadOnlyWallet
• ❌ updateWallet, instead:
  • ✅ makeWalletPrivate
  • ✅ makeWalletPublic
  • ✅ updateWalletInfo
  • ✅ updateWalletRecovery
  • ✅ updateWalletStatus
• ✅ deleteWallet

Work Shares:

• ✅ generateWalletActivationChallenge
• ✅ activateWallet
• ✅ rotateAuthShare

Backup:

• ✅ registerRecoveryShare
• ✅ registerWalletExport

Share Recovery:

• ✅ generateWalletRecoveryChallenge
• ✅ recoverWallet
• ✅ registerAuthShare

Account Recovery:

• ✅ generateFetchRecoverableAccountsChallenge
• ✅ fetchRecoverableAccounts
• ✅ generateAccountRecoveryChallenge
• ✅ recoverAccount

Needed for Developer Portal:

• fetchDeveloper
• upsertDeveloper
• fetchApplications
• fetchApplication
• createApplication
• updateApplication

Needed for Dashboard:

• fetchAuthMethods

• addAuthMethod

• deleteAuthMethod

• fetchSessions

• deleteSession (also deletes WorkKeyShares)

• fetchRecoveryKeyShares

• deleteRecoveryKeyShare (just mark it as deleted?)

• fetchWalletExports

• deleteWalletExport? (just mark it as deleted?)

• fetchWalletRecoveries

• reportWalletRecovery?

• reportWalletRecovery?

• fetchWalletActivations

• reportWalletActivation?

• deleteWalletActivation?