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
24 changes: 12 additions & 12 deletions docs/01-getting-started/02-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The Enjin Platform is your central hub for managing blockchain projects, collect

### Steps to Create an Account:

1. Navigate to the Enjin Platform: https://platform.beta.enjin.io/
1. Navigate to the Enjin Platform: https://platform.enjin.io/
2. Click on the "Create an account" button.
3. Fill in your account credentials and click on the "Register" button.
4. Verify your email address by clicking the link sent to your inbox.
Expand All @@ -42,7 +42,7 @@ Every on-chain action you initiate through the Platform — creating a collectio

### Steps to Set Up:

1. On the [Account Settings](https://platform.beta.enjin.io/settings) page, click **Create API Token** and copy the new token somewhere safe.
1. On the [Account Settings](https://platform.enjin.io/settings) page, click **Create API Token** and copy the new token somewhere safe.
2. Follow the [Wallet Daemon Setup guide](/01-getting-started/06-using-wallet-daemon.md) to download, configure, and run the daemon. It will use the API token from step 1 to know which Platform account to sign for.

Once the daemon is running and connected, every transaction you submit from this Platform account is signed automatically.
Expand Down Expand Up @@ -80,18 +80,18 @@ You can interact with the Enjin Platform and initiate blockchain requests in sev
:::

1. **Create Collection:**
- In the Platform menu, navigate to **[Collections](https://platform.beta.enjin.io/collections)** and click the "**Create Collection**" button.
- In the Platform menu, navigate to **[Collections](https://platform.enjin.io/collections)** and click the "**Create Collection**" button.
- Customize your collection — you can specify its Mint Policy, Royalties, Explicit Royalty Currencies, and Attributes.
To learn more about collection configuration, see the [Create Collections guide](/02-guides/01-platform/01-managing-tokens/01-creating-collections.md).
- Click **Create** to submit. The Wallet Daemon signs and broadcasts the transaction automatically — watch it move from `PENDING` → `BROADCAST` → `FINALIZED` on the [Transactions page](https://platform.beta.enjin.io/transactions).
- Once finalized, the new collection appears on the [Collections page](https://platform.beta.enjin.io/collections) with its assigned `id`. Keep that id handy for the next step.
- Click **Create** to submit. The Wallet Daemon signs and broadcasts the transaction automatically — watch it move from `PENDING` → `BROADCAST` → `FINALIZED` on the [Transactions page](https://platform.enjin.io/transactions).
- Once finalized, the new collection appears on the [Collections page](https://platform.enjin.io/collections) with its assigned `id`. Keep that id handy for the next step.
![A collection with the collection ID next to it](/img/getting-started/v3-collection-card.png)
2. **Create Token:**
- Open the [Collections page](https://platform.beta.enjin.io/collections), click the collection you just created, then click the "**Create Token**" button at the top of the collection's page.
- Open the [Collections page](https://platform.enjin.io/collections), click the collection you just created, then click the "**Create Token**" button at the top of the collection's page.
- Customize your token — Token ID, initial supply, cap, royalty behavior, and attributes.
To learn more about token configuration, see the [Create Tokens guide](/02-guides/01-platform/01-managing-tokens/02-creating-tokens/02-creating-tokens.md).
- In the **Recipient** input field, paste the <GlossaryTerm id="address" /> of the wallet that should receive the token's initial supply. To send the supply to your own daemon's wallet, copy its address from the [Settings page](https://platform.beta.enjin.io/settings).
- Click **Create** to submit. The Wallet Daemon signs and broadcasts the transaction automatically; track it on the [Transactions page](https://platform.beta.enjin.io/transactions).
- In the **Recipient** input field, paste the <GlossaryTerm id="address" /> of the wallet that should receive the token's initial supply. To send the supply to your own daemon's wallet, copy its address from the [Settings page](https://platform.enjin.io/settings).
- Click **Create** to submit. The Wallet Daemon signs and broadcasts the transaction automatically; track it on the [Transactions page](https://platform.enjin.io/transactions).

:::tip Programmatic Creation
You can also create collections and tokens using the API or SDKs.
Expand Down Expand Up @@ -136,7 +136,7 @@ This is a core interaction — transferring an NFT from your project's wallet (o

Sending a token uses the same `CreateTransaction` mutation as the rest of the Platform, with the `transferToken` field set on the `transaction` input. You'll need the recipient's address, the collection id, the token id, and the amount.

Run the following from the [Enjin Platform GraphiQL Playground](https://platform.beta.enjin.io/graphiql) — or from your own GraphQL client (in which case add `Authorization: Bearer <YOUR_API_TOKEN>` to your request headers):
Run the following from the [Enjin Platform GraphiQL Playground](https://platform.enjin.io/graphiql) — or from your own GraphQL client (in which case add `Authorization: Bearer <YOUR_API_TOKEN>` to your request headers):

```graphql
mutation TransferToken {
Expand All @@ -159,7 +159,7 @@ mutation TransferToken {
}
```

The Wallet Daemon signs and broadcasts automatically. The response includes the transaction's `uuid` — use it to poll status with `GetTransaction(network: CANARY, chain: MATRIX, uuid: "<returned-uuid>")` or watch the row on the [Transactions page](https://platform.beta.enjin.io/transactions).
The Wallet Daemon signs and broadcasts automatically. The response includes the transaction's `uuid` — use it to poll status with `GetTransaction(network: CANARY, chain: MATRIX, uuid: "<returned-uuid>")` or watch the row on the [Transactions page](https://platform.enjin.io/transactions).

Once finalized, the transfer event is emitted with the recipient and amount — see [Working with Events](/05-enjin-platform/03-working-with-events.md) for how to read it.

Expand All @@ -179,7 +179,7 @@ Once you know a user's wallet address, you'll often need to check which tokens t

### Implementation (GraphQL Example):

Use the `GetAccount` query to read an address's holdings. Run this from the [GraphiQL Playground](https://platform.beta.enjin.io/graphiql) or your own GraphQL client:
Use the `GetAccount` query to read an address's holdings. Run this from the [GraphiQL Playground](https://platform.enjin.io/graphiql) or your own GraphQL client:

```graphql
query FetchingWalletTokens {
Expand Down Expand Up @@ -220,7 +220,7 @@ Congratulations! You've covered the basics of setting up your project on the Enj

:::warning **Ready for Production?**
Remember, this guide used the **Canary testnet** for development and testing. When you are ready to launch your application live, you will need to:
1. Switch the network selector to **Enjin (mainnet)** in the [Enjin Platform Cloud](https://platform.beta.enjin.io/).
1. Switch the network selector to **Enjin (mainnet)** in the [Enjin Platform Cloud](https://platform.enjin.io/).
2. Update your application's API calls or SDKs to target [**mainnet**](/01-getting-started/05-using-enjin-api/05-using-enjin-api.md#selecting-a-network-and-chain) by passing `network: ENJIN` on each query and mutation.
:::

Expand Down
32 changes: 16 additions & 16 deletions docs/01-getting-started/04-using-the-enjin-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can obtain cENJ (Canary ENJ) for testing from the [built-in Canary faucet](#

## 1. Set Up an <GlossaryTerm id="enjin_platform" /> Account

To get started, go ahead and create an account on the [Enjin Platform Cloud](https://platform.beta.enjin.io/) and **verify your email address.**
To get started, go ahead and create an account on the [Enjin Platform Cloud](https://platform.enjin.io/) and **verify your email address.**

The Enjin Platform is chain-agnostic — a single dashboard covers both networks. Use the **network selector in the top-right corner** of the platform UI to switch between **Canary** (testnet) and **Enjin** (mainnet). We recommend starting on Canary while you build and test.

Expand All @@ -26,7 +26,7 @@ The Enjin Platform is chain-agnostic — a single dashboard covers both networks

## 2. Set Up an API Token

Once your account is created, create a new API token by clicking the "**Create API Token**" button on the [Account Settings](https://platform.beta.enjin.io/settings) page.
Once your account is created, create a new API token by clicking the "**Create API Token**" button on the [Account Settings](https://platform.enjin.io/settings) page.
Copy and save that token somewhere safe — you'll need it to configure your <GlossaryTerm id="wallet_daemon" /> and to authenticate API requests.

:::tip Note
Expand Down Expand Up @@ -83,7 +83,7 @@ However, if you need to make a Platform request programmatically, you can do tha

### Option A. Using the Enjin Dashboard

In the Platform menu, navigate to "**[Collections](https://platform.beta.enjin.io/collections)**" and click the "**Create Collection**" button.
In the Platform menu, navigate to "**[Collections](https://platform.enjin.io/collections)**" and click the "**Create Collection**" button.

![Create collection form on Enjin Platform](/img/getting-started/v3-create-collection-form.png)

Expand Down Expand Up @@ -111,7 +111,7 @@ On any transaction form — whether a guided flow or the transaction builder —

The popup gives you everything needed to reproduce the request programmatically:

- **URL** — the GraphQL endpoint the request is sent to (`https://platform.beta.enjin.io/graphql`).
- **URL** — the GraphQL endpoint the request is sent to (`https://platform.enjin.io/graphql`).
- **Request** — the GraphQL mutation, including its variable definitions.
- **Variables** — the JSON variable values for this specific transaction.

Expand All @@ -135,7 +135,7 @@ For a step-by-step walkthrough of the endpoint, authentication, and the `network
:::

:::tip Test your requests in the GraphiQL Playground
[Open the Enjin Platform GraphiQL Playground](https://platform.beta.enjin.io/graphiql)
[Open the Enjin Platform GraphiQL Playground](https://platform.enjin.io/graphiql)
:::

:::tip Authentication
Expand Down Expand Up @@ -169,15 +169,15 @@ mutation CreateCollection {
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl --location 'https://platform.beta.enjin.io/graphql' \
curl --location 'https://platform.enjin.io/graphql' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-d '{"query":"mutation { CreateTransaction(network: CANARY, chain: MATRIX, transaction: { createCollection: { forceCollapsingSupply: false } }) { uuid action state } }"}'
```
</TabItem>
<TabItem value="js" label="Javascript">
```javascript
fetch('https://platform.beta.enjin.io/graphql', {
fetch('https://platform.enjin.io/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand Down Expand Up @@ -212,7 +212,7 @@ fetch('https://platform.beta.enjin.io/graphql', {
```javascript
const axios = require('axios');

axios.post('https://platform.beta.enjin.io/graphql', {
axios.post('https://platform.enjin.io/graphql', {
query: `
mutation CreateCollection($forceCollapsingSupply: Boolean) {
CreateTransaction(
Expand Down Expand Up @@ -264,7 +264,7 @@ mutation CreateCollection($forceCollapsingSupply: Boolean) {
variables = {'forceCollapsingSupply': False}

response = requests.post(
'https://platform.beta.enjin.io/graphql',
'https://platform.enjin.io/graphql',
json={'query': query, 'variables': variables},
headers={
'Content-Type': 'application/json',
Expand All @@ -290,7 +290,7 @@ A couple of dashboard patterns are worth knowing before you start managing exist

The dashboard does not have a top-level **Tokens** page. Tokens are always viewed inside the collection they belong to:

1. In the Platform menu, navigate to "**[Collections](https://platform.beta.enjin.io/collections)**".
1. In the Platform menu, navigate to "**[Collections](https://platform.enjin.io/collections)**".
2. Click the collection that contains the token you want to manage.
3. The collection page lists every token in the collection. Click the **3 vertical dots** (**⋮**) on a token's row to open its action menu — **Mint**, **Transfer**, **Attributes**, **Burn**, **Freeze / Thaw**, and so on.

Expand All @@ -308,7 +308,7 @@ When you're ready to submit, open the **Batch Queue** panel from the bottom-righ

![Batch Queue panel with two queued actions and the Submit Batch button](/img/getting-started/v3-batch-queue.png)

A successful submit produces a single transaction `uuid` on the [Transactions](https://platform.beta.enjin.io/transactions) page — the same shape any other transaction uses, just with multiple actions packed into it.
A successful submit produces a single transaction `uuid` on the [Transactions](https://platform.enjin.io/transactions) page — the same shape any other transaction uses, just with multiple actions packed into it.

:::tip Programmatic equivalent
The API equivalent of the Batch Queue is the `CreateBatchTransaction` mutation — it takes a `transactions: [TransactionInput!]!` list where each entry is one of the same discriminator inputs you'd pass to `CreateTransaction`.
Expand All @@ -325,7 +325,7 @@ For real-time, push-based notifications, see [WebSocket Events](/03-api-referenc

### Receive Transaction Information Using the Platform User Interface

To check the transaction status, head over to the [Transactions](https://platform.beta.enjin.io/transactions) page. Each row shows the transaction's `UUID`, `Action` (e.g. `MultiTokens.create_collection`), `State`, and `Extrinsic Hash` once it has been broadcast.
To check the transaction status, head over to the [Transactions](https://platform.enjin.io/transactions) page. Each row shows the transaction's `UUID`, `Action` (e.g. `MultiTokens.create_collection`), `State`, and `Extrinsic Hash` once it has been broadcast.

![Transactions page showing a finalized create_collection transaction](/img/getting-started/v3-transactions-page.png)

Expand Down Expand Up @@ -366,15 +366,15 @@ query GetTransactionStatus($uuid: String!) {
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl --location 'https://platform.beta.enjin.io/graphql' \
curl --location 'https://platform.enjin.io/graphql' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-d '{"query":"query { GetTransaction(network: CANARY, chain: MATRIX, uuid: \"12f22f91-82df-4b60-a90c-bf72b508a17c\") { uuid action state extrinsicHash } }"}'
```
</TabItem>
<TabItem value="js" label="Javascript">
```javascript
fetch('https://platform.beta.enjin.io/graphql', {
fetch('https://platform.enjin.io/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand Down Expand Up @@ -402,7 +402,7 @@ fetch('https://platform.beta.enjin.io/graphql', {
```javascript
const axios = require('axios');

axios.post('https://platform.beta.enjin.io/graphql', {
axios.post('https://platform.enjin.io/graphql', {
query: `
query GetTransactionStatus($uuid: String!) {
GetTransaction(network: CANARY, chain: MATRIX, uuid: $uuid) {
Expand Down Expand Up @@ -442,7 +442,7 @@ query GetTransactionStatus($uuid: String!) {
variables = {'uuid': '12f22f91-82df-4b60-a90c-bf72b508a17c'}

response = requests.post(
'https://platform.beta.enjin.io/graphql',
'https://platform.enjin.io/graphql',
json={'query': query, 'variables': variables},
headers={
'Content-Type': 'application/json',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In GraphQL:
- `Queries` are used to retrieve data, similar to a `GET` request in REST.
- `Mutations` are used to create or modify data, similar to `POST`, `PUT`, or `DELETE` requests in REST.

Here's how the same RESTful request would look in GraphQL, sent as an HTTP POST request to the Enjin Platform GraphQL endpoint at `https://platform.beta.enjin.io/graphql`:
Here's how the same RESTful request would look in GraphQL, sent as an HTTP POST request to the Enjin Platform GraphQL endpoint at `https://platform.enjin.io/graphql`:

```graphql
mutation MintToken {
Expand Down Expand Up @@ -96,7 +96,7 @@ The <GlossaryTerm id="graphiql_playground" /> serves three purposes:

### Step 1: Open the GraphiQL Playground

Open the [Enjin Platform GraphiQL Playground](https://platform.beta.enjin.io/graphiql) in your browser. The Enjin API now serves all queries and mutations from a single endpoint, so there is one playground covering Core operations, Marketplace, Fuel Tanks, and Nomination Pools.
Open the [Enjin Platform GraphiQL Playground](https://platform.enjin.io/graphiql) in your browser. The Enjin API now serves all queries and mutations from a single endpoint, so there is one playground covering Core operations, Marketplace, Fuel Tanks, and Nomination Pools.

:::info GraphiQL Playground:
The link above opens a graphical interface for exploring and testing operations directly from a web browser. To execute GraphQL requests programmatically from your application, send POST requests to the actual GraphQL endpoint instead — see [Using the Enjin API](/01-getting-started/05-using-enjin-api/05-using-enjin-api.md#graphql-endpoint).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ API tokens are used to authenticate your application's requests to the Enjin Pla

To make authenticated calls to the Enjin Platform:

1. Log in to the [Enjin Platform Cloud](https://platform.beta.enjin.io/).
2. Open your [account settings](https://platform.beta.enjin.io/settings) and create an API token if you haven't already.
1. Log in to the [Enjin Platform Cloud](https://platform.enjin.io/).
2. Open your [account settings](https://platform.enjin.io/settings) and create an API token if you haven't already.
3. Include the token in the `Authorization` header of your HTTP requests, prefixed with `Bearer`:

```
Expand All @@ -60,7 +60,7 @@ For developers looking for a more integrated experience, Enjin also provides off
The Enjin Platform serves all queries and mutations from a **single GraphQL endpoint**:

:::note GraphQL Endpoint
`https://platform.beta.enjin.io/graphql`
`https://platform.enjin.io/graphql`
:::

A single endpoint covers Core operations (collections, tokens, transfers, attributes), Marketplace, Fuel Tanks, and Nomination Pools.
Expand Down Expand Up @@ -97,7 +97,7 @@ To run the same query on the Canary testnet, change `network: ENJIN` to `network
Here is an example of an HTTP cURL request to fetch an account's balance from the Canary Matrixchain, with an API token provided:

```bash
curl --location --request POST 'https://platform.beta.enjin.io/graphql' \
curl --location --request POST 'https://platform.enjin.io/graphql' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-d '{"query":"query { GetAccount(network: CANARY, chain: MATRIX, address: \"efQh8FzLm6oH3dmTU3HWqGrtm6Xcuu1WG33N2Ka9fzo5MFFAr\") { balance } }"}'
Expand Down
Loading
Loading