Skip to content

Commit 905756c

Browse files
authored
Update to README for OnchainProvider use (#9)
Update to README
1 parent 2d2a47c commit 905756c

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

+17-13
Original file line numberDiff line numberDiff line change
@@ -17,43 +17,47 @@
1717
## Features
1818

1919
Currently available:
20-
* Read onchain data using the [GoldRush API](https://goldrush.dev/)
20+
21+
- Read onchain data using the [GoldRush API](https://goldrush.dev/)
2122

2223
Roadmap:
23-
* Access offchain and private data
24-
* Train and fine-tune Large/Small Language Models
25-
* Identity services to securely store your agent's private keys
26-
* Communication services to post to social media
27-
* Memory Bank to provide a trustless, verifiable persistent store for critical states, outputs and decisions
24+
25+
- Access offchain and private data
26+
- Train and fine-tune Large/Small Language Models
27+
- Identity services to securely store your agent's private keys
28+
- Communication services to post to social media
29+
- Memory Bank to provide a trustless, verifiable persistent store for critical states, outputs and decisions
2830

2931
## Using the SDK
3032

3133
### 1. Setup and installation
3234

3335
> yarn install
3436
35-
or
37+
or
3638

3739
> npm install
3840
3941
### 2. Initialization
4042

4143
```js
42-
import { Agent, BaseChain, GoldRushAPI } from "@covalenthq/ai-agent-sdk";
44+
import { Agent, BaseChain, OnchainProvider } from "@covalenthq/ai-agent-sdk";
4345

4446
new Agent({
4547
onchain: {
4648
key: "XXX",
47-
provider: GoldRushAPI
48-
}
49-
})
50-
49+
provider: OnchainProvider.GoldRushAPI,
50+
},
51+
});
5152
```
5253

5354
### 3. Retrieve Token Balances for Wallet on Base Chain
5455

5556
```js
56-
const balances = agent.onchain.getTokenBalancesForWalletAddress(BaseChain, "demo.eth");
57+
const balances = agent.onchain.getTokenBalancesForWalletAddress(
58+
BaseChain,
59+
"demo.eth",
60+
);
5761
```
5862

5963
## 🤝 Contributing

0 commit comments

Comments
 (0)