@circuitorg/agent-sdk 1.3.7 → 1.3.8

package/README.md

@@ -1,5 +1,9 @@
 # Circuit Agent SDK - TypeScript
 
+> NOTE: Please refer to our all in one [Circuit Documentation](https://app.gitbook.com/o/yfLOFAxdeW0k9oNMRvxo/s/JCFI1CxS0CCJGcFs2OVc/agent-developers/sdk-reference): 
+> We will be reducing this down to instructions for sdk developers and will refer agent developers to the public gitbooks.
+
+
 > **Clean, unified, type-safe TypeScript SDK for building cross-chain agents on Circuit**
 
 A simplified TypeScript SDK for building automated agents to deploy on Circuit. Agents receive a single `AgentContext` object containing everything they need - request data, SDK methods, and unified logging. No boilerplate, no return values to manage, just write your logic.
@@ -16,7 +20,7 @@ A simplified TypeScript SDK for building automated agents to deploy on Circuit.
       - [Required Asset setup](#required-asset-setup)
   - [🎯 Core Concepts](#-core-concepts)
     - [The AgentContext Object](#the-agentcontext-object)
-    - [Run/Stop Function Requirements](#runstop-function-requirements)
+    - [Run/Unwind Function Requirements](#rununwind-function-requirements)
   - [📝 Unified Logging with agent.log()](#-unified-logging-with-agentlog)
   - [💾 Session Memory Storage](#-session-memory-storage)
   - [🌉 Cross-Chain Swaps with Swidge](#-cross-chain-swaps-with-swidge)
@@ -113,16 +117,15 @@ async function run(agent: AgentContext): Promise<void> {
   // Circuit will provide updated positions on the next run
 }
 
-async function stop(agent: AgentContext): Promise<void> {
-  /**Cleanup when agent is stopped.*/
-  await agent.log("Cleaning up resources");
-  await agent.memory.delete("temp_data");
+async function unwind(agent: AgentContext, positions: CurrentPosition[]): Promise<void> {
+  /**Allocation adjustment / cleanup when agent is asked to unwind positions.*/
+  await agent.log(`Unwinding ${positions.length} positions`);
 }
 
-// Boilerplate - This should never change unless you want to change the names of your run and stop functions
+// Boilerplate - This should never change unless you want to change the names of your run and unwind functions
 const agent = new Agent({
   runFunction: run,
-  stopFunction: stop
+  unwindFunction: unwind
 });
 
 export default agent.getExport();
@@ -148,7 +151,7 @@ Every agent function receives a single `AgentContext` object that contains:
 - `agent.signMessage()` - Sign messages on EVM
 - `agent.transactions()` - Get transaction history with asset changes
 
-### Run/Stop Function Requirements
+### Run/Unwind Function Requirements
 
 1. **Signature**: `async function myFunction(agent: AgentContext): Promise<void>`
 2. **Return**: Always return `void` (or no return statement)
@@ -320,7 +323,7 @@ async function run(agent: AgentContext): Promise<void> {
 ### Redeem Positions
 
 ```typescript
-async function stop(agent: AgentContext): Promise<void> {
+async function unwind(agent: AgentContext): Promise<void> {
   /**Redeem all settled positions.*/
   const redemption = await agent.platforms.polymarket.redeemPositions();
 
@@ -583,9 +586,8 @@ async function run(agent: AgentContext): Promise<void> {
   // Your agent logic here
 }
 
-async function stop(agent: AgentContext): Promise<void> {
-  await agent.log("Cleaning up...");
-  // Optional cleanup logic
+async function unwind(agent: AgentContext, positions: CurrentPosition[]): Promise<void> {
+  await agent.log(`Cleaning up (unwind requested for ${positions.length} positions)...`);
 }
 
 // ============================================================================
@@ -593,7 +595,7 @@ async function stop(agent: AgentContext): Promise<void> {
 // ============================================================================
 const agent = new Agent({
   runFunction: run,
-  stopFunction: stop
+  unwindFunction: unwind
 });
 
 export default agent.getExport();