Skip to content

Commit

Permalink
fix npm publish (#1000)
Browse files Browse the repository at this point in the history
* README for npm

* bump version

* sourcemap
  • Loading branch information
bangtoven authored Aug 31, 2023
1 parent 7bb019e commit 432f1a4
Show file tree
Hide file tree
Showing 6 changed files with 132 additions and 99 deletions.
97 changes: 1 addition & 96 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,97 +35,9 @@ yarn typecheck

> The installation package for **Coinbase Wallet SDK** (formerly WalletLink) is now named `@coinbase/wallet-sdk`.
- This readme contains brief instructions to get up and running.
- This [readme](/packages/wallet-sdk/README.md) contains brief instructions to get up and running.
- Visit our [public developer docs](https://docs.cloud.coinbase.com/wallet-sdk/docs) for more detail, including samples for integrating Coinbase Wallet using libraries like [web3-react](https://github.com/Uniswap/web3-react), [web3modal](https://github.com/Web3Modal/web3modal), [Web3-Onboard](https://docs.blocknative.com/onboard), and [wagmi](https://wagmi.sh/).

### Installing Wallet SDK

Install Coinbase Wallet SDK with yarn or npm.

#### Yarn

1. Check available versions of Wallet SDK.

```shell
yarn info @coinbase/wallet-sdk versions
```

2. Install a specific version or the latest version.

```shell
#yarn add @coinbase/[email protected]
yarn add @coinbase/wallet-sdk
```

3. Check your installed version.

```shell
yarn list @coinbase/wallet-sdk
```

#### Npm

1. Check available versions of Wallet SDK.

```shell
npm view @coinbase/wallet-sdk versions
```

2. Install a specific version or the latest version.

```shell
#npm install @coinbase/[email protected]
npm install @coinbase/wallet-sdk
```

3. Check your installed version.

```shell
npm list @coinbase/wallet-sdk
```

### Upgrading Wallet SDK

Upgrade Coinbase Wallet SDK with yarn or npm.

#### Yarn

1. Compare your installed version of Coinbase Wallet SDK with the latest available version.

```shell
yarn outdated @coinbase/wallet-sdk
```

2. Update Coinbase Wallet SDK to the latest.

```shell
yarn upgrade @coinbase/wallet-sdk --latest
```

#### Npm

1. Compare your installed version of Coinbase Wallet SDK with the latest available version.

```shell
npm outdated @coinbase/wallet-sdk
```

2. If necessary, update `package.json` with the latest major version.

```shell
{
"dependencies": {
"@coinbase/wallet-sdk": "^3.0.0"
}
}
```

3. Update Coinbase Wallet SDK to the latest available version.

```shell
npm update @coinbase/wallet-sdk
```

## Libraries using Coinbase Wallet SDK

- [blocknative/onboard](https://github.com/blocknative/onboard)
Expand All @@ -148,10 +60,3 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

## Attributions

- [eth-json-rpc-filters](https://github.com/MetaMask/eth-json-rpc-filters/blob/main/LICENSE) under the ISC license
- [@metamask/json-rpc-engine](https://github.com/MetaMask/json-rpc-engine/blob/main/LICENSE) under the ISC license
- [eth-rpc-errors](https://github.com/MetaMask/eth-rpc-errors/blob/main/LICENSE) under the MIT license
- [eth-block-tracker](https://github.com/MetaMask/eth-block-tracker/blob/master/LICENSE) under the MIT license
126 changes: 126 additions & 0 deletions packages/wallet-sdk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Coinbase Wallet SDK

Coinbase Wallet SDK lets developers connect their dapps to Coinbase Wallet
on both mobile web (for iOS and Android) and desktop:

- **Mobile**: Users can connect to your mobile web dapp through a deeplink to the dapp browser in [Coinbase Wallet Mobile App](https://coinbase-wallet.onelink.me/q5Sx/fdb9b250).

- **Desktop**: Users can connect to your desktop app with a QR code in the [Coinbase Wallet Mobile App](https://coinbase-wallet.onelink.me/q5Sx/fdb9b250) or with the [Coinbase Wallet Chrome Extension](https://coinbase-wallet.onelink.me/q5Sx/fdb9b250).

## Installing and Upgrading

> The installation package for **Coinbase Wallet SDK** (formerly WalletLink) is now named `@coinbase/wallet-sdk`.
- This readme contains brief instructions to get up and running.
- Visit our [public developer docs](https://docs.cloud.coinbase.com/wallet-sdk/docs) for more detail, including samples for integrating Coinbase Wallet using libraries like [web3-react](https://github.com/Uniswap/web3-react), [web3modal](https://github.com/Web3Modal/web3modal), [Web3-Onboard](https://docs.blocknative.com/onboard), and [wagmi](https://wagmi.sh/).

### Installing Wallet SDK

Install Coinbase Wallet SDK with yarn or npm.

#### Yarn

1. Check available versions of Wallet SDK.

```shell
yarn info @coinbase/wallet-sdk versions
```

2. Install a specific version or the latest version.

```shell
#yarn add @coinbase/[email protected]
yarn add @coinbase/wallet-sdk
```

3. Check your installed version.

```shell
yarn list @coinbase/wallet-sdk
```

#### Npm

1. Check available versions of Wallet SDK.

```shell
npm view @coinbase/wallet-sdk versions
```

2. Install a specific version or the latest version.

```shell
#npm install @coinbase/[email protected]
npm install @coinbase/wallet-sdk
```

3. Check your installed version.

```shell
npm list @coinbase/wallet-sdk
```

### Upgrading Wallet SDK

Upgrade Coinbase Wallet SDK with yarn or npm.

#### Yarn

1. Compare your installed version of Coinbase Wallet SDK with the latest available version.

```shell
yarn outdated @coinbase/wallet-sdk
```

2. Update Coinbase Wallet SDK to the latest.

```shell
yarn upgrade @coinbase/wallet-sdk --latest
```

#### Npm

1. Compare your installed version of Coinbase Wallet SDK with the latest available version.

```shell
npm outdated @coinbase/wallet-sdk
```

2. If necessary, update `package.json` with the latest major version.

```shell
{
"dependencies": {
"@coinbase/wallet-sdk": "^3.0.0"
}
}
```

3. Update Coinbase Wallet SDK to the latest available version.

```shell
npm update @coinbase/wallet-sdk
```

## Attributions

- [eth-json-rpc-filters](https://github.com/MetaMask/eth-json-rpc-filters/blob/main/LICENSE) under the ISC license
- [@metamask/json-rpc-engine](https://github.com/MetaMask/json-rpc-engine/blob/main/LICENSE) under the ISC license
- [eth-rpc-errors](https://github.com/MetaMask/eth-rpc-errors/blob/main/LICENSE) under the MIT license
- [eth-block-tracker](https://github.com/MetaMask/eth-block-tracker/blob/master/LICENSE) under the MIT license

```
Copyright © 2018-2023 Coinbase, Inc. <https://www.coinbase.com/>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
2 changes: 1 addition & 1 deletion packages/wallet-sdk/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@coinbase/wallet-sdk",
"version": "3.9.0-canary.0",
"version": "3.9.0-canary.2",
"description": "Coinbase Wallet JavaScript SDK",
"keywords": [
"cipher",
Expand Down
2 changes: 1 addition & 1 deletion packages/wallet-sdk/src/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const LIB_VERSION = '3.9.0-canary.0';
export const LIB_VERSION = '3.9.0-canary.2';
1 change: 1 addition & 0 deletions packages/wallet-sdk/tsconfig.build.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"target": "es2017",
"jsx": "react",
"jsxFactory": "h",
"sourceMap": false,
},
"include": ["src"],
"exclude": ["dist", "build", "**/*.test.*"]
Expand Down
3 changes: 2 additions & 1 deletion scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ if [ $branch == $mainBranch ]; then
echo "================================================="
echo -e "rm -rf ./node_modules"
rm -rf ./node_modules
rm -rf ./packages/wallet-sdk/node_modules
echo -e "rm -rf ./dist"
rm -rf ./dist
rm -rf ./packages/wallet-sdk/dist
echo -e "yarn install"
yarn install
echo -e "yarn workspace @coinbase/wallet-sdk build"
Expand Down

0 comments on commit 432f1a4

Please sign in to comment.