Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Simplify Quick Start #34

Merged
merged 3 commits into from
May 10, 2024
Merged

Simplify Quick Start #34

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a73b798
Simplify quick start
ProfMoo May 10, 2024
d2946b6
Updated step 3
ProfMoo May 10, 2024
127aab0
Remove 'below' link
ProfMoo May 10, 2024
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
15 changes: 6 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,19 @@ A traditional infrastructure-heavy staking integration can take months. Coinbase
Prerequisite: [Node 20+](https://www.npmjs.com/package/node/v/20.11.1)

1. In a fresh directory, run:

```shell
npm install @coinbase/staking-client-library-ts
```

2. Install necessary Typescript dependencies:
```shell
npm install -g ts-node typescript
```
2. Copy and paste a code sample from below or any other [example](./examples/) into an `example.ts` file.

3. Create a new API Key in the [portal](https://portal.cdp.coinbase.com/access/api) and paste the API Key name and private key into the example.

3. Get your API keys info such as api key name and api private key from here: https://portal.cdp.coinbase.com/access/api. <br>
These will be used in order to set up our client later in the example code. <br>
For detailed instructions refer to our api key setup guide [here](https://docs.cdp.coinbase.com/developer-platform/docs/cdp-keys).
4. Run :rocket:

4. Copy and paste one of the code samples below or any of our [provided examples](./examples/) into an `example.ts` file and run it with `ts-node` :rocket:
```shell
ts-node example.ts
npx ts-node example.ts
```

### Stake Partial ETH :diamond_shape_with_a_dot_inside:
Expand Down
Loading