From ef0a0f61b5a079846bde23e6783a9a308b68ada5 Mon Sep 17 00:00:00 2001 From: Adam Avramov Date: Wed, 18 Oct 2023 10:01:07 +0300 Subject: [PATCH] docs(agent): clarify introduction --- spec/Agent.spec.ts.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/spec/Agent.spec.ts.md b/spec/Agent.spec.ts.md index fa1a6d94f5f..067408c86ae 100644 --- a/spec/Agent.spec.ts.md +++ b/spec/Agent.spec.ts.md @@ -1,17 +1,21 @@ # Fadroma Agent: Scriptable User Agents for the Blockchain -The **Fadroma Agent API** is Fadroma's imperative API for interacting with smart contract -platforms. It's specified by the [**@fadroma/agent**](https://www.npmjs.com/package/@fadroma/agent) -package, and is in effect a reduced and simplified vocabulary that covers the common ground -between different implementations of smart contract-enabled chains. The Agent API is designed -to expressing smart contract operations in a concise and readable manner. +The *Fadroma Agent API* is Fadroma's imperative API for interacting with smart contract +platforms. It's designed for expressing smart contract operations in a concise and readable manner. -Since different chains provide different connection methods and client libraries, -the packages under [**@fadroma/connect**](https://www.npmjs.com/package/@fadroma/connect) -contain the concrete implementations of Fadroma Agent for the given platforms: +The API is specified by the [**@fadroma/agent**](https://www.npmjs.com/package/@fadroma/agent) +package. In effect, it's a reduced and simplified vocabulary that covers the common ground +between different implementations of smart contract-enabled chains. + +Since different chains provide different client libraries and connection methods, +the concrete implementations of the Fadroma Agent API are contained in separate +packages: * [**@fadroma/scrt**](https://www.npmjs.com/package/@fadroma/scrt) for Secret Network, * [**@fadroma/cw**](https://www.npmjs.com/package/@fadroma/cw) for other CosmWasm-enabled chains +* [**@fadroma/connect**](https://www.npmjs.com/package/@fadroma/connect) reexports all available + Fadroma Agent API implementations. It's recommended to use **@fadroma/connect** when depending + on more than one of the above. ## Connecting to a chain