Skip to content

Commit

Permalink
rmv rc and beta references
Browse files Browse the repository at this point in the history
  • Loading branch information
nateReiners committed May 21, 2024
1 parent 2790b35 commit 0f4472b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
/node_modules
/docs/dist
/docs/dist
8 changes: 7 additions & 1 deletion docs/pages/guides/update-existing-app.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# Update an existing project

## Wagmi
If your project is using wagmi, simply upgrade wagmi to version `2.9.0` or higher. Smart Wallet is available out of the box.

## Transitive dependency
If your project or its dependencies are already using
Coinbase Wallet SDK, just add the following to `package.json`.
```json
"resolutions": {
"@coinbase/wallet-sdk": "npm:@coinbase/wallet-sdk@4.0.0-beta.12"
"@coinbase/wallet-sdk": "npm:@coinbase/wallet-sdk@4.0.0"
}
```
After doing so, remember to run `install` with your package manager, e.g. `pnpm install`.
Then, rebuild your project, and when you click to connect Coinbase Wallet, you will see a new
popup window with a Smart Wallet option.

:::info
Note, if you are having trouble and are using `yarn` or `npm`, you may need to use [force resolutions](https://www.npmjs.com/package/npm-force-resolutions).
We recommend using [pnpm](https://pnpm.io/) or [bun](https://bun.sh/), when possible.
Expand Down
51 changes: 11 additions & 40 deletions docs/pages/sdk/install.mdx
Original file line number Diff line number Diff line change
@@ -1,61 +1,32 @@
# Install

Smart Wallet is accessible to developers through the [Coinbase Wallet SDK](https://github.com/coinbase/coinbase-wallet-sdk), versions `4.0` and later.
Today, there are release candidate versions (labeled `-rc.XX`) and beta versions (labeled `-beta.XX`).

:::warning
**IMPORTANT**

Smart Wallet is not yet publicly launched on mainnet networks. Read about the current SDK versions below
and reach out on [Discord](https://discord.com/invite/cdp/) in the `#smart-wallet` channel if you have questions.

Public mainnet launch is expected to occur by early June.
:::

### Release Candidate
:::code-group

```bash [npm]
npm i @coinbase/wallet-sdk@4.0.0-rc.1
npm i @coinbase/wallet-sdk@4.0.0
```

```bash [pnpm]
pnpm i @coinbase/wallet-sdk@4.0.0-rc.1
pnpm i @coinbase/wallet-sdk@4.0.0
```

```bash [yarn]
yarn add @coinbase/wallet-sdk@4.0.0-rc.1
yarn add @coinbase/wallet-sdk@4.0.0
```

```bash [bun]
bun i @coinbase/wallet-sdk@4.0.0-rc.1
bun i @coinbase/wallet-sdk@4.0.0
```
:::

- Intended for production environments.
- Allows developers to see Smart Wallet option on `keys.coinbase.com` popup when app running on `localhost`.
- Before public mainnet launch, will *not* show Smart Wallet option on `keys.coinbase.com` popup when app *not* running on `localhost`.
- Allows using Smart Wallet on mainnet networks.

### Beta
:::code-group

```bash [npm]
npm i @coinbase/wallet-sdk@4.0.0-beta.12
```

```bash [pnpm]
pnpm i @coinbase/wallet-sdk@4.0.0-beta.12
```
:::warning
**IMPORTANT**

```bash [yarn]
yarn add @coinbase/wallet-sdk@4.0.0-beta.12
```

```bash [bun]
bun i @coinbase/wallet-sdk@4.0.0-beta.12
```
:::
- Intended for local testing or demo testnet apps.
- Based on [config](/sdk/setup), can show Smart Wallet option on `keys.coinbase.com` popup, `localhost` or not.
- Only allows using Smart Wallet on testnets (currently just Base Sepolia).
Smart Wallet is not yet publicly launched on mainnet networks. Read about the current SDK versions below
and reach out on [Discord](https://discord.com/invite/cdp/) in the `#smart-wallet` channel if you have questions.

Public mainnet launch is expected to occur by early June.
:::

0 comments on commit 0f4472b

Please sign in to comment.