Merge pull request #991 from Web3Auth/add-chiliz-docs

Add Chilliz docs
Web3Auth · Nov 16, 2024 · 686f5db · 686f5db
2 parents 567d61e + bccf5a4
commit 686f5db
Show file tree

Hide file tree

Showing 11 changed files with 562 additions and 0 deletions.
diff --git a/docs/connect-blockchain/evm/chiliz/android.mdx b/docs/connect-blockchain/evm/chiliz/android.mdx
@@ -0,0 +1,25 @@
+---
+title: Integrate Web3Auth with the Chiliz Blockchain in Android
+sidebar_label: Android
+image: "banners/chiliz.png"
+
+keywords: [android, chiliz, web3auth, authentication, blockchain]
+description: "Integrate Web3Auth with the Chiliz Blockchain in Android | Documentation - Web3Auth"
+---
+
+import EVMInteraction from "@site/src/common/docs/android-connect-blockchain/_evm-interaction.mdx";
+import SEO from "@site/src/components/SEO";
+
+<SEO
+  title="Integrate Web3Auth with the Chiliz Blockchain in Android"
+  description="Integrate Web3Auth with the Chiliz Blockchain in Android | Documentation - Web3Auth"
+  image="https://web3auth.io/docs/banners/chiliz.png"
+  slug="/connect-blockchain/evm/chiliz/android"
+/>
+
+While using the Web3Auth Android SDK, you get the private key within the user scope after successful
+authorization. This private key can be used to retrieve the user's address, and interact with
+[Chiliz](https://chiliz.com) to make any blockchain calls. We have highlighted a few here for
+getting you started quickly on that.
+
+<EVMInteraction />
diff --git a/docs/connect-blockchain/evm/chiliz/chiliz.mdx b/docs/connect-blockchain/evm/chiliz/chiliz.mdx
@@ -0,0 +1,73 @@
+---
+title: Integrate Web3Auth with the Chiliz Blockchain
+hide_table_of_contents: true
+
+image: "banners/chiliz.png"
+description: "Integrate Web3Auth with the Chiliz Blockchain | Documentation - Web3Auth"
+---
+
+import Tiles from "@theme/Tiles";
+import SEO from "@site/src/components/SEO";
+
+<SEO
+  title="Integrate Web3Auth with the Chiliz Blockchain"
+  description="Integrate Web3Auth with the Chiliz Blockchain | Documentation - Web3Auth"
+  image="https://web3auth.io/docs/banners/chiliz.png"
+  slug="/connect-blockchain/evm/chiliz"
+/>
+
+Integrate Web3Auth seamlessly with EVM-based Chiliz Blockchain. For Web SDKs, Web3Auth returns a
+provider that can be directly used to initialize the libraries like ethers.js, web3.js etc. and make
+blockchain calls, while for Mobile & Gaming SDKs, the private key is available in the user scope
+which can be used in a similar way to initialize the respective blockchain interaction libraries and
+make calls to the network.
+
+This documentation provides a straightforward guide for developers looking to implement blockchain
+connections quickly and effortlessly across various platforms.
+
+export const Chiliz = [
+  {
+    name: "",
+    description: "",
+    tiles: [
+      {
+        key: "web",
+        title: "Web",
+        icon: "logo-js.png",
+        path: "/connect-blockchain/evm/chiliz/web",
+      },
+      {
+        key: "android",
+        title: "Android (Kotlin)",
+        icon: "logo-android.png",
+        path: "/connect-blockchain/evm/chiliz/android",
+      },
+      {
+        key: "apple",
+        title: "iOS (Swift)",
+        icon: "logo-apple.png",
+        path: "/connect-blockchain/evm/chiliz/ios",
+      },
+      {
+        key: "flutter",
+        title: "Flutter",
+        icon: "logo-flutter.png",
+        path: "/connect-blockchain/evm/chiliz/flutter",
+      },
+      {
+        key: "react-native",
+        title: "React Native",
+        icon: "logo-react.png",
+        path: "/connect-blockchain/evm/chiliz/react-native",
+      },
+      {
+        key: "unity",
+        title: "Unity",
+        icon: "logo-unity.png",
+        path: "/connect-blockchain/evm/chiliz/unity",
+      },
+    ],
+  },
+];
+
+<Tiles tileGroups={Chiliz} />
diff --git a/docs/connect-blockchain/evm/chiliz/flutter.mdx b/docs/connect-blockchain/evm/chiliz/flutter.mdx
@@ -0,0 +1,27 @@
+---
+title: Integrate Web3Auth with the Chiliz Blockchain in Flutter
+sidebar_label: Flutter
+image: "banners/chiliz.png"
+
+keywords: [flutter, chiliz, web3auth, authentication, blockchain]
+description: "Integrate Web3Auth with the Chiliz Blockchain in Flutter | Documentation - Web3Auth"
+---
+
+import EVMInteraction from "@site/src/common/docs/flutter-connect-blockchain/_evm-interaction.mdx";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import SEO from "@site/src/components/SEO";
+
+<SEO
+  title="Integrate Web3Auth with the Chiliz Blockchain in Flutter"
+  description="Integrate Web3Auth with the Chiliz Blockchain in Flutter | Documentation - Web3Auth"
+  image="https://web3auth.io/docs/banners/chiliz.png"
+  slug="/connect-blockchain/evm/chiliz/flutter"
+/>
+
+While using the Web3Auth Flutter SDK, you get the private key within the user scope after successful
+authorization. This private key can be used to retrieve the user's address, and interact with
+[Chiliz](https://chiliz.com) to make any blockchain calls. We have highlighted a few here for
+getting you started quickly on that.
+
+<EVMInteraction />
diff --git a/docs/connect-blockchain/evm/chiliz/ios.mdx b/docs/connect-blockchain/evm/chiliz/ios.mdx
@@ -0,0 +1,27 @@
+---
+title: Integrate Web3Auth with the Chiliz Blockchain in iOS/Swift Applications
+sidebar_label: iOS
+image: "/docs/banners/chiliz.png"
+
+keywords: [ios, swift, chiliz, web3auth, authentication, blockchain]
+description:
+  "Integrate Web3Auth with the Chiliz Blockchain in iOS/Swift Applications | Documentation -
+  Web3Auth"
+---
+
+import EVMInteraction from "@site/src/common/docs/ios-connect-blockchain/_evm-interaction.mdx";
+import SEO from "@site/src/components/SEO";
+
+<SEO
+  title="Integrate Web3Auth with the Chiliz Blockchain in iOS/Swift Applications"
+  description="Integrate Web3Auth with the Chiliz Blockchain in iOS/Swift Applications | Documentation - Web3Auth"
+  image="https://web3auth.io/docs/banners/chiliz.png"
+  slug="/connect-blockchain/evm/chiliz/ios"
+/>
+
+While using the Web3Auth iOS SDK, you get the private key within the user scope after successful
+authorization. This private key can be used to retrieve the user's address, and interact with
+[Chiliz](https://chiliz.com) to make any blockchain calls. We have highlighted a few here for
+getting you started quickly on that.
+
+<EVMInteraction />
diff --git a/docs/connect-blockchain/evm/chiliz/react-native.mdx b/docs/connect-blockchain/evm/chiliz/react-native.mdx
@@ -0,0 +1,120 @@
+---
+title: Integrate Web3Auth with the Chiliz Blockchain in React Native
+sidebar_label: React Native
+image: "banners/chiliz.png"
+
+keywords: [react-native, chiliz, web3auth, authentication, blockchain]
+description:
+  "Integrate Web3Auth with the Chiliz Blockchain in React Native | Documentation - Web3Auth"
+---
+
+import InstallationSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-installation.mdx";
+import GetAccountSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-get-account.mdx";
+import UserInfoSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-user-info.mdx";
+import GetBalanceSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-get-balance.mdx";
+import InitialisationSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-initialisation.mdx";
+import SignMessageSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-sign-message.mdx";
+import SendTransactionSnippet from "@site/src/common/docs/react-native-connect-blockchain/_evm-send-transaction.mdx";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import SEO from "@site/src/components/SEO";
+
+<SEO
+  title="Integrate Web3Auth with the Chiliz Blockchain in React Native"
+  description="Integrate Web3Auth with the Chiliz Blockchain in React Native | Documentation - Web3Auth"
+  image="https://web3auth.io/docs/banners/chiliz.png"
+  slug="/connect-blockchain/evm/chiliz/react-native"
+/>
+
+While using the Web3Auth React Native SDK, you get a
+[`EIP1193`](https://eips.ethereum.org/EIPS/eip-1193) provider, similar to the
+[Metamask Provider](https://docs.metamask.io/guide/ethereum-provider.html). This provider can be
+used with libraries like [`web3.js`](https://web3js.readthedocs.io/en/v1.2.8/getting-started.html),
+[`ethers.js`](https://docs.ethers.io/v5/getting-started/) etc. to make
+[Chiliz Blockchain](https://www.chiliz.com) blockchain calls like getting the user's `account`,
+fetching `balance`, signing transactions, sending transactions, and interacting with smart
+contracts. We have highlighted a few key examples to get you started quickly on that.
+
+## Installation
+
+<InstallationSnippet />
+
+## Initializing Provider
+
+Using `eip155` as `chainNamespace` while initializing `web3auth` will provide an
+[`EIP1193`](https://eips.ethereum.org/EIPS/eip-1193) compatible provider as **`web3auth.provider`**
+after successful authentication.
+
+### Getting the `chainConfig`
+
+<Tabs
+ defaultValue="mainnet"
+  values={[
+    { label: "Mainnet", value: "mainnet", },
+    { label: "Testnet", value: "testnet", },
+  ]}
+>
+<TabItem
+  value="mainnet"
+>
+
+```typescript
+const chainConfig = {
+  chainNamespace: ChainNamespace.EIP155,
+  chainId: "0x15B38", // hex of 88888, Chiliz Mainnet
+  rpcTarget: "https://rpc.ankr.com/chiliz",
+  // Avoid using public rpcTarget in production.
+  // Use services like Infura, Quicknode, etc.
+  displayName: "Chiliz Mainnet",
+  blockExplorer: "https://chiliscan.com",
+  ticker: "CHZ",
+  tickerName: "Chiliz",
+};
+```
+
+</TabItem>
+
+<TabItem
+  value="testnet"
+>
+
+```typescript
+const chainConfig = {
+  chainNamespace: ChainNamespace.EIP155,
+  chainId: "0x15B42", // hex of 88882, Chiliz Spicy Testnet
+  rpcTarget: "https://spicy-rpc.chiliz.com/",
+  // Avoid using public rpcTarget in production.
+  // Use services like Infura, Quicknode, etc.
+  displayName: "Chiliz Spicy Testnet",
+  blockExplorer: "https://testnet.chiliscan.com/",
+  ticker: "CHZ",
+  tickerName: "Chiliz (Testnet)",
+};
+```
+
+</TabItem>
+</Tabs>
+
+## Initialize
+
+<InitialisationSnippet />
+
+## Get User Info
+
+<UserInfoSnippet />
+
+## Get Account
+
+<GetAccountSnippet />
+
+## Get Balance
+
+<GetBalanceSnippet />
+
+## Send Transaction
+
+<SendTransactionSnippet />
+
+## Sign a message
+
+<SignMessageSnippet />
diff --git a/docs/connect-blockchain/evm/chiliz/unity.mdx b/docs/connect-blockchain/evm/chiliz/unity.mdx
@@ -0,0 +1,104 @@
+---
+title: Integrate Web3Auth with the Chiliz Blockchain in Unity
+sidebar_label: Unity
+image: "banners/chiliz.png"
+
+keywords: [unity, chiliz, web3auth, authentication, blockchain]
+description: "Integrate Web3Auth with the Chiliz Blockchain in Unity | Documentation - Web3Auth"
+---
+
+import InstallationSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-installation.mdx";
+import GetAccountSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-get-account.mdx";
+import UserInfoSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-user-info.mdx";
+import GetBalanceSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-get-balance.mdx";
+import InitialisationSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-initialisation.mdx";
+import SignMessageSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-sign-message.mdx";
+import SendTransactionSnippet from "@site/src/common/docs/unity-connect-blockchain/_evm-send-transaction.mdx";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import SEO from "@site/src/components/SEO";
+
+<SEO
+  title="Integrate Web3Auth with the Chiliz Blockchain in Unity"
+  description="Integrate Web3Auth with the Chiliz Blockchain in Unity | Documentation - Web3Auth"
+  image="https://web3auth.io/docs/banners/chiliz.png"
+  slug="/connect-blockchain/evm/chiliz/unity"
+/>
+
+While using the Web3Auth Unity SDK, you get the private key within the user scope. This private key
+can interact with the [Nethereum Library](https://nethereum.com/) to make EVM-based blockchain
+calls, like getting the user's `account`, fetching `balance`, `signing transaction`,
+`sending transactions`, `reading` from and `writing` to smart contracts. We have highlighted a few
+examples to get you started.
+
+## Installation
+
+<InstallationSnippet />
+
+## Chain Details for Chiliz
+
+<Tabs
+ defaultValue="mainnet"
+  values={[
+    { label: "Mainnet", value: "mainnet", },
+    { label: "Testnet", value: "testnet", },
+  ]}
+>
+<TabItem
+  value="mainnet"
+>
+
+- Chain ID: 0x15B38
+- Public RPC URL: https://rpc.ankr.com/chiliz (Avoid using public rpcTarget in production, use
+  services like Infura, Quicknode, etc.)
+- Alternate RPC URL: https://chiliz.publicnode.com
+- Display Name: Chiliz Mainnet
+- Block Explorer Link: https://chiliscan.com
+- Alternate Block Explorer: https://scan.chiliz.com
+- Ticker: CHZ
+- Ticker Name: Chiliz
+
+</TabItem>
+
+<TabItem
+  value="testnet"
+>
+
+- Chain ID: 0x15B42
+- Public RPC URL: https://spicy-rpc.chiliz.com/ (Avoid using public rpcTarget in production, use
+  services like Infura, Quicknode, etc.)
+- Alternate RPC URL: https://chiliz-spicy.publicnode.com
+- RPC Websocket URL: wss://spicy-rpc-ws.chiliz.com/
+- Alternate Websocket URL: wss://chiliz-spicy.publicnode.com
+- Display Name: Chiliz Spicy Testnet
+- Block Explorer Link: https://testnet.chiliscan.com/
+- Alternate Block Explorer: http://spicy-explorer.chiliz.com/
+- Ticker: CHZ
+- Ticker Name: Chiliz (Testnet)
+
+</TabItem>
+</Tabs>
+
+## Initialize
+
+<InitialisationSnippet />
+
+## Get User Info
+
+<UserInfoSnippet />
+
+## Get Account
+
+<GetAccountSnippet />
+
+## Get Balance
+
+<GetBalanceSnippet />
+
+## Sign a message
+
+<SignMessageSnippet />
+
+## Send Transaction
+
+<SendTransactionSnippet />