Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
roushou committed Jun 20, 2024
1 parent bdedac9 commit 5cc9877
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Coinbase Developer Platform SDK

> [!WARNING]
> This library is under active development so things might change and break between releases.
This is a TypeScript SDK for the [Coinbase Developer Platform](https://docs.cdp.coinbase.com/).

## Features:

- Build Onchain
- Node RPC [ ]
- Onchain Data [✔️]
- Paymaster [ ]
- Mesh [ ]
- Faucet
- Payments
- Commerce [ ]
- Onramp [ ]
- Wallets
- Smart Wallet [ ]
- Coinbase Wallet [ ]
- Embedded Wallet [ ]
- Trade []

## Overview

```ts
// 1. Import modules
import { createClient, createRpcClient } from "@coinbase-platform/onchain";

// 2. Create an RPC client
const rpcClient = createRpcClient({
url: RPC_URL,
apiKey: "API_KEY",
});

// 3. Send request
const response = await rpcClient.request({
method: "cdp_listBalances",
parameters: [
{
address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789",
pageSize: 1,
},
],
});

// For convenience, you can also create a higher-level client
const client = createClient({
apiKey: '<API_KEY>',
});

// Send request
const balances = await client.listBalances([{
address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789",
pageSize: 1,
}]);
```

## Documentation

TODO

## License

[MIT](./LICENSE) License

0 comments on commit 5cc9877

Please sign in to comment.