Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typos #123

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: typos #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api-reference/aa/sdks/mobile/ios.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,17 +135,17 @@ E.g.:

```swift
// Gasless
let txHash = try await auth.evm.sendTransacton(transaction, feeMode: .gasless, chainInfo: chainInfo)
let txHash = try await auth.evm.sendTransaction(transaction, feeMode: .gasless, chainInfo: chainInfo)

let txHash = try await aaService.quickSendTransactions([transaction], feeMode: .gasless, messageSigner: self, wholeFeeQuote: wholeFeeQuote, chainInfo: chainInfo).value

// Native
let txHash = try await auth.evm.sendTransacton(transaction, feeMode: .native, chainInfo: chainInfo)
let txHash = try await auth.evm.sendTransaction(transaction, feeMode: .native, chainInfo: chainInfo)

let txHash = try await aaService.quickSendTransactions([transaction], feeMode: .native, messageSigner: self, wholeFeeQuote: wholeFeeQuote, chainInfo: chainInfo).value

// ERC-20 Token
let txHash = try await auth.evm.sendTransacton(transaction, feeMode: .token(feeQuote), chainInfo: chainInfo)
let txHash = try await auth.evm.sendTransaction(transaction, feeMode: .token(feeQuote), chainInfo: chainInfo)

let txHash = try await aaService.quickSendTransactions([transaction], feeMode: .token(feeQuote), messageSigner: self, wholeFeeQuote: wholeFeeQuote, chainInfo: chainInfo).value
```
Expand Down
10 changes: 5 additions & 5 deletions api-reference/auth/mobile-sdks/flutter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Before using the full extent of the SDK, you'll need to initialize it with `init
```dart
// Set relevant project info, retrieved from https://dashboard.particle.network
ParticleInfo.set(projectId, clientKey);
// Inititilze ParticleAuth and ParticleAuthCore.
// Initialize ParticleAuth and ParticleAuthCore.
ParticleBase.init(ChainInfo.Ethereum, env);
ParticleAuthCore.init()
```
Expand Down Expand Up @@ -271,7 +271,7 @@ If you need the same message to return a unique signature each time, use the `Ev

| Field | Type | Description |
| --------- | -------- | --------------------------------------------------------------------------------- |
| `message` | `String` | On Evm requires a hexadeciaml string, on Solana, requires a UTF-8/readable string |
| `message` | `String` | On Evm requires a hexadecimal string, on Solana, requires a UTF-8/readable string |

```dart
final messageHex = "0x${StringUtils.toHexString("Hello Particle")}";
Expand Down Expand Up @@ -310,13 +310,13 @@ List<String> signatures = await Solana.signAllTransactions(transactions);

### Sign and Send Transaction

For more generalized transaction execution, `Evm.sendTransaction` and sendTransaction` and `Solana.signAndSendTransaction` will be the primary smethods used in virtually every scenario.
For more generalized transaction execution, `Evm.sendTransaction` and sendTransaction` and `Solana.signAndSendTransaction` will be the primary methods used in virtually every scenario.

This will propose a signature (on both EVM and Solana) and then immediately push it to the network once confirmed.

| Field | Type | Description |
| ------------- | -------- | ------------------------------------------------------------------------- |
| `transaction` | `String` | On Evm requires a hexadeciaml string, on Solana, requires a base58 string |
| `transaction` | `String` | On Evm requires a hexadecimal string, on Solana, requires a base58 string |

```dart
final signature = await Evm.sendTransaction(transaction);
Expand All @@ -331,7 +331,7 @@ If you need the same message to return a unique signature each time, use the `Ev

| Field | Type | Description |
| --------- | -------- | ----------------------------- |
| `message` | `String` | Requires a hexadeciaml string |
| `message` | `String` | Requires a hexadecimal string |

```dart
// your typed data is a json string
Expand Down
4 changes: 2 additions & 2 deletions api-reference/auth/mobile-sdks/ios.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ This same logic applies to `promptMasterPasswordSettingWhenLogin`, which by defa
ParticleNetwork.setSecurityAccountConfig(config:
.init(promptSettingWhenSign: 1, promptMasterPasswordSettingWhenLogin: 2))

let securityAccountConfig = PartilceNetwork.getSecurityAccountConfig()
let securityAccountConfig = ParticleNetwork.getSecurityAccountConfig()
```

---
Expand Down Expand Up @@ -376,7 +376,7 @@ You can forcibly set a specific appearance to be used within the UI using `Parti

| Field | Type | Description |
| ------------ | ---------------------- | ----------------------------------------------------------------------------------------- |
| `appearance` | `UIUserInterfaceStyle` | The specific appearance to be used. This can be either `.unspefified`, `.dark`, `.light`. |
| `appearance` | `UIUserInterfaceStyle` | The specific appearance to be used. This can be either `.unspecified`, `.dark`, `.light`. |

```swift
// This is the default setting, auto
Expand Down
8 changes: 4 additions & 4 deletions api-reference/auth/mobile-sdks/react.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ For first-time users, only the address of the current chain will be generated. F
```typeScript
import {evm, solana} from '@particle-network/rn-auth-core';

const evmAaddress = await evm.getAddress();
const evmAddress = await evm.getAddress();
const solanaAddress = await solana.getAddress();
```

Expand All @@ -321,7 +321,7 @@ To request an EIP191 signature from a user's account, you can use either the `ev

| Field | Type | Description |
| --------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `message` | `string` | On Evm requires a hexadeciaml string or a UTF-8/readable string, on Solana, requires a UTF-8/readable string |
| `message` | `string` | On Evm requires a hexadecimal string or a UTF-8/readable string, on Solana, requires a UTF-8/readable string |

```typeScript
const message = "GM, Particle!"
Expand Down Expand Up @@ -366,7 +366,7 @@ For more generalized transaction sending, `evm.sendTransaction`and `solana.signA

| Field | Type | Description |
| ------------- | -------- | ------------------------------------------------------------------------- |
| `transaction` | `string` | On Evm requires a hexadeciaml string, on Solana, requires a base58 string |
| `transaction` | `string` | On Evm requires a hexadecimal string, on Solana, requires a base58 string |

```typeScript
const txHash = await evm.sendTransaction(transaction);
Expand All @@ -382,7 +382,7 @@ To request an EIP712 signature from a user's embedded wallet, you can use either

| Field | Type | Description |
| --------- | -------- | ---------------------------------------------- |
| `message` | `string` | Requires a hexadeciaml string or a json string |
| `message` | `string` | Requires a hexadecimal string or a json string |

```typeScript
const signature = await evm.signTypedData(typedData);
Expand Down
6 changes: 3 additions & 3 deletions api-reference/auth/mobile-sdks/unity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You'll also need to configure your Podfile if you haven't already. If you don't
<p>Copy our example Podfile</p>
<p></p>
<p>
You can copy our examole
You can copy our example
[Podfile](https://github.com/Particle-Network/particle-unity/blob/main/ios-build/Podfile),
it will always use the latest version.
</p>
Expand Down Expand Up @@ -294,7 +294,7 @@ List<SupportLoginType> allSupportLoginTypes =
await ParticleAuthCore.Instance.Connect(LoginType.EMAIL, null, SupportAuthType.ALL, SocialLoginPrompt.SelectAccount, loginConfig);
```

You can also costumize login page for email/phone, send code with method `ParticleAuthCore.Instance.SendPhoneCode` or `ParticleAuthCore.Instance.SendEmailCode`, connect with method `ParticleAuthCore.Instance.ConnectWithCode`
You can also customize login page for email/phone, send code with method `ParticleAuthCore.Instance.SendPhoneCode` or `ParticleAuthCore.Instance.SendEmailCode`, connect with method `ParticleAuthCore.Instance.ConnectWithCode`

<CodeGroup>

Expand Down Expand Up @@ -513,7 +513,7 @@ var result = (string)JObject.Parse(rpcResult)["result"];
| `gasFeeLevel` | `GasFeeLevel` | (Optional) the gas fee level, `High`, `Medium` or `Low`, default is `High`. |

```csharp
var transaction = await EvmService.CreateTransaction(from, data, value, reciver);
var transaction = await EvmService.CreateTransaction(from, data, value, receiver);
```

### Estimate Gas
Expand Down
2 changes: 1 addition & 1 deletion api-reference/connect/desktop/web.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ import { injected as solaInjected, solanaWalletConnectors } from '@particle-netw
import { wallet, EntryPosition } from '@particle-network/connectkit/wallet';
import React from 'react';

//Retrived from https://dashboard.particle.network
//Retrieved from https://dashboard.particle.network
const projectId = process.env.NEXT_PUBLIC_PROJECT_ID as string;
const clientKey = process.env.NEXT_PUBLIC_CLIENT_KEY as string;
const appId = process.env.NEXT_PUBLIC_APP_ID as string;
Expand Down
6 changes: 3 additions & 3 deletions api-reference/connect/mobile/android.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Initialization can be started through the `init` method on `ParticleConnect` (fr

| Field | Type | Description |
| :------------- | :------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| application | Application | Android applicaiton |
| application | Application | Android application |
| env | Env | DEV, STAGING, PRODUCTION. Different levels log different information |
| chain | ChainInfo | The primary chain to be used within your application. `ChainInfo` can be set as a `ChainInfo` object imported from `network.particle.chains.ChainInfo.Companion.{chain}`. For example, `ChainInfo.Ethereum` or `ChainInfo.Solana`. |
| dAppData | DAppMetadata | Metadata outlining the description of your application, used for `WalletConnect`. This should be set as an instance of `DAppMetadata` (imported from `com.particle.base.model.DAppMetadata`) with the following parameters set:<br />- `name`, the name of your project. <br />- `icon`, a link containing the logo (icon) of your project; this should be 512x512, ideally.<br />- `url`, the URL of your project's website. <br />- `description`, a short description of your project. |
Expand Down Expand Up @@ -299,7 +299,7 @@ For `EVMConnectAdapter` and `SolanaConnectAdapter`, calling `connect` will gener

| Field | Type | Description |
| :------- | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `config` | `ConnectConifg?` | The `ConnectConfig` will only be effective when `adapter.name` is MobileWCWalletName.AuthCore.name`. You can construct a valid object using the subclass `ParticleAuthCoreConfig`. You can pass `null` when `adapter.walletType` is another value. |
| `config` | `ConnectConfig?` | The `ConnectConfig` will only be effective when `adapter.name` is MobileWCWalletName.AuthCore.name`. You can construct a valid object using the subclass `ParticleAuthCoreConfig`. You can pass `null` when `adapter.walletType` is another value. |

`ConnectConfig` ` There are 4 already implemented subclasses that can correspond to different connection scenarios

Expand Down Expand Up @@ -493,7 +493,7 @@ E.g.:
```kotlin Kotlin
connectAdapter.signTypedData(address, data, callback)
```
### (Optional) Custom WalletConnect Projcet ID
### (Optional) Custom WalletConnect Project ID
```kotlin Kotlin
//call before ParticleConnect.init
ParticleNetwork.setWalletConnectProjectId("Your WalletConnect Project ID, from https://cloud.walletconnect.com")
Expand Down
4 changes: 2 additions & 2 deletions api-reference/connect/mobile/flutter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ This must happen before the other methods become functional. First, call `Partic
| -------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `chainInfo` | `ChainInfo` |The primary blockchain and network (e.g., testnet) your application will use. For instance, you might choose `.Ethereum` or `.EthereumSepolia`, depending on the specific network required for your use case. |
| `dAppData` | `DAppMetadata` | Metadata outlining the description of your application; this should be an instance of `DAppMetadata` with the following parameters: `name`, the name of your project. `icon`, a URL linking to the icon of your project; this should be 512x512, ideally. `url`, the URL of your project's website. `description`, the description of your project, `redirect`, optional, redirect universal link of you project, `verifyUrl`, optional. |
| `env` | `Env` | The specific environmennt to be used. This can be either `.dev`, `.staging`, or `.production`. |
| `env` | `Env` | The specific environment to be used. This can be either `.dev`, `.staging`, or `.production`. |
| `rpcUrlConfig` | `RpcUrlConfig?` | Customize the RPC URL. |

```dart
Expand Down Expand Up @@ -442,7 +442,7 @@ final account = await ParticleConnect.importMnemonic(WalletType.evmPrivateKey, m
// Exportation
String privateKey = await ParticleConnect.exportPrivateKey(WalletType.evmPrivateKey, publicAddress);
```
### (Optional) Custom WalletConnect Projcet ID
### (Optional) Custom WalletConnect Project ID
```dart
// Call before ParticleConnect.init
ParticleConnect.setWalletConnectProjectId("Your WalletConnect Project ID, from https://cloud.walletconnect.com")
Expand Down
Loading