Skip to content

Commit

Permalink
Update to README for OnchainProvider use (#9)
Browse files Browse the repository at this point in the history
Update to README
  • Loading branch information
shovon authored Dec 17, 2024
1 parent 2d2a47c commit 905756c
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,47 @@
## Features

Currently available:
* Read onchain data using the [GoldRush API](https://goldrush.dev/)

- Read onchain data using the [GoldRush API](https://goldrush.dev/)

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

- Access offchain and private data
- Train and fine-tune Large/Small Language Models
- Identity services to securely store your agent's private keys
- Communication services to post to social media
- Memory Bank to provide a trustless, verifiable persistent store for critical states, outputs and decisions

## Using the SDK

### 1. Setup and installation

> yarn install
or
or

> npm install
### 2. Initialization

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

new Agent({
onchain: {
key: "XXX",
provider: GoldRushAPI
}
})

provider: OnchainProvider.GoldRushAPI,
},
});
```

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

```js
const balances = agent.onchain.getTokenBalancesForWalletAddress(BaseChain, "demo.eth");
const balances = agent.onchain.getTokenBalancesForWalletAddress(
BaseChain,
"demo.eth",
);
```

## 🤝 Contributing
Expand Down

0 comments on commit 905756c

Please sign in to comment.