Skip to content

Commit

Permalink
Merge pull request #21 from 0xsequence/docs-day
Browse files Browse the repository at this point in the history
updated Readme, wallet updates, changelog addition
  • Loading branch information
JamesLawton authored Apr 9, 2024
2 parents 62df407 + 4db1de6 commit c6097d1
Show file tree
Hide file tree
Showing 19 changed files with 77 additions and 139 deletions.
Binary file added .DS_Store
Binary file not shown.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
IMPORTANT: please make sure you install "git lfs" in order to use this repository.

This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.

v2 docs of Sequence Stack
Binary file modified docs/.DS_Store
Binary file not shown.
3 changes: 0 additions & 3 deletions docs/pages/guides/discord.mdx

This file was deleted.

18 changes: 0 additions & 18 deletions docs/pages/sdk/typescript/01-overview.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,38 +1,18 @@
# Quickstart
## Install

## Try a Demo
:::info
Try out the Universal Wallet leveraging SequenceKit at our [demo](https://0xsequence.github.io/kit/)
:::


## Template
:::info
Get started quickly with a [template](https://github.com/0xsequence/kit/tree/master/examples/react) using SequenceKit
:::


## Install for existing project

We provide TypeScript and Unity SDKs for the Embedded Wallet authentication system. You can install the TypeScript SDK with:

```bash
pnpm install @0xsequence/waas
```

For more information on the Unity Embedded Wallet SDK, please refer to the [Unity SDK documentation](#TODO).

The sequence.js SDK is composed of several sub-packages combined into a single meta-package called `0xsequence`.
Sequence.js is a modular web3 stack and smart wallet package for Ethereum chains. You can think of it similar to ethers.js, but tailored to the Sequence stack which streamlines common functions needed for blockchain-enabled game development. The sequence.js SDK is composed of several sub-packages combined into a single meta-package called `0xsequence`.
To add the SDK to your project, add a dependency on 0xsequence to your package.json:

```sh
npm install 0xsequence ethers
```

or

```sh
pnpm install 0xsequence ethers
```

or

```sh
Expand All @@ -43,6 +23,7 @@ If you know that your project only requires specific sub-packages, you can also
`npm add @0xsequence/<sub-package name>`.

Your package.json should look something like this (actual version may vary):

```json
{
"name": "my-dapp",
Expand All @@ -63,3 +44,6 @@ Optionally, `0xsequence` can be installed as a JS script source (UMD distributio
<script src="https://cdn.ethers.io/lib/ethers-5.7.umd.min.js"></script>
<script src="https://unpkg.com/0xsequence@latest/dist/0xsequence.umd.min.js"></script>
```



23 changes: 0 additions & 23 deletions docs/pages/sdk/typescript/04-platforms.mdx

This file was deleted.

22 changes: 0 additions & 22 deletions docs/pages/sdk/typescript/05-fiat-on-ramps.mdx

This file was deleted.

32 changes: 0 additions & 32 deletions docs/pages/sdk/typescript/06-key-management.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/pages/solutions/builder/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { Card, CardGrid } from "../../../components/CardGrid";

[Builder](https://sequence.build/) is Sequence's all-inclusive tool for managing your projects, API keys, as well as contract and marketplace deployments. It also provides user access management so multiple people in your team can easily work on the same project. In addition to these powerful features, Builder also provides easy to use interfaces for managing sponsored wallets with your gas tank, and integration tools for SequenceKit, Node Gateway and Indexer.
[Builder](https://sequence.build/) is Sequence's all-inclusive, no-code tool for managing your projects, API keys, as well as contract and marketplace deployments. It also provides user access management so multiple people in your team can easily work on the same project. In addition to these powerful features, Builder also provides easy to use interfaces for managing sponsored wallets with your gas tank, and integration tools for SequenceKit, Node Gateway and Indexer.

To learn more about how to leverage the powerful features of the Builder, follow the guides below.

Expand Down
4 changes: 0 additions & 4 deletions docs/pages/solutions/builder/wallet-sdks.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
import Video from "../../../components/Video";

# Wallet SDKs in Builder

Sequence Builder offers multiple SDK options for integrating Sequence Wallet into your project.

### How can I integrate a Wallet into my game with these options?

In the Wallets SDK section of Builder, simply select **SequenceKit**, input wallet details, click 'save', and code snippets will be generated for you to use. The same can be done for **Web SDK** (watch the tutorial below for additional guidance). **Unity SDK** and **Unreal SDK** will help you integrate the same way, but by interacting their respective game engines. Note that both SDKs are receiving updates and will be available shortly.

### What are the differences between these options?

**Web SDK** and **SequenceKit** both deploy our Universal Wallet. They integrate differently, but offer the similar wallet benefits. However, **SequenceKit** is also a wallet connector, providing additional benefits.

**SequenceKit** is a powerful wallet connector, enabling existing wallet users across web3 to connect a wallet - vastly improving their user experience through embedded item views, integrated NFT checkout, and seamless wallet creation.
Expand All @@ -25,7 +22,6 @@ All integrations provide non-custodial smart contract wallets with account abstr
**Unity SDK** and **Unreal SDK** give you the advantages of integrating a Sequence Wallet directly into your game.

## Watch a Wallet integration using SequenceKit with Builder

<Video
videoPreviewSrc={"/img/builder/builder_sequence_kit_preview_video.png"}
videoSrc={"/video/builder/04_Sequence_Kit.mp4"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Check out our [demo](https://0xsequence-demos.github.io/aviator-custom-marketpla
## Template

:::info
Get started quickly with a [template](https://github.com/0xsequence-demos/aviator-custom-marketplace) leveraging our Orderbook API.
Get started quickly with a [template](https://github.com/0xsequence-demos/aviator-custom-marketplace) leveraging our Marketplace API.
:::

## Try an API Call
Expand Down
19 changes: 19 additions & 0 deletions docs/pages/solutions/marketplaces/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Marketplaces Overview

Sequence provides a variety of options for your marketplace and in-game store to accelerate your development, namely our **white-label marketplace** as well as our suite of **Marketplace APIs**.

### What are the differences between these options?
The **white-label marketplace** is ideal for getting started with a browser-based marketplace in literally minutes - all with no-coding experience and options to customize the marketplace to fit your branding such as fonts, colors, and logos. Our white-label marketplace is ideal if you want to minimize development time, focus on a web-based experience for your users, and start selling assets.

Conversely, our **Marketplace APIs** give you complete control & customization so you can build your own UI while leaving the complexity of blockchain & backend orchestration to us. Our APIs can be utilized in game engines such as Unity or Unreal to build an in-game marketplace or store. Alternatively, they can be leveraged via a web-based experience in the browser as well - the choice is yours.

You can even mix and match these options! For example, launching your own white-label marketplace for selling your initial game assets while building out your game. Then once launched, your in-game store uses the marketplace APIs to showcase these assets and offer new ones - while ensuring a seamless user experience as the user never needs to leave the game.

### Getting Started
To get started with the white-label marketplace, check out our [page](/solutions/marketplaces/white-label-marketplace) for more information and a helpful video to walk you through the process.

Additionally, our quickstart page for the [Marketplace APIs](/solutions/marketplaces/orderbook/02-quickstart) has a variety of templates, demos, and common integration patterns needed to get you started. We also provide a step by step guide of leveraging the APIs for (building a custom marketplace)[/guides/template-marketplace-api]




27 changes: 26 additions & 1 deletion docs/pages/solutions/wallets/overview.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
## Comparison of wallet offerings, guides, etc
# Sequence Wallets Overview

Sequence offers multiple wallet options to integrate into your products, chiefly we call these our **In-Game Wallet** and our **Universal Wallet** which are both completely non-custodial.

### What are the differences between these options?


The **In-Game Wallet** is primarily focused on delivering a traditional game experience that is headless with no mandatory pop-ups, modals, transaction signing, or other additional distractions take players out of them trying to enjoy the game. Users can login with common social logins or other authentication providers and simply jump into the experience. We provide native support for a variety of popular game engines such as Unreal and Unity as well as Typescript support so you can stay within your preferred framework for building games or experiences.

![Wallets](/img/wallets.png)

Conversely, our **Universal Wallet** is geared more towards native blockchain users with a focus on games and gaming assets. Existing blockchain users will feel right at home where you can leverage our wallet infrastructure for creating great experiences for web3 users, complete with a Typescript SDK for easy integration.

### What are the benefits of each and how can I leverage them?
All integrations provide non-custodial smart contract wallets with account abstraction advantages like optionality for gasless transactions. We recommend our **In-Game Wallet** if you are focused on a seamless, headless web2/2.5-like experience for your players or our **Universal Wallet** for prioritizing web2.5/web3 native users.

Best of all, our wallet connector called [SequenceKit](/sdk/sequence-kit/01-overview) integrates both options in a convenient, customizable UI written in Typescript, which you can leverage to cater to users with an existing wallet such as Metamask and millions of potential new users that want the convenience of social login.

### Getting Started
Please check out [Sequence Builder](https://sequence.build) to create a project and select Wallets to get started. This will provide the corresponding code snippets with our convenient SDKs to get started.

Alternatively, our quickstart page for [In-Game Wallets](/solutions/wallets/embedded-wallet/02-quickstart) and [Universal Wallets](/solutions/wallets/universal-wallet/02-quickstart) has all the templates, demos, and common integration patterns needed to accelerate your development.




2 changes: 0 additions & 2 deletions docs/pages/support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@ Sequence has a front line Support Team in multiple timezones to tackle problems

If one of the members of the team does not know the answer, we'll further investigate (with backup support from the Sequence dev team) to get to the bottom of your troubles.

![Sequence Support](/img/sequence_support.png)

[Start talking to support today](https://go.crisp.chat/chat/embed/?website_id=9ef4395b-6bb1-4645-8e02-6071d89290a1)
3 changes: 3 additions & 0 deletions docs/public/.DS_Store
Git LFS file not shown
4 changes: 2 additions & 2 deletions docs/public/img/.DS_Store
Git LFS file not shown
3 changes: 3 additions & 0 deletions docs/public/img/wallets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c6097d1

Please sign in to comment.