Skip to content

Commit b30b3f5

Browse files
authored
Merge pull request #874 from Web3Auth/add-focus
Add focus magic comments
2 parents 8e28f04 + f18d0ef commit b30b3f5

File tree

78 files changed

+444
-370
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+444
-370
lines changed

docs/auth-provider-setup/social-providers/telegram.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,10 +201,10 @@ const login = async () => {
201201

202202
// Catch the JWT token from the backend server and pass it to the Web3Auth SDK
203203
// Preferably, in a useEffect hook or a callback function
204-
// highlight-start
204+
// focus-start
205205
const params = new URLSearchParams(window.location.search);
206206
const idToken = params.get("token");
207-
// highlight-end
207+
// focus-end
208208
// To know more about how to generate the JWT token, refer to the linked guide.
209209

210210
// Login with Telegram with Web3Auth using received JWT token

docs/connect-blockchain/solana/android.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ import com.web3auth.core.types.Network
8888
import com.web3auth.core.types.Web3AuthOptions
8989

9090
// Initialize Web3Auth SDK
91-
// highlight-start
91+
// focus-start
9292
val web3Auth: Web3Auth = Web3Auth(
9393
Web3AuthOptions(
9494
clientId = "BPi5PB_UiIZ-cPz1GtV5i1I2iOSOHuimiXBI0e-Oe_u6X3oVAbCiAZOTEBtTXw4tsluTITPqA8zMsfxIKMjiqNQ",
@@ -97,7 +97,7 @@ val web3Auth: Web3Auth = Web3Auth(
9797
redirectUrl = Uri.parse( "com.example.androidsolanaexample://auth")
9898
)
9999
)
100-
// highlight-end
100+
// focus-end
101101

102102
// Check whether private key is empty or not for user authentication status.
103103
val isUserAuthenticated = web3Auth.getPrivkey().isNotEmpty()

docs/connect-blockchain/solana/flutter.mdx

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ class ServiceLocator {
5050
static GetIt get getIt => GetIt.instance;
5151
5252
static Future<void> init() async {
53-
// highlight-start
53+
// focus-start
5454
final solanaClient = SolanaClient(
5555
rpcUrl: Uri.parse('https://api.devnet.solana.com'),
5656
websocketUrl: Uri.parse('ws://api.devnet.solana.com'),
5757
);
58-
// highlight-end
58+
// focus-end
5959
6060
// Register SolanaClient to be accessed using service locator
6161
getIt.registerLazySingleton<SolanaClient>(() => solanaClient);
@@ -92,7 +92,7 @@ Future<void> main() async {
9292
redirectUrl = Uri.parse('com.web3auth.fluttersolanasample://auth');
9393
}
9494
95-
// highlight-start
95+
// focus-start
9696
await Web3AuthFlutter.init(
9797
Web3AuthOptions(
9898
clientId:
@@ -102,7 +102,7 @@ Future<void> main() async {
102102
),
103103
);
104104
105-
// highlight-end
105+
// focus-end
106106
107107
runApp(const MainApp());
108108
}
@@ -129,7 +129,7 @@ class _MainAppState extends State<MainApp> {
129129
future: privateKeyFuture,
130130
builder: (context, snapshot) {
131131
if (snapshot.connectionState == ConnectionState.done) {
132-
// highlight-start
132+
// focus-start
133133
if (snapshot.hasData) {
134134
// Check if user is already authenticated. If user is already
135135
// authenticated the snapshot.data will be non empty string
@@ -139,7 +139,7 @@ class _MainAppState extends State<MainApp> {
139139
}
140140
}
141141
return const LoginScreen();
142-
// highlight-end
142+
// focus-end
143143
}
144144
return const Center(
145145
child: CircularProgressIndicator.adaptive(),
@@ -225,15 +225,15 @@ class _HomeScreenState extends State<HomeScreen> {
225225
balance.toString(),
226226
style: Theme.of(context).textTheme.displaySmall,
227227
),
228-
// highlight-start
228+
// focus-start
229229
if (web3AuthInfo.email != null) ...[
230230
verticalGap,
231231
Text(
232232
web3AuthInfo.email!,
233233
style: Theme.of(context).textTheme.bodyLarge,
234234
)
235235
],
236-
// highlight-end
236+
// focus-end
237237
238238
// ..
239239
// Additional code
@@ -242,7 +242,7 @@ class _HomeScreenState extends State<HomeScreen> {
242242
verticalGap,
243243
244244
// Logs the user information in the console
245-
// highlight-start
245+
// focus-start
246246
OutlinedButton(
247247
onPressed: () async {
248248
showInfoDialog(
@@ -253,7 +253,7 @@ class _HomeScreenState extends State<HomeScreen> {
253253
},
254254
child: const Text("Get user info"),
255255
),
256-
// highlight-end
256+
// focus-end
257257
],
258258
),
259259
);
@@ -289,7 +289,7 @@ class SolanaProvider {
289289
290290
SolanaProvider(this.solanaClient);
291291
292-
// highlight-start
292+
// focus-start
293293
Future<double> getBalance(String address) async {
294294
final balanceResponse = await solanaClient.rpcClient.getBalance(
295295
address,
@@ -299,7 +299,7 @@ class SolanaProvider {
299299
/// token decimals is set to be 9;
300300
return balanceResponse.value / pow(10, tokenDecimals);
301301
}
302-
// highlight-end
302+
// focus-end
303303
304304
// ..
305305
// Additional methods
@@ -339,12 +339,12 @@ class _HomeScreenState extends State<HomeScreen> {
339339
340340
/// The ED25519 PrivateKey returns a key pair from
341341
/// which we only require first 32 byte.
342-
// highlight-start
342+
// focus-start
343343
keyPair = await Ed25519HDKeyPair.fromPrivateKeyBytes(
344344
privateKey: privateKey.hexToBytes.take(32).toList(),
345345
);
346346
balance = await provider.getBalance(keyPair.address);
347-
// highlight-end
347+
// focus-end
348348
isAccountLoaded.value = true;
349349
} catch (e, _) {
350350
if (context.mounted) {
@@ -364,16 +364,16 @@ class _HomeScreenState extends State<HomeScreen> {
364364
child: Column(
365365
mainAxisAlignment: MainAxisAlignment.center,
366366
children: [
367-
// highlight-start
367+
// focus-start
368368
Text(
369369
balance.toString(),
370370
style: Theme.of(context).textTheme.displaySmall,
371371
),
372-
// highlight-end
372+
// focus-end
373373
// ..
374374
// Additional code
375375
// ..
376-
// highlight-start
376+
// focus-start
377377
Row(
378378
children: [
379379
const Spacer(),
@@ -393,7 +393,7 @@ class _HomeScreenState extends State<HomeScreen> {
393393
const Spacer(),
394394
],
395395
),
396-
// highlight-end
396+
// focus-end
397397
// ..
398398
// Additional code
399399
// ..
@@ -421,7 +421,7 @@ class SolanaProvider {
421421
422422
SolanaProvider(this.solanaClient);
423423
424-
// highlight-start
424+
// focus-start
425425
Future<String> signSendTransaction({
426426
required Ed25519HDKeyPair keyPair,
427427
required String destination,
@@ -444,7 +444,7 @@ class SolanaProvider {
444444
final signedTx = await signTransaction(recentBlockHash, message, [keyPair]);
445445
return signedTx.signatures.first.toBase58();
446446
}
447-
// highlight-end
447+
// focus-end
448448
449449
Future<RecentBlockhash> getRecentBlockhash() async {
450450
return await solanaClient.rpcClient
@@ -487,7 +487,7 @@ class _HomeScreenState extends State<HomeScreen> {
487487
child: Column(
488488
mainAxisAlignment: MainAxisAlignment.center,
489489
children: [
490-
// highlight-start
490+
// focus-start
491491
OutlinedButton(
492492
onPressed: () {
493493
signSelfTransfer(context);
@@ -496,7 +496,7 @@ class _HomeScreenState extends State<HomeScreen> {
496496
"Sign Self transfer 0.0001 Sol",
497497
),
498498
),
499-
// highlight-end
499+
// focus-end
500500
],
501501
),
502502
);
@@ -507,7 +507,7 @@ class _HomeScreenState extends State<HomeScreen> {
507507
);
508508
}
509509
510-
// highlight-start
510+
// focus-start
511511
Future<void> signSelfTransfer(BuildContext context) async {
512512
showLoader(context);
513513
try {
@@ -527,7 +527,7 @@ class _HomeScreenState extends State<HomeScreen> {
527527
}
528528
}
529529
}
530-
// highlight-end
530+
// focus-end
531531
}
532532
533533
```
@@ -542,7 +542,7 @@ class SolanaProvider {
542542
543543
SolanaProvider(this.solanaClient);
544544
545-
// highlight-start
545+
// focus-start
546546
Future<String> sendSol({
547547
required Ed25519HDKeyPair keyPair,
548548
required String destination,
@@ -559,7 +559,7 @@ class SolanaProvider {
559559
560560
return transactionHash;
561561
}
562-
// highlight-end
562+
// focus-end
563563
}
564564
```
565565

@@ -619,7 +619,7 @@ class _HomeScreenState extends State<HomeScreen> {
619619
children: [
620620
// ..
621621
verticalGap,
622-
// highlight-start
622+
// focus-start
623623
OutlinedButton(
624624
onPressed: () {
625625
selfTransfer(context);
@@ -628,7 +628,7 @@ class _HomeScreenState extends State<HomeScreen> {
628628
"Self transfer 0.0001 Sol",
629629
),
630630
),
631-
// highlight-end
631+
// focus-end
632632
// ..
633633
],
634634
),
@@ -640,7 +640,7 @@ class _HomeScreenState extends State<HomeScreen> {
640640
);
641641
}
642642
643-
// highlight-start
643+
// focus-start
644644
Future<void> selfTransfer(BuildContext context) async {
645645
showLoader(context);
646646
try {
@@ -661,6 +661,6 @@ class _HomeScreenState extends State<HomeScreen> {
661661
}
662662
}
663663
}
664-
// highlight-end
664+
// focus-end
665665
}
666666
```

docs/connect-blockchain/solana/ios.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ during initialization.
103103
import Web3Auth
104104

105105
// Initialize Web3Auth SDK
106-
// highlight-start
106+
// focus-start
107107
let web3Auth = await Web3Auth(
108108
W3AInitParams(
109109
clientId: "BPi5PB_UiIZ-cPz1GtV5i1I2iOSOHuimiXBI0e-Oe_u6X3oVAbCiAZOTEBtTXw4tsluTITPqA8zMsfxIKMjiqNQ",
110110
network: Network.sapphire_mainnet,
111111
redirectUrl: "com.w3a.ios-solana-example"
112112
)
113113
)
114-
// highlight-end
114+
// focus-end
115115

116116
// Check whether state is nil or not for user authentication status.
117117
let isUserAuthenticated = web3Auth.state != nil
@@ -154,12 +154,12 @@ response of `getBalance` is UInt64, we will need to divide it by by 10^9, becaus
154154
decimals is 9. To help us with the calculation, the SDK also provides a `convertToBalance` function.
155155

156156
```swift
157-
// highlight-start
157+
// focus-start
158158
let balanceResponse = try await solanaJSONRPCClient.getBalance(
159159
// Use userAccount from above
160160
account: userAccount
161161
)
162-
// highlight-end
162+
// focus-end
163163

164164
// We are dividing the balance by 10^9, because Solana's
165165
// token decimals is set to be 9;

docs/features/whitelabelasdf/login-modal.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import { CHAIN_NAMESPACES } from "@web3auth/base";
3636

3737
const web3auth = new Web3Auth({
3838
// type uiConfig
39-
// highlight-start
39+
// focus-start
4040
uiConfig: {
4141
appName: "W3A",
4242
theme: {
@@ -49,7 +49,7 @@ const web3auth = new Web3Auth({
4949
loginGridCol: 3,
5050
primaryButton: "externalLogin", // "externalLogin" | "socialLogin" | "emailLogin"
5151
},
52-
// highlight-end
52+
// focus-end
5353
chainConfig: { chainNamespace: CHAIN_NAMESPACES.EIP155 },
5454
clientId:
5555
"BPi5PB_UiIZ-cPz1GtV5i1I2iOSOHuimiXBI0e-Oe_u6X3oVAbCiAZOTEBtTXw4tsluTITPqA8zMsfxIKMjiqNQ",
@@ -138,7 +138,7 @@ const web3auth = new Web3Auth({
138138
web3AuthNetwork: "sapphire_mainnet",
139139
});
140140

141-
// highlight-start
141+
// focus-start
142142
await web3auth.initModal({
143143
modalConfig: {
144144
[WALLET_ADAPTERS.OPENLOGIN]: {
@@ -157,7 +157,7 @@ await web3auth.initModal({
157157
},
158158
},
159159
});
160-
// highlight-end
160+
// focus-end
161161
```
162162

163163
### Disable Email or SMS Login Methods
@@ -173,7 +173,7 @@ const web3auth = new Web3Auth({
173173
web3AuthNetwork: "sapphire_mainnet",
174174
});
175175

176-
// highlight-start
176+
// focus-start
177177
await web3auth.initModal({
178178
modalConfig: {
179179
[WALLET_ADAPTERS.OPENLOGIN]: {
@@ -192,7 +192,7 @@ await web3auth.initModal({
192192
},
193193
},
194194
});
195-
// highlight-end
195+
// focus-end
196196
```
197197

198198
### Disable External Wallet Options
@@ -208,7 +208,7 @@ const web3auth = new Web3Auth({
208208
web3AuthNetwork: "sapphire_mainnet",
209209
});
210210

211-
// highlight-start
211+
// focus-start
212212
await web3auth.initModal({
213213
modalConfig: {
214214
// Disable Wallet Connect V2
@@ -223,5 +223,5 @@ await web3auth.initModal({
223223
},
224224
},
225225
});
226-
// highlight-end
226+
// focus-end
227227
```

0 commit comments

Comments
 (0)