Skip to content

Commit

Permalink
docs(agent): clarify introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
egasimus committed Oct 18, 2023
1 parent 9594870 commit ef0a0f6
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions spec/Agent.spec.ts.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit ef0a0f6

Please sign in to comment.