Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/01-getting-started/02-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Check the full in-depth guide: [Sending Tokens](/02-guides/01-platform/01-managi

### Why Read User Tokens?

Once a user has linked their wallet (as shown in Step 5), you'll often need to check which tokens they own within your collection(s). This allows you to:
Once a user has linked their wallet (as shown in [Step 4](#4-link-a-users-wallet-to-your-application)), you'll often need to check which tokens they own within your collection(s). This allows you to:

- Display their relevant inventory within your game or application interface (like in-game currency or an item).
- Verify ownership of specific NFTs to grant access, perks, or abilities.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ From here, you can customize your collection's Mint Policy, Market Policy, Expli
- **[Mint Policy](/03-api-reference/04-important-arguments.md#mintpolicy) -** The rules pertaining to token supply and number of tokens available to be minted in the future.
- **[Market Policy](/03-api-reference/04-important-arguments.md#marketpolicy) -** Determines the rules which tokens in this collection must follow when interacting with the on-chain marketplace.
- **[Explicit Royalty Currencies](/03-api-reference/04-important-arguments.md#explicitroyaltycurrencies) -** Choose which currencies are required to pay marketplace royalties for the tokens in this collection.
- **[Attributes](/03-api-reference/04-important-arguments.md#attributes) -** Set the collection details which are details stored in pairs, like a title and its content. Certain attributes, such as `name` and `description`, have special roles that are understood by many platforms, wallets and marketplaces.
- **[Attributes](/03-api-reference/04-important-arguments.md#attributes) -** Add details to your collection using key-value pairs. Standard keys like `name` and `description` allow applications to display your content correctly. You can also use the `URI` to link to a JSON file hosting your metadata. For more information, see the [Metadata Standard](/02-guides/01-platform/03-advanced-mechanics/02-metadata-standard/02-metadata-standard.md) page.

:::info Learn more about the arguments
For a comprehensive view and detail of all available arguments please refer to our [API Reference](/03-api-reference/03-api-reference.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ From here, you can customize your collection's Mint Policy, Market Policy, and A
- The **[Fixed](/03-api-reference/04-important-arguments.md#supply)** supply type offers a balanced approach between flexibility and control. This model allows the collection owner to mint new tokens as long as the circulating supply does not exceed the predetermined max supply. Burned tokens can be re-minted, ensuring the total supply remains constant.
- The **[Collapsing](/03-api-reference/04-important-arguments.md#collapsing_supply)** supply type is the most strict. This supply type allows the collection owner to mint new tokens as long as the circulating supply does not exceed the max supply. However, burning tokens reduces the max supply, meaning burned tokens cannot be re-minted. This ensures a non-increasing supply, suitable for use cases that require strict control over the token's total amount in circulation.
- **[Token Royalty Settings](/03-api-reference/04-important-arguments.md#hasroyalty) -** Configures royalties for each marketplace sale of this token.
- **[Attributes](/03-api-reference/04-important-arguments.md#attributes) -** Set the token details which are details stored in pairs, like a title and its content. Certain attributes, such as the `URI`, `name`, and `description`, have special roles that are understood by many platforms and marketplaces. If you're new, simply link to a JSON file that lists all the token's details. Make sure to check out the [Metadata Standard](/02-guides/01-platform/03-advanced-mechanics/02-metadata-standard/02-metadata-standard.md) page.
- **[Attributes](/03-api-reference/04-important-arguments.md#attributes) -** Add details to your token using key-value pairs. Standard keys like `name` and `description` allow applications to display your content correctly. You can also use the `URI` to link to a JSON file hosting your metadata. For more information, see the [Metadata Standard](/02-guides/01-platform/03-advanced-mechanics/02-metadata-standard/02-metadata-standard.md) page.

:::info Learn more about the arguments
For a comprehensive view and detail of all available arguments please refer to our [API Reference](/03-api-reference/03-api-reference.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -486,13 +486,14 @@ print(response.json())
</TabItem>
</Tabs>

:::info **Notes:**
- `amount` argument
- In the `TransferBalance` mutation, the `amount` argument is denoted in `u128`. This means that the number you specify is divided by 10^18 to determine the actual amount of ENJ to be transferred.
In the example above, an `amount` of `5000000000000000000` will actually send 5 ENJ. Keep this in mind when specifying the `amount` in your mutations.
- `keepAlive` argument
- Set to true if you want to make sure the account doesn't get reaped.
Learn more about keepAlive argument [here](/03-api-reference/04-important-arguments.md#keepalive)
:::info **Key Arguments**
- **Calculating the `amount`**
- The Platform accepts ENJ values in the **base unit** (integers), not decimal ENJ amounts. To calculate the correct input, **multiply your desired ENJ amount by 10^18** (1 quintillion).
- **Formula:** `Desired ENJ` \* `1,000,000,000,000,000,000`
- **Example:** To transfer **5 ENJ**, input `5000000000000000000`.
- **Using `keepAlive`**
- Set to `true` to prevent the account from being removed (reaped) if the balance drops below the minimum requirement.
- [Learn more about the keepAlive argument here](/03-api-reference/04-important-arguments.md#keepalive)
:::

### Batch Transferring ENJ token
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ import TabItem from '@theme/TabItem';
[WalletConnect](https://docs.walletconnect.com/) is an open-source protocol that connects your mobile wallet to decentralized applications.
Using the Platform API and WalletConnect you can send any transaction request directly to your user's wallet app.

:::danger **Maintenance Notice**
The `polkadot-onboard` sample repository used in this guide is **no longer maintained** and may not function as expected.

**Note:** WalletConnect itself remains fully functional and compatible with Enjin Blockchain. This guide is retained as a reference for the implementation logic for developers building their own integrations.

**Upcoming Feature:** A native solution is in development to enable direct transaction requests from the Enjin Platform to the Enjin Wallet, removing the need for third-party services.
:::

:::info What you'll need:
- Node.js 18+ and yarn installed
- A mobile device with [Enjin Wallet app](https://enjin.io/wallet) installed
Expand All @@ -21,7 +29,7 @@ You can obtain cENJ for testing from the [Canary faucet](https://faucet.canary.e

## Install and configure the sample project

On production apps, you will need [WalletConnect's SDK](https://docs.walletconnect.com/web3wallet/about), but for this guide we'll be using a sample project called [polkadot-onboard](https://github.com/enjin-forks/polkadot-onboard.git).
On production apps, you will need [WalletConnect's SDK](https://docs.walletconnect.com/web3wallet/about), but for this guide we'll be using the (now deprecated) sample project called [polkadot-onboard](https://github.com/enjin-forks/polkadot-onboard.git).

Start by cloning the polkadot-onboard repository: https://github.com/enjin-forks/polkadot-onboard.git

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -458,9 +458,10 @@ print(response.json())
}
```

:::info Balances Format
API balances fields are formatted as u128 number type.
to get decimal value, divide the value by 10^18.
:::info **Formatting Balances**
The API returns balance fields in the **base unit** (u128), meaning they appear as large integers without decimals. To obtain the readable ENJ amount, **divide the returned value by 10^18**.
- **Formula:** `Base Unit Value` / `1,000,000,000,000,000,000` = `ENJ Amount`
- **Example:** A value of `86010842630734264894` converts to approximately **86.01 ENJ**.
:::

**Response: If user has not verified**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,10 @@ print(response.json())
}
```

:::info Balances Format
API balances fields are formatted as u128 number type.
to get decimal value, divide the value by 10^18.
:::info **Formatting Balances**
The API returns balance fields in the **base unit** (u128), meaning they appear as large integers without decimals. To obtain the readable ENJ amount, **divide the returned value by 10^18**.
- **Formula:** `Base Unit Value` / `1,000,000,000,000,000,000` = `ENJ Amount`
- **Example:** A value of `86010842630734264894` converts to approximately **86.01 ENJ**.
:::

### Fetch a wallet's collections
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ By integrating ENJ Infusion, creators and developers can provide enhanced value
To create a token with Infused ENJ, proceed with the instructions on the [Creating Tokens](/02-guides/01-platform/01-managing-tokens/02-creating-tokens/02-creating-tokens.md) page, but make sure to specify the amount of ENJ to infuse into the token, in the “Infuse ENJ” section.
If you are using the `CreateToken` mutation, insert the infusion amount in the `params: infusion` parameter.

:::warning Important Note
The `infusion` argument is denoted in `u128`. This means that the number you specify is divided by 10^18 to determine the actual amount of ENJ to be infused.
e.g.: to infuse a token with 5 ENJ, the infusion argument should be set to `5000000000000000000`, which is `5*(10^18)`.
:::warning Calculating the infusion amount
The Platform accepts infusion values in the **base unit** (integers), not decimal ENJ amounts. To calculate the correct input, **multiply your desired ENJ amount by 10^18** (1 quintillion).
- **Formula:** `Desired ENJ infusion` \* `1,000,000,000,000,000,000`
- **Example:** To infuse a token with **5 ENJ**, input `5000000000000000000`.
:::

### Anyone Can Infuse
Expand All @@ -60,9 +61,10 @@ In the meantime, if you wish to adjust infusion permission of an existing token

To add ENJ infusion to a token that already exists, use the `Infuse` mutation:

:::warning Important Note
The `amount` argument is denoted in `u128`. This means that the number you specify is divided by 10^18 to determine the actual amount of ENJ to be infused.
e.g.: to infuse a token with 5 ENJ, the infusion argument should be set to `5000000000000000000`, which is `5*(10^18)`.
:::warning Calculating the infusion amount
The Platform accepts infusion values in the **base unit** (integers), not decimal ENJ amounts. To calculate the correct input, **multiply your desired ENJ amount by 10^18** (1 quintillion).
- **Formula:** `Desired ENJ infusion` \* `1,000,000,000,000,000,000`
- **Example:** To infuse a token with **5 ENJ**, input `5000000000000000000`.
:::

<Tabs>
Expand Down
7 changes: 4 additions & 3 deletions docs/03-api-reference/02-mutations/03-tokens-mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -995,9 +995,10 @@ mutation TransferAllBalance {

The Infuse mutation allows you to embed Enjin Coin (ENJ) into an existing token. This operation is crucial for enhancing the intrinsic value of digital assets, ensuring that they carry a guaranteed ENJ backing. By infusing ENJ, you provide tangible value to the token, which can only be retrieved through the process of "<GlossaryTerm id="melt" />ing" the token.

:::warning Important Note
The `amount` argument is denoted in `u128`. This means that the number you specify is divided by 10^18 to determine the actual amount of ENJ to be infused.
e.g.: to infuse a token with 5 ENJ, the infusion argument should be set to `5000000000000000000`, which is `5*(10^18)`.
:::warning Calculating the infusion amount
The Platform accepts infusion values in the **base unit** (integers), not decimal ENJ amounts. To calculate the correct input, **multiply your desired ENJ amount by 10^18** (1 quintillion).
- **Formula:** `Desired ENJ infusion` \* `1,000,000,000,000,000,000`
- **Example:** To infuse a token with **5 ENJ**, input `5000000000000000000`.
:::

<Tabs>
Expand Down