@circuitorg/agent-sdk 1.0.8 → 1.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,18 +15,18 @@ A TypeScript SDK for building automated agents to deploy on Circuit. Features a
|
|
|
15
15
|
## 🚀 Quick Start
|
|
16
16
|
### Install the SDK
|
|
17
17
|
```bash
|
|
18
|
-
npm install @circuitorg/
|
|
18
|
+
npm install @circuitorg/agent-sdk
|
|
19
19
|
# or
|
|
20
|
-
yarn add @circuitorg/
|
|
20
|
+
yarn add @circuitorg/agent-sdk
|
|
21
21
|
# or
|
|
22
|
-
bun add @circuitorg/
|
|
22
|
+
bun add @circuitorg/agent-sdk
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
### Sample SDK Usage
|
|
26
26
|
>**NOTE:** The fastest, and recommended, way to get started is to setup an agent via the circuit [CLI](https://github.com/circuitorg/agents-cli)'s 'circuit agent init' command. This will setup a sample agent directory with the necessary agent wireframe, and configure the cli to allow you for easy testing and deployment. You just simply need to add in your secret formula to the execution and stop functions.
|
|
27
27
|
|
|
28
28
|
```typescript
|
|
29
|
-
import { AgentSdk } from "@circuitorg/
|
|
29
|
+
import { AgentSdk } from "@circuitorg/agent-sdk";
|
|
30
30
|
|
|
31
31
|
// Initialize the sdk
|
|
32
32
|
const sdk = new AgentSdk({
|
|
@@ -89,7 +89,7 @@ await sdk.signAndSend({
|
|
|
89
89
|
### SDK Configuration
|
|
90
90
|
|
|
91
91
|
```typescript
|
|
92
|
-
import { Agent, AgentSdk, ExecutionFunctionContract, StopFunctionContract } from "@circuitorg/
|
|
92
|
+
import { Agent, AgentSdk, ExecutionFunctionContract, StopFunctionContract } from "@circuitorg/agent-sdk";
|
|
93
93
|
|
|
94
94
|
// Agent execution function using the new AgentSdk v1.0 API
|
|
95
95
|
const executionFunction: ExecutionFunctionContract = async (request) => {
|