diff --git a/docs/connect-blockchain/evm/bitkub/android.mdx b/docs/connect-blockchain/evm/bitkub/android.mdx new file mode 100644 index 000000000..6431dd15d --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/android.mdx @@ -0,0 +1,24 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain in Android +sidebar_label: Android +image: "banners/bitkub.png" +keywords: [android, bitkub, web3auth, authentication, blockchain] +description: "Integrate Web3Auth with the BitKub 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"; + + + +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 +[BitKub](https://developers.bitkubchain.com/) to make any blockchain calls. We have highlighted a +few here for getting you started quickly on that. + + diff --git a/docs/connect-blockchain/evm/bitkub/bitkub.mdx b/docs/connect-blockchain/evm/bitkub/bitkub.mdx new file mode 100644 index 000000000..31855cfb9 --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/bitkub.mdx @@ -0,0 +1,67 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain +hide_table_of_contents: true +image: "banners/bitkub.png" +description: "Integrate Web3Auth with the BitKub Blockchain | Documentation - Web3Auth" +--- + +import Tiles from "@theme/Tiles"; +import SEO from "@site/src/components/SEO"; + + + +The BitKub blockchain's integration with Web3Auth, helps you get started with the integration in a +matter of minutes. The integration is available for the following platforms: Web, Android, iOS, +Flutter, React Native, and Unity. + +export const BitKub = [ + { + name: "", + description: "", + tiles: [ + { + key: "web", + title: "Web", + icon: "logo-js.png", + path: "/connect-blockchain/evm/bitkub/web", + }, + { + key: "android", + title: "Android (Kotlin)", + icon: "logo-android.png", + path: "/connect-blockchain/evm/bitkub/android", + }, + { + key: "apple", + title: "iOS (Swift)", + icon: "logo-apple.png", + path: "/connect-blockchain/evm/bitkub/ios", + }, + { + key: "flutter", + title: "Flutter", + icon: "logo-flutter.png", + path: "/connect-blockchain/evm/bitkub/flutter", + }, + { + key: "react-native", + title: "React Native", + icon: "logo-react.png", + path: "/connect-blockchain/evm/bitkub/react-native", + }, + { + key: "unity", + title: "Unity", + icon: "logo-unity.png", + path: "/connect-blockchain/evm/bitkub/unity", + }, + ], + }, +]; + + diff --git a/docs/connect-blockchain/evm/bitkub/flutter.mdx b/docs/connect-blockchain/evm/bitkub/flutter.mdx new file mode 100644 index 000000000..46218a84e --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/flutter.mdx @@ -0,0 +1,26 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain in Flutter +sidebar_label: Flutter +image: "banners/bitkub.png" +keywords: [flutter, bitkub, web3auth, authentication, blockchain] +description: "Integrate Web3Auth with the BitKub 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"; + + + +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 +[BitKub](https://developers.bitkubchain.com/) to make any blockchain calls. We have highlighted a +few here for getting you started quickly on that. + + diff --git a/docs/connect-blockchain/evm/bitkub/ios.mdx b/docs/connect-blockchain/evm/bitkub/ios.mdx new file mode 100644 index 000000000..6605ce7d1 --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/ios.mdx @@ -0,0 +1,97 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain in iOS/Swift Applications +sidebar_label: iOS +image: "banners/bitkub.png" +keywords: [ios, swift, bitkub, web3auth, authentication, blockchain] +description: + "Integrate Web3Auth with the BitKub Blockchain in iOS/Swift Applications | Documentation - + Web3Auth" +--- + +import InstallationSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-installation.mdx"; +import GetAccountSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-get-account.mdx"; +import UserInfoSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-user-info.mdx"; +import GetBalanceSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-get-balance.mdx"; +import InitialisationSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-initialisation.mdx"; +import SignMessageSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-sign-message.mdx"; +import SendTransactionSnippet from "@site/src/common/docs/ios-connect-blockchain/_evm-send-transaction.mdx"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import SEO from "@site/src/components/SEO"; + + + +While using the Web3Auth iOS SDK, you get the private key within the user scope. This private key +can interact with [BitKub](https://developers.bitkubchain.com/) to make any blockchain calls, like +getting the user's `account`, fetching `balance`, `sign transaction`, `send transaction`, `read` +from and `write` to the smart contract, etc. We have highlighted a few here to get you started +quickly on that. + +## Installation + + + +## Chain Details for BitKub + + + + +- Chain ID: `0x60` +- Public RPC URL: `https://rpc.bitkubchain.io` +- Display Name: BitKub Mainnet +- Block Explorer Link: `https://www.bkcscan.com` +- Ticker: KUB +- Ticker Name: KUB + + + + + +- Chain ID: `0x6545` +- Public RPC URL: `https://rpc-testnet.bitkubchain.io/` +- Display Name: BitKub Testnet +- Block Explorer Link: `https://testnet.bkcscan.com` +- Ticker: tKUB +- Ticker Name: tKUB + + + + +## Initialize + + + +## Get User Info + + + +## Get Account + + + +## Get Balance + + + +## Send Transaction + + + +## Sign a message + + diff --git a/docs/connect-blockchain/evm/bitkub/react-native.mdx b/docs/connect-blockchain/evm/bitkub/react-native.mdx new file mode 100644 index 000000000..fc8006f15 --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/react-native.mdx @@ -0,0 +1,119 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain in React Native +sidebar_label: React Native +image: "banners/bitkub.png" +keywords: [react-native, bitkub, web3auth, authentication, blockchain] +description: + "Integrate Web3Auth with the BitKub 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"; + + + +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 +[BitKub](https://developers.bitkubchain.com/) blockchain calls like getting the user's `account`, +fetching `balance`, `sign transaction`, `send transaction`, `read` from and `write` to the smart +contract, etc. We have highlighted a few here to get you started quickly on that. + +## Installation + + + +## 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` + + + + +```typescript +const chainConfig = { + chainNamespace: ChainNamespace.EIP155, + chainId: "0x60", // hex of 96 + rpcTarget: "https://rpc.bitkubchain.io", + // Avoid using public rpcTarget in production. + // Use services like Infura, Quicknode etc + displayName: "BitKub", + blockExplorer: "https://www.bkcscan.com", + ticker: "KUB", + tickerName: "KUB", +}; +``` + + + + + +```typescript +const chainConfig = { + chainNamespace: ChainNamespace.EIP155, + chainId: "0x6545", // hex of 25925 + rpcTarget: "https://rpc-testnet.bitkubchain.io", + // Avoid using public rpcTarget in production. + // Use services like Infura, Quicknode etc + displayName: "BitKub Testnet", + blockExplorer: "https://testnet.bkcscan.com", + ticker: "tKUB", + tickerName: "tKUB", +}; +``` + + + + +## Initialize + + + +## Get User Info + + + +## Get Account + + + +## Get Balance + + + +## Send Transaction + + + +## Sign a message + + diff --git a/docs/connect-blockchain/evm/bitkub/unity.mdx b/docs/connect-blockchain/evm/bitkub/unity.mdx new file mode 100644 index 000000000..7d5172da7 --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/unity.mdx @@ -0,0 +1,95 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain in Unity +sidebar_label: Unity +image: "banners/bitkub.png" +keywords: [unity, bitkub, web3auth, authentication, blockchain] +description: "Integrate Web3Auth with the BitKub 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"; + + + +While using the Web3Auth Unity SDK, you get the private key within the user scope. This private key +can interact with the [BitKub](https://developers.bitkubchain.com/) to make EVM-based 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 here to get you +started quickly on that. + +## Installation + + + +## Chain Details for BitKub + + + + +- Chain ID: `0x60` +- Public RPC URL: `https://rpc.bitkubchain.io` +- Display Name: BitKub Mainnet +- Block Explorer Link: `https://www.bkcscan.com` +- Ticker: KUB +- Ticker Name: KUB + + + + + +- Chain ID: `0x6545` +- Public RPC URL: `https://rpc-testnet.bitkubchain.io/` +- Display Name: BitKub Testnet +- Block Explorer Link: `https://testnet.bkcscan.com` +- Ticker: tKUB +- Ticker Name: tKUB + + + + +## Initialize + + + +## Get User Info + + + +## Get Account + + + +## Get Balance + + + +## Sign a message + + + +## Send Transaction + + diff --git a/docs/connect-blockchain/evm/bitkub/web.mdx b/docs/connect-blockchain/evm/bitkub/web.mdx new file mode 100644 index 000000000..b7e4b452f --- /dev/null +++ b/docs/connect-blockchain/evm/bitkub/web.mdx @@ -0,0 +1,158 @@ +--- +title: Integrate Web3Auth with the BitKub Blockchain in JavaScript +sidebar_label: Web +image: "banners/bitkub.png" +keywords: [bitkub, web3auth, authentication, blockchain] +description: + "Integrate Web3Auth with the BitKub Blockchain in JavaScript | Documentation - Web3Auth" +--- + +import InstallationSnippet from "@site/src/common/docs/web-connect-blockchain/_evm-installation.mdx"; +import GetUserInfoSnippet from "@site/src/common/docs/_get-userinfo.mdx"; +import GetAccountAndBalanceSnippet from "@site/src/common/docs/web-connect-blockchain/_evm-get-account-n-balance.mdx"; +import SendTransactionSnippet from "@site/src/common/docs/web-connect-blockchain/_evm-send-transaction.mdx"; +import SignTransactionSnippet from "@site/src/common/docs/web-connect-blockchain/_evm-sign-transaction.mdx"; +import SignPersonalMessageSnippet from "@site/src/common/docs/web-connect-blockchain/_evm-sign-message-personal-sign.mdx"; +import SignTypedDataV4Snippet from "@site/src/common/docs/web-connect-blockchain/_evm-sign-message-v4.mdx"; +import SmartContractSoliditySnippet from "@site/src/common/docs/_smart-contract-solidity.mdx"; +import DeployContractSolidityDeploySnippet from "@site/src/common/docs/_smart-contract-solidity-deploy.mdx"; +import DeployContractSolidityReadSnippet from "@site/src/common/docs/_smart-contract-solidity-read.mdx"; +import DeployContractSolidityWriteSnippet from "@site/src/common/docs/_smart-contract-solidity-write.mdx"; +import FetchUserPrivateKeySnippet from "@site/src/common/docs/web-connect-blockchain/_evm-fetch-user-private-key.mdx"; +import InitializeWeb3Auth from "@site/src/common/docs/_initialize-web3auth-evm-pnp-sfa.mdx"; +import GetWeb3AuthProvider from "@site/src/common/docs/_get-web3auth-provider.mdx"; +import TabItem from "@theme/TabItem"; +import Tabs from "@theme/Tabs"; +import SEO from "@site/src/components/SEO"; + + + +While using the Web3Auth Web 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 +[BitKub](https://docs.bitkubchain.org) blockchain calls like getting the user's `account`, fetching +`balance`, `sign transaction`, `send transaction`, `read` from and `write` to the smart contract, +etc. We have highlighted a few here to get you started quickly on that. + +## Installation + +To interact with the BitKub blockchain, you can use either library with Web3Auth. + + + +## 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` + + + + +```typescript +const chainConfig = { + chainNamespace: ChainNamespace.EIP155, + chainId: "0x60", // hex of 96 + rpcTarget: "https://rpc.bitkubchain.io", + // Avoid using public rpcTarget in production. + // Use services like Infura, Quicknode etc + displayName: "BitKub", + blockExplorer: "https://www.bkcscan.com", + ticker: "KUB", + tickerName: "KUB", + logo: "https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/151011411910/original/BLLsZXQuCMERrt1iuNKKz3-ebSbLflZ1qQ.png", +}; +``` + + + + + +```typescript +const chainConfig = { + chainNamespace: ChainNamespace.EIP155, + chainId: "0x6545", // hex of 25925 + rpcTarget: "https://rpc-testnet.bitkubchain.io", + // Avoid using public rpcTarget in production. + // Use services like Infura, Quicknode etc + displayName: "BitKub Testnet", + blockExplorer: "https://testnet.bkcscan.com", + ticker: "tKUB", + tickerName: "tKUB", + logo: "https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/151011411910/original/BLLsZXQuCMERrt1iuNKKz3-ebSbLflZ1qQ.png", +}; +``` + + + + +### Initializing and instantiating the Web3Auth SDK + + + +## Getting the Web3Auth provider + + + + + +## Get Account and Balance + + + +## Send Transaction + + + +## Sign Transaction + + + +## Sign Message + +### Personal Sign + + + +### Sign Typed Data v4 + + + +## Smart Contract + + + +### Deploy Contract + + + +### Read From Contract + + + +### Write to Contract + + + +## Fetch User's Private Key + + diff --git a/sidebars.ts b/sidebars.ts index 3e85baf3f..a8ce908e2 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -585,6 +585,19 @@ const sidebars: SidebarsConfig = { "connect-blockchain/evm/base/unity", ], }, + { + type: "category", + label: "BitKub", + items: [ + "connect-blockchain/evm/bitkub/bitkub", + "connect-blockchain/evm/bitkub/web", + "connect-blockchain/evm/bitkub/android", + "connect-blockchain/evm/bitkub/ios", + "connect-blockchain/evm/bitkub/react-native", + "connect-blockchain/evm/bitkub/flutter", + "connect-blockchain/evm/bitkub/unity", + ], + }, { type: "category", label: "BNB Chain", diff --git a/src/common/docs/_evm-chains.mdx b/src/common/docs/_evm-chains.mdx index c5def0832..a290de1a8 100644 --- a/src/common/docs/_evm-chains.mdx +++ b/src/common/docs/_evm-chains.mdx @@ -65,6 +65,12 @@ export const EVMChains = [ icon: "logo-binance.png", path: "/connect-blockchain/evm/bnb/", }, + { + key: "bitkub", + title: "BitKub", + icon: "logo-bitkub.png", + path: "/connect-blockchain/evm/bitkub/", + }, { key: "celo", title: "Celo", diff --git a/src/components/BlockchainCards/index.tsx b/src/components/BlockchainCards/index.tsx index 3bef89a90..aa31ac94c 100644 --- a/src/components/BlockchainCards/index.tsx +++ b/src/components/BlockchainCards/index.tsx @@ -43,7 +43,12 @@ export const tileGroupsData = [ icon: "logo-binance.png", path: "./connect-blockchain/bnb", }, - + { + key: "bitkub", + title: "BitKub", + icon: "logo-bitkub.png", + path: "./connect-blockchain/bitkub", + }, { key: "avalanche", title: "Avalanche", diff --git a/static/banners/bitkub.png b/static/banners/bitkub.png new file mode 100644 index 000000000..3a55d9f86 Binary files /dev/null and b/static/banners/bitkub.png differ diff --git a/static/logos/logo-bitkub.png b/static/logos/logo-bitkub.png new file mode 100644 index 000000000..109b387d6 Binary files /dev/null and b/static/logos/logo-bitkub.png differ