@farcaster/frame-sdk 0.0.45 → 0.0.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.d.ts CHANGED
@@ -49,6 +49,17 @@ export type FrameSDK = {
49
49
  };
50
50
  experimental: {
51
51
  getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>;
52
+ quickAuth: (options?: {
53
+ /**
54
+ * Use a custom Quick Auth server, otherwise defaults to the public
55
+ * instance provided by Farcaster.
56
+ *
57
+ * @default https://auth.farcaster.xyz
58
+ */
59
+ quickAuthServerOrigin?: string;
60
+ }) => Promise<{
61
+ token: string;
62
+ }>;
52
63
  };
53
64
  wallet: {
54
65
  ethProvider: Provider.Provider;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farcaster/frame-sdk",
3
- "version": "0.0.45",
3
+ "version": "0.0.47",
4
4
  "license": "MIT",
5
5
  "repository": {
6
6
  "type": "git",
@@ -16,9 +16,10 @@
16
16
  "esbuild": "^0.25.0",
17
17
  "mipd": "^0.0.7",
18
18
  "typescript": "^5.7.2",
19
- "@farcaster/tsconfig": "0.0.2"
19
+ "@farcaster/tsconfig": "0.0.4"
20
20
  },
21
21
  "dependencies": {
22
+ "@farcaster/quick-auth": "^0.0.5",
22
23
  "comlink": "^4.4.2",
23
24
  "eventemitter3": "^5.0.1",
24
25
  "ox": "^0.4.4",
package/src/sdk.ts CHANGED
@@ -2,10 +2,10 @@ import {
2
2
  AddMiniApp,
3
3
  type FrameClientEvent,
4
4
  SignIn,
5
- type SolanaRequestFn,
6
- createSolanaWalletProvider,
7
5
  } from '@farcaster/frame-core'
6
+ import { createLightClient } from '@farcaster/quick-auth/light'
8
7
  import { EventEmitter } from 'eventemitter3'
8
+ import * as Siwe from 'ox/Siwe'
9
9
  import { ethereumProvider, getEthereumProvider } from './ethereumProvider'
10
10
  import { frameHost } from './frameHost'
11
11
  import { getSolanaProvider } from './solanaProvider'
@@ -133,6 +133,38 @@ export const sdk: FrameSDK = {
133
133
  },
134
134
  experimental: {
135
135
  getSolanaProvider,
136
+ quickAuth: async (options = {}) => {
137
+ const quickAuth = createLightClient({
138
+ origin: options.quickAuthServerOrigin,
139
+ })
140
+
141
+ const { nonce } = await quickAuth.generateNonce()
142
+ const response = await frameHost.signIn({
143
+ nonce,
144
+ })
145
+
146
+ if (response.result) {
147
+ const parsedSiwe = Siwe.parseMessage(response.result.message)
148
+
149
+ // The Farcaster Client rendering the Mini App will set the domain
150
+ // based on the URL it's rendering. It should always be set.
151
+ if (!parsedSiwe.domain) {
152
+ throw new Error('Missing domain on SIWE message')
153
+ }
154
+
155
+ return await quickAuth.verifySiwf({
156
+ domain: parsedSiwe.domain,
157
+ message: response.result.message,
158
+ signature: response.result.signature,
159
+ })
160
+ }
161
+
162
+ if (response.error.type === 'rejected_by_user') {
163
+ throw new SignIn.RejectedByUser()
164
+ }
165
+
166
+ throw new Error('Unreachable')
167
+ },
136
168
  },
137
169
  wallet: {
138
170
  ethProvider: ethereumProvider,
package/src/types.ts CHANGED
@@ -77,6 +77,17 @@ export type FrameSDK = {
77
77
  }
78
78
  experimental: {
79
79
  getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>
80
+ quickAuth: (options?: {
81
+ /**
82
+ * Use a custom Quick Auth server, otherwise defaults to the public
83
+ * instance provided by Farcaster.
84
+ *
85
+ * @default https://auth.farcaster.xyz
86
+ */
87
+ quickAuthServerOrigin?: string
88
+ }) => Promise<{
89
+ token: string
90
+ }>
80
91
  }
81
92
  wallet: {
82
93
  // Deprecated in favor of getEthereumProvider