Skip to content

Commit

Permalink
Merge pull request #6 from 0xsequence/solutionMigration
Browse files Browse the repository at this point in the history
Fixed routing for build
  • Loading branch information
JamesLawton authored Mar 8, 2024
2 parents e499b09 + a97d322 commit 07b9703
Show file tree
Hide file tree
Showing 41 changed files with 303 additions and 167 deletions.
Binary file modified .DS_Store
Binary file not shown.
Binary file modified docs/pages/.DS_Store
Binary file not shown.
File renamed without changes.
3 changes: 0 additions & 3 deletions docs/pages/indexer.mdx

This file was deleted.

85 changes: 85 additions & 0 deletions docs/pages/solutions/builder/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: Getting-started
hide_title: true
slug: /builder/getting-started
---

# Get Started
Signing up and creating a project is easy to do with Sequence Builder and should take you less than a minute. In this tutorial, we will help you sign up for Builder and then create your first project.

Let's get started!


## Sign up for Builder

### Step 1: Go to sequence.build

Go to [Sequence.Build](https://sequence.build/) and click on the `Start Building` button to get started.


![Sequence builder landing page](/img/builder/builder_landing_page_signup_project.png)


### Step 2: Choose a sign in method

When you first sign in to Builder, a wallet is created for you.

You may, however, already have a Sequence wallet. If you are signed in with that wallet, you will see an option to use it. This is a great way to get started.

Without a wallet, you will be given a few options to sign in. You can use any of the social sign ins, or you can simply use your email to get started.


![Sequence builder choose signin](/img/builder/builder_choose_signin_signup_project.png)


### Step 3: Sign in to sequence.build

After choosing how you would like to sign in, you will be presented with the terms of use. To read the `Terms of Use`, `Privacy Policy`, and `Master Services Agreement`, click on the respective links for each.


![Sequence builder accept terms](/img/builder/builder_accept_terms_signup_project.png)


Once you have read each, click through to continue.

You are now signed in to Builder!



## Create a Project

Everything you do in Builder is centered around each project - so let's start one.

The easiest way to start a project is to simply click `+ Create Project`.


![Sequence builder dashboard](/img/builder/builder_dashboard_signup_project.png)


### Step 1: Enter the project details

A modal will pop up, allowing you to enter details about your project. Provide a project name and, if you like, add an avatar for the project.

Select the network(s) on which you would like to start deploying. This can always be changed later.


![Sequence builder enter details](/img/builder/builder_enter_details_signup_project.png)


### Step 2: Create the project!

Now hit the `Create new Project` button!


![Sequence builder project created](/img/builder/builder_project_created_signup_project.png)


Once you finish, you should now be viewing your project dashboard.



## Build things!

Now that you have created a project, there is so much you can do from here! You can start exploring from your dashboard or feel free to follow along on one of these guides.

TODO: Card list
3 changes: 0 additions & 3 deletions docs/pages/solutions/builder/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
---
slug: /builder/overview
---

# Sequence Builder

Expand Down
8 changes: 1 addition & 7 deletions docs/pages/solutions/builder/project-management.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
---
title: Project Management
hide_title: true
slug: /builder/project-management
---

# Project Management
Creation of projects is seamless in just several clicks. This process requires no KYC, only that users comply with Global [regulations and policies](https://support.sequence.xyz/en/article/sequence-list-of-restricted-regions-1eked2s/), and an agreement to the platforms' terms of service.

##### Project Name
Choose a `project name` - something playful, serious, or just something unique to distinguish your new project amongst the other projects linked to your wallet.

##### Avatar
Upload a custom `avatar` to your project that displays aspects of your identity you want to be included as part of your project, or, something specific to the theme of what you're building. [You can always update your collaborators](/builder/settings#watch-how-to-invite-collaborators) and coordinate across the internet so Avatars can be a stepping stone to trust.
Upload a custom `avatar` to your project that displays aspects of your identity you want to be included as part of your project, or, something specific to the theme of what you're building. [You can always update your collaborators](/solutions/builder/project-settings#watch-how-to-invite-collaborators) and coordinate across the internet so Avatars can be a stepping stone to trust.

##### Configure networks
Configure 1 or multiple `networks` for a single project from the 11 offered production / mainnet networks, or, 8 test networks, with a simple flip of a toggle. At any point, the networks for your project chosen can be updated in the settings.
Expand Down
117 changes: 56 additions & 61 deletions docs/pages/solutions/builder/project-settings.mdx

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions docs/pages/solutions/builder/stub.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
slug: /guides/deploy-an-item-collection-contract
---

# How to Deploy an Item Collection Contract

This guide walks through how to setup and deploy a contract on Builder. If you haven't yet done so, make sure you have [signed up for Builder and created a Project](/solutions/builder/getting-started).


## Step 1: Go to the Contracts section

In the project dashboard, find the `Contracts` tab on the left side.

#### Add a new contract

Once you have that open, click the `+ New contract` button

![Sequence builder new contract](/img/builder/builder_create_new_contract_for_contract_deploy.png)

## Step 2: Choose a contract for your item collection

#### Select a contract

You have a couple of different options to load your item collection with.

We provide a few standard contracts to choose from, including an ERC1155, an ERC721, and an ERC20.

If you plan to use one of our standard contracts, skip ahead to **Step 3: Deploy your smart contract**

![Sequence builder select contract](/img/builder/builder_select_contract_for_contract_deploy.png)

#### Bring your own smart contract

You can also click the `+ View more contracts` button, which will open up a modal showing more standard contracts.

At the bottom of this modal, click the `+ Upload Source` button to deploy your own contract.

![Sequence builder more contracts](/img/builder/builder_more_contracts_for_contract_deploy.png)

## Step 3: Deploy your smart contract

#### Select/confirm the network

You may have already selected the network you want to deploy this contract too, so confirm that this is the right network.

#### Provide a contract name and symbol

Give your smart contract a name. If your contract is an ERC20 or ERC721, then you will need to give it a token symbol as well.

:::note
Providing a token symbol at deployment is not necessary for ERC1155 as there will be several different tokens associated with this contract - token symbols are determined when a new token is created at minting.
:::

#### Determine a contract owner

Provide a wallet address for the contract owner. (This will likely be yourself)

![Sequence builder contract details](/img/builder/builder_provide_contract_details_for_contract_deploy.png)

## Step 4: Sign the transaction

In order to complete the deployment of a smart contract, the contract deploy (that's you) will need to sign a transaction on the network that its being deployed to.

You will use your Sequence wallet to sign the transaction.

#### Sequence wallet

A Sequence wallet should have been created when you signed up for builder. You can confirm this by looking in the top right corner of then window anytime when you are in builder.

If you do not see this, then you need to signup and create a wallet.

![Sequence builder see wallet](/img/builder/builder_see_wallet_for_contract_deploy.png)

#### Signature modal

After you click the `Deploy Contract` button, a modal will pop up - which is your sequence wallet. In your wallet you will see a request to sign a transaction. It will include transaction details along with network fee estimations.

:::warning
It costs a fee (called gas) to deploy on a network. Make sure you have some of the native network tokens in your wallet ahead of time to cover it.
:::

Once you've read the transaction details, execute the transaction by hitting `confirm` on the signature.

![Sequence builder sign transaction](/img/builder/builder_sign_transaction_for_contract_deploy.png)

## Step 5: Collectible contract deployed

After you sign the transaction, the network will take a few seconds (maybe minutes depending on the network and other factors) to confirm your transaction.

When the transaction is complete, the contract will be deployed.

#### Linked contract in dashboard

Now that your smart contract is deployed, return to the `Contracts` section of Builder. There you should see your newly deployed contract. You should also be able to see what kind of contract it is, along with any roles you have - like `owner` for example.

![Sequence builder confirm deployment](/img/builder/builder_confirm_deployment_for_contract_deploy.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /guides/mint-items-from-ERC1155
slug: /solutions/collectibles/contracts/mint-items-from-ERC1155
---

# How to Mint In-Game Items and Achievements in Builder
Expand All @@ -20,9 +20,9 @@ Lets dive in!

### Prerequisite: Create a Project and deploy a Smart Contract

This guide assumes that you have already [signed up for Builder and created a Project](/guides/signup-and-create-a-project).
This guide assumes that you have already [signed up for Builder and created a Project](/solutions/builder/getting-started).

Before you get started creating (minting) items, you will need to first deploy the smart contract you wish to mint from. If you have not done so already, go back and do [how to load an item collection through deploying a smart contract](/guides/deploy-an-item-collection-contract).
Before you get started creating (minting) collectibles, you will need to first deploy the smart contract you wish to mint from. If you have not done so already, go back and do [how to load an item collection through deploying a smart contract](/solutions/collectibles/contracts/200-deploy-an-item-collection-contract).

## Step 1: Select the Collection for your item

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /guides/mint-collectibles-from-ERC721
slug: /solutions/collectibles/contracts/mint-collectibles-from-ERC721
---

# How to Mint Digital Collectibles in Builder
Expand All @@ -8,7 +8,7 @@ slug: /guides/mint-collectibles-from-ERC721

This guide walks you through creating in-game assets by minting from an ERC-721 contract, commonly known as NFTs (Non-Fungible Tokens), often used for collectibles.

For more on creating in-game items from collections, [check our guide on using ERC-1155](/guides/mint-items-from-ERC1155).
For more on creating in-game items from collections, [check our guide on using ERC-1155](/solutions/collectibles/contracts/900-mint-items-from-ERC1155).

#### ERC-721 vs. ERC-1155

Expand All @@ -26,9 +26,9 @@ Let's get started!

### Prerequisite: Create a Project and deploy a Smart Contract

This guide assumes that you have already [signed up for Builder and created a Project](/guides/signup-and-create-a-project).
This guide assumes that you have already [signed up for Builder and created a Project](/solutions/builder/getting-started).

Before you get started creating (minting) collectibles, you will need to first deploy the smart contract you wish to mint from. If you have not done so already, go back and do [how to load an item collection through deploying a smart contract](/guides/deploy-an-item-collection-contract).
Before you get started creating (minting) collectibles, you will need to first deploy the smart contract you wish to mint from. If you have not done so already, go back and do [how to load an item collection through deploying a smart contract](/solutions/collectibles/contracts/200-deploy-an-item-collection-contract).

## Step 1: Select the contract for your digital collectibles

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /guides/mint-currency-from-ERC20
slug: /solutions/collectibles/contracts/mint-currency-from-ERC20
---

# How to Mint in-game Currency in Builder
Expand All @@ -25,9 +25,9 @@ Non-fungible tokens (like ERC-721 tokens) represent unique items with individual

### Prerequisite: Create a Project and deploy a Smart Contract

This guide assumes that you have already [signed up for Builder and created a Project](/guides/signup-and-create-a-project).
This guide assumes that you have already [signed up for Builder and created a Project](/solutions/builder/getting-started).

Before you get started creating (minting) currency, you will need to first deploy the smart contract you wish to mint from. If you have not done so already, go back and do [how to load an item collection through deploying a smart contract](/guides/deploy-an-item-collection-contract).
Before you get started creating (minting) currency, you will need to first deploy the smart contract you wish to mint from. If you have not done so already, go back and do [how to load an item collection through deploying a smart contract](/solutions/collectibles/contracts/200-deploy-an-item-collection-contract).

## Step 1: Select the contract for your currency

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /guides/manage-contract-metadata-builder
slug: /solutions/collectibles/contracts/manage-contract-metadata-builder
---

# How to Manage Item Metadata in Sequence Builder
Expand Down Expand Up @@ -31,32 +31,32 @@ Head over to [Pinata.cloud](https://www.pinata.cloud/) and create an account. Up
}
```

![Configure Pinata](/img/guides/manage-contract-metadata-builder/1.jpeg)
![Configure Pinata](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/1.jpeg)

## Step 3: Upload Your Metadata Files
Now, gather all your JSON metadata files into a single folder on your computer. Use Pinata's 'Upload \> Folder' feature to upload this folder. Then, copy the CID for the entire folder.

![Upload Metadata](/img/guides/manage-contract-metadata-builder/2.jpeg)
![Upload Metadata](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/2.jpeg)

## Step 4: Get the Folder URL
Click on name of the folder you created on Pinata. This will open a new tab showing all your uploaded JSON files. Copy the URL of this folder.

![Get Folder URL from Pinata](/img/guides/manage-contract-metadata-builder/3.jpeg)
![Get Folder URL from Pinata](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/3.jpeg)

## Step 5: Set Up on Sequence Builder
Navigate to [Sequence Builder](https://sequence.build/), set up your account, and create your project on the network of your choice. In the Contracts section, click on "Deploy New Contract".

![Configure Contract on Builder](/img/guides/manage-contract-metadata-builder/4.jpeg)
![Configure Contract on Builder](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/4.jpeg)

## Step 6: Deploy Your Contract
Select "Web3 Game Item Collection (ERC-1155)" and name your contract. Sequence Builder will automatically deploy your contract on-chain.

![Deploy Contract](/img/guides/manage-contract-metadata-builder/5.jpeg)
![Deploy Contract](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/5.jpeg)

## Step 7: Move to Contract Details
Once you sign the transaction, your contract is ready! Click on it to view the details screen.

![Contract Details](/img/guides/manage-contract-metadata-builder/6.jpeg)
![Contract Details](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/6.jpeg)

## Step 8: Update Contract Attributes
Navigate to the “Write Contract” section. This is where you can modify attributes of your freshly deployed ERC-1155 contract. Two methods are what you should focus on for now:
Expand All @@ -72,7 +72,7 @@ https://azure-wooden-lemur-911.mypinata.cloud/ipfs/QmW5gvYGWb98GsN8VjTRWu4pLn6jr

Click “Write” and you will be prompted to sign again. This will modify the contract on chain to set the metadata base. Essentially any token ID you provide will be appended to this URL, along with the `.json` suffix. So if you mint token ID 123, it will look for `tokenBaseURI + 123.json`.

![Base Metadata Setup](/img/guides/manage-contract-metadata-builder/7.jpeg)
![Base Metadata Setup](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/7.jpeg)

## Step 10: Minting Time
Finally, it's time to mint! Scroll up to `mint`, expand it, and fill in the details:
Expand All @@ -82,12 +82,12 @@ Finally, it's time to mint! Scroll up to `mint`, expand it, and fill in the deta
- `amount (uint256)`: The number of tokens to mint (usually 1).
- `data (bytes)`: Enter `0x00` for this simple process.

![Mint test](/img/guides/manage-contract-metadata-builder/8.jpeg)
![Mint test](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/8.jpeg)

## Step 11: Finalize and Admire
Click "Write" and sign the transaction. Congratulations, you've just minted a token! Head over to the "Tokens" section to see your minted tokens with their names and images.

![Finalize Minting](/img/guides/manage-contract-metadata-builder/9.jpeg)
![Finalize Minting](/img/solutions/collectibles/contracts/manage-contract-metadata-builder/9.jpeg)

## Step 12: Updating Metadata
If you make mistakes with the token metadata, you can always update it and then call the Sequence Metadata refresh endpoint to reload the specific tokens:
Expand All @@ -98,4 +98,4 @@ curl -X GET "https://metadata.sequence.app/tokens/mumbai/0xb392c99d9f8e3e0b248e5

This is in the format: `https://metadata.sequence.app/tokens/<chain-name>/<contract-address>/<token-id>/refresh`

Now that you are ready to mint, you might want to read about [how you can launch your own serverless endpoint for securely minting tokens](/relayer/mint-collectibles-serverless).
Now that you are ready to mint, you might want to read about [how you can launch your own serverless endpoint for securely minting tokens](/guides/templates/template-cloudflare-relayer).
2 changes: 1 addition & 1 deletion docs/pages/solutions/payments/onramps/01-fiat-on-ramps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Only providers that support the region the users are in will be displayed.

As a developer integrating the Sequence Wallet, you can choose which payment provider can be visible to users. You can also specify which token will be available to purchase via the on-ramp providers.

To learn more on how to configure the on-ramp options, see [Sequence Connect Options](/wallet/guides/connect-wallet#includedpaymentproviders).
To learn more on how to configure the on-ramp options, see [Sequence Connect Options](/solutions/wallets/universal-wallet/03-guides/01-connect-wallet#wallet-login-and-connect-options).
File renamed without changes.
Loading

0 comments on commit 07b9703

Please sign in to comment.