From 534fb64b0430a7ce7bd13f8bc677ea1569b6f27b Mon Sep 17 00:00:00 2001 From: Mohammad Shahbaz Alam Date: Thu, 9 Nov 2023 19:51:37 +0530 Subject: [PATCH] Update Flutter guides + fix broken link --- docs/connect-blockchain/algorand.mdx | 8 ++--- src/common/sdk/pnp/android/_response.mdx | 15 +++++----- src/common/sdk/pnp/flutter/_response.mdx | 15 +++++----- src/common/sdk/pnp/ios/_response.mdx | 22 ++++++++------ .../content-hub/guides/flutter-auth0.mdx | 29 +++++++------------ .../content-hub/guides/flutter-firebase.mdx | 27 ++++++----------- src/pages/content-hub/guides/flutter.mdx | 27 ++++++----------- 7 files changed, 61 insertions(+), 82 deletions(-) diff --git a/docs/connect-blockchain/algorand.mdx b/docs/connect-blockchain/algorand.mdx index 4ca9cc751..55ec15aed 100644 --- a/docs/connect-blockchain/algorand.mdx +++ b/docs/connect-blockchain/algorand.mdx @@ -9,10 +9,10 @@ description: "Integrate Web3Auth with the Algorand Blockchain | Documentation - import GetUserInfoSnippet from "@site/src/common/docs/_get-userinfo.mdx"; -While using the Web3Auth Web SDK for a non-EVM chain like [Algorand](https://www.algorand.com/) you get a standard provider from which you can get the -private key of the user. Using this private key, you can use the corresponding libraries of the blockchain to make blockchain calls like getting the -user's `account`, fetch `balance`, `sign transaction`, `send transaction`, `read` from and `write` to the smart contract, etc. We have highlighted a -few methods here to get you started quickly on that. +While using the Web3Auth Web SDK for a non-EVM chain like [Algorand](https://algorandtechnologies.com/) you get a standard provider from which you can +get the private key of the user. Using this private key, you can use the corresponding libraries of the blockchain to make blockchain calls like +getting the user's `account`, fetch `balance`, `sign transaction`, `send transaction`, `read` from and `write` to the smart contract, etc. We have +highlighted a few methods here to get you started quickly on that. :::note diff --git a/src/common/sdk/pnp/android/_response.mdx b/src/common/sdk/pnp/android/_response.mdx index 7c734cf8b..e47e21dc6 100644 --- a/src/common/sdk/pnp/android/_response.mdx +++ b/src/common/sdk/pnp/android/_response.mdx @@ -2,17 +2,18 @@ { "privKey": "0ajjsdsd....", "userInfo": { - "name": "John Dash", + "email": "w3a-heroes@web3auth.com", + "name": "Web3Auth Heroes", "profileImage": "https://lh3.googleusercontent.com/a/Ajjjsdsmdjmnm...", - "typeOfLogin": "google", - "aggregateVerifier": "tkey-google", "verifier": "torus", - "verifierId": "john@gmail.com", - "email": "john@gmail.com", - "dappShare": "<24 words seed phrase>", // will be sent only incase of custom verifiers + "verifierId": "w3a-heroes@web3auth.com", + "typeOfLogin": "google", + "aggregateVerifier": "w3a-google-sapphire", + "dappShare": "", // 24 words of seed phrase will be sent only incase of custom verifiers "idToken": "", "oAuthIdToken": "", // will be sent only incase of custom verifiers - "oAuthAccessToken": "" // will be sent only incase of custom verifiers + "oAuthAccessToken": "", // will be sent only incase of custom verifiers + "isMfaEnabled": false // Returns whether the user has enabled MFA or not }, "ed25519PrivKey": "666523652352635....", "coreKitKey": "0xajjsdsd....", diff --git a/src/common/sdk/pnp/flutter/_response.mdx b/src/common/sdk/pnp/flutter/_response.mdx index 7c734cf8b..e47e21dc6 100644 --- a/src/common/sdk/pnp/flutter/_response.mdx +++ b/src/common/sdk/pnp/flutter/_response.mdx @@ -2,17 +2,18 @@ { "privKey": "0ajjsdsd....", "userInfo": { - "name": "John Dash", + "email": "w3a-heroes@web3auth.com", + "name": "Web3Auth Heroes", "profileImage": "https://lh3.googleusercontent.com/a/Ajjjsdsmdjmnm...", - "typeOfLogin": "google", - "aggregateVerifier": "tkey-google", "verifier": "torus", - "verifierId": "john@gmail.com", - "email": "john@gmail.com", - "dappShare": "<24 words seed phrase>", // will be sent only incase of custom verifiers + "verifierId": "w3a-heroes@web3auth.com", + "typeOfLogin": "google", + "aggregateVerifier": "w3a-google-sapphire", + "dappShare": "", // 24 words of seed phrase will be sent only incase of custom verifiers "idToken": "", "oAuthIdToken": "", // will be sent only incase of custom verifiers - "oAuthAccessToken": "" // will be sent only incase of custom verifiers + "oAuthAccessToken": "", // will be sent only incase of custom verifiers + "isMfaEnabled": false // Returns whether the user has enabled MFA or not }, "ed25519PrivKey": "666523652352635....", "coreKitKey": "0xajjsdsd....", diff --git a/src/common/sdk/pnp/ios/_response.mdx b/src/common/sdk/pnp/ios/_response.mdx index 14ab0a2a2..e47e21dc6 100644 --- a/src/common/sdk/pnp/ios/_response.mdx +++ b/src/common/sdk/pnp/ios/_response.mdx @@ -1,19 +1,23 @@ ```json { - "ed25519PrivKey": "666523652352635....", "privKey": "0ajjsdsd....", "userInfo": { - "aggregateVerifier": "tkey-google", - "email": "john@gmail.com", - "name": "John Dash", + "email": "w3a-heroes@web3auth.com", + "name": "Web3Auth Heroes", "profileImage": "https://lh3.googleusercontent.com/a/Ajjjsdsmdjmnm...", - "typeOfLogin": "google", "verifier": "torus", - "verifierId": "john@gmail.com", - "dappShare": "<24 words seed phrase>", // will be sent only incase of custom verifiers + "verifierId": "w3a-heroes@web3auth.com", + "typeOfLogin": "google", + "aggregateVerifier": "w3a-google-sapphire", + "dappShare": "", // 24 words of seed phrase will be sent only incase of custom verifiers "idToken": "", "oAuthIdToken": "", // will be sent only incase of custom verifiers - "oAuthAccessToken": "" // will be sent only incase of custom verifiers - } + "oAuthAccessToken": "", // will be sent only incase of custom verifiers + "isMfaEnabled": false // Returns whether the user has enabled MFA or not + }, + "ed25519PrivKey": "666523652352635....", + "coreKitKey": "0xajjsdsd....", + "coreKitEd25519PrivKey": "666523652352635....", + "sessionId": "0xajjsdsd...." } ``` diff --git a/src/pages/content-hub/guides/flutter-auth0.mdx b/src/pages/content-hub/guides/flutter-auth0.mdx index 834294f45..ed128f4a4 100644 --- a/src/pages/content-hub/guides/flutter-auth0.mdx +++ b/src/pages/content-hub/guides/flutter-auth0.mdx @@ -61,7 +61,7 @@ When integrating Web3Auth Flutter SDK with Social Login the flow looks something - Android API version 24 or newer. -- For Android build: compileSdkVersion needs to be 32. Check `android/app/build.gradle` in your Flutter project to change it. +- For Android build: compileSdkVersion needs to be 34. Check `android/app/build.gradle` in your Flutter project to change it. - iOS 12+ - Xcode 11.4+ / 12.x - Swift 4.x / 5.x @@ -222,7 +222,7 @@ Add `web3auth_flutter` as a dependency to your `pubspec.yaml` ```yaml dependencies: - web3auth_flutter: ^2.0.3 + web3auth_flutter: ^3.1.0 ``` or @@ -257,15 +257,6 @@ dependencyResolutionManagement { } ``` -Then, in your app-level `build.gradle` dependencies section, add the following: - -```groovy -dependencies { - // highlight-next-line - implementation 'com.github.Web3Auth:web3auth-android-sdk:4.0.8' -} -``` - #### Permissions Open your app's `AndroidManifest.xml` file and add the following permission: @@ -324,16 +315,16 @@ If you are using the Swift Package Manager, open the following menu item in Xcod `File > Swift Packages > Add Package Dependency` -In the Choose Package Repository prompt add this url: +In the Choose Package Repository prompt add this URL: ``` -https://github.com/Web3Auth/web3auth-swift-sdk/releases/tag/6.0.1 +https://github.com/Web3Auth/web3auth-swift-sdk/releases/tag/7.4.0 ``` ##### Cocoapods ```sh -pod 'Web3Auth', '~> 6.0.1' +pod 'Web3Auth', '~> 7.4.0' ``` #### Configuration @@ -378,8 +369,6 @@ void initState() { // Initialization Future initPlatformState() async { - HashMap themeMap = new HashMap(); - themeMap['primary'] = "#fff000"; Uri redirectUrl; if (Platform.isAndroid) { @@ -407,10 +396,12 @@ Future initPlatformState() async { loginConfig: loginConfig )); // highlight-end + + await Web3AuthFlutter.initialize(); } ``` -Read more about initialising the Flutter SDK [here](/sdk/pnp/flutter/initialize). +Read more about initializing the Flutter SDK [here](/sdk/pnp/flutter/initialize). ### Authentication @@ -594,7 +585,7 @@ Logging out your user is as simple as calling the `web3AuthFlutter.logout()` fun :::success Blockchain calls -Checkout the full codes to interact with **[ETH Blockchain](/connect-blockchain/ethereum/flutter)**. +Check out the full codes to interact with **[ETH Blockchain](/connect-blockchain/ethereum/flutter)**. ::: @@ -705,7 +696,7 @@ running it locally yourself! `flutter run` -Also, checkout other examples: +Also, check other examples: - [Using Flutter SDK](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-quick-start) - [Using Custom JWT (via Firebase)](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-firebase-example) diff --git a/src/pages/content-hub/guides/flutter-firebase.mdx b/src/pages/content-hub/guides/flutter-firebase.mdx index bb9d8c34e..d0b864016 100644 --- a/src/pages/content-hub/guides/flutter-firebase.mdx +++ b/src/pages/content-hub/guides/flutter-firebase.mdx @@ -58,7 +58,7 @@ When integrating Web3Auth Flutter SDK with Social Login the flow looks something - Android API version 24 or newer. -- For Android build: compileSdkVersion needs to be 32. Check `android/app/build.gradle` in your Flutter project to change it. +- For Android build: compileSdkVersion needs to be 34. Check `android/app/build.gradle` in your Flutter project to change it. - iOS 12+ - Xcode 11.4+ / 12.x @@ -98,7 +98,7 @@ Add `web3auth_flutter` as a dependency to your `pubspec.yaml` ```yaml dependencies: - web3auth_flutter: ^2.0.3 + web3auth_flutter: ^3.1.0 ``` or @@ -133,15 +133,6 @@ dependencyResolutionManagement { } ``` -Then, in your app-level `build.gradle` dependencies section, add the following: - -```groovy -dependencies { - // highlight-next-line - implementation 'com.github.Web3Auth:web3auth-android-sdk:4.0.8' -} -``` - #### Permissions Open your app's `AndroidManifest.xml` file and add the following permission: @@ -200,16 +191,16 @@ If you are using the Swift Package Manager, open the following menu item in Xcod `File > Swift Packages > Add Package Dependency` -In the Choose Package Repository prompt add this url: +In the Choose Package Repository prompt add this URL: ``` -https://github.com/Web3Auth/web3auth-swift-sdk/releases/tag/6.0.1 +https://github.com/Web3Auth/web3auth-swift-sdk/releases/tag/7.4.0 ``` ##### Cocoapods ```sh -pod 'Web3Auth', '~> 6.0.1' +pod 'Web3Auth', '~> 7.4.0' ``` #### Configuration @@ -254,8 +245,6 @@ void initState() { // Initialization Future initPlatformState() async { - HashMap themeMap = new HashMap(); - themeMap['primary'] = "#fff000"; Uri redirectUrl; if (Platform.isAndroid) { @@ -283,10 +272,12 @@ Future initPlatformState() async { loginConfig: loginConfig )); // highlight-end + + await Web3AuthFlutter.initialize(); } ``` -Read more about initialising the Flutter SDK [here](/sdk/pnp/flutter/initialize). +Read more about initializing the Flutter SDK [here](/sdk/pnp/flutter/initialize). ### Authentication @@ -593,7 +584,7 @@ try running it locally yourself! `flutter run` -Also, checkout other examples: +Also, check other examples: - [Using Auth0 Custom Authentication](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-auth0-example) - [Using Flutter SDK](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-quick-start) diff --git a/src/pages/content-hub/guides/flutter.mdx b/src/pages/content-hub/guides/flutter.mdx index a4ef271fa..8aaffa228 100644 --- a/src/pages/content-hub/guides/flutter.mdx +++ b/src/pages/content-hub/guides/flutter.mdx @@ -58,7 +58,7 @@ When integrating Web3Auth Flutter SDK with Social Login the flow looks something - Android API version 24 or newer. -- For Android build: compileSdkVersion needs to be 32. Check `android/app/build.gradle` in your Flutter project to change it. +- For Android build: compileSdkVersion needs to be 34. Check `android/app/build.gradle` in your Flutter project to change it. - iOS 12+ - Xcode 11.4+ / 12.x - Swift 4.x / 5.x @@ -86,7 +86,7 @@ Add `web3auth_flutter` as a dependency to your `pubspec.yaml` ```yaml dependencies: - web3auth_flutter: ^2.0.3 + web3auth_flutter: ^3.1.0 ``` or @@ -121,15 +121,6 @@ dependencyResolutionManagement { } ``` -Then, in your app-level `build.gradle` dependencies section, add the following: - -```groovy -dependencies { - // highlight-next-line - implementation 'com.github.Web3Auth:web3auth-android-sdk:4.0.8' -} -``` - #### Permissions Open your app's `AndroidManifest.xml` file and add the following permission: @@ -188,16 +179,16 @@ If you are using the Swift Package Manager, open the following menu item in Xcod `File > Swift Packages > Add Package Dependency` -In the Choose Package Repository prompt add this url: +In the Choose Package Repository prompt add this URL: ``` -https://github.com/Web3Auth/web3auth-swift-sdk/releases/tag/6.0.1 +https://github.com/Web3Auth/web3auth-swift-sdk/releases/tag/7.4.0 ``` ##### Cocoapods ```sh -pod 'Web3Auth', '~> 6.0.1' +pod 'Web3Auth', '~> 7.4.0' ``` #### Configuration @@ -242,8 +233,6 @@ void initState() { // Initialization Future initPlatformState() async { - HashMap themeMap = new HashMap(); - themeMap['primary'] = "#fff000"; Uri redirectUrl; if (Platform.isAndroid) { @@ -262,10 +251,12 @@ Future initPlatformState() async { redirectUri: redirectUrl, )); // highlight-end + + await Web3AuthFlutter.initialize(); } ``` -Read more about initialising the Flutter SDK [here](/sdk/pnp/flutter/initialize). +Read more about initializing the Flutter SDK [here](/sdk/pnp/flutter/initialize). ### Authentication @@ -567,7 +558,7 @@ locally yourself! `flutter run` -Also, checkout other examples: +Also, check other examples: - [Using Auth0 Custom Authentication](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-auth0-example) - [Using Custom JWT (via Firebase)](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-firebase-example)