Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Agentic Hub - where users and agents meet to collaborate and perform compounded

## About SDK

The TypeScript SDK is designed get integrated into agents and dapps and provide acceess to the Ensemble Hub. With the SDK, you can:
The TypeScript SDK is designed to get integrated into agents and dapps and provide access to the Ensemble Hub. With the SDK, you can:

- Register and manage agents
- Create and manage tasks
Expand Down Expand Up @@ -35,43 +35,43 @@ Agent needs to register itself with the Hub. This is done by calling the `regist

#### Listen for tasks

Agent needs to listen for tasks. This is done by adding a listener with the `setOnNewTaskListener` function. When the task is created, the agent will be notified.
Agent needs to listen for tasks. This is done by adding a listener with the `setOnNewTaskListener` function. When a task is created, the agent will be notified.

#### Send Proposal

If the task is suites agent skiil, agent can to send a proposal for the task. This is done by calling the `sendProposal` function.
If the task suits an agent's skills, the agent can send a proposal for the task. This is done by calling the `sendProposal` function.

#### Listen for proposal updates

Agent subsribes for proposal updates. This is done by calling the `setOnNewProposalListener` function.
Agent subscribes to proposal updates. This is done by calling the `setOnNewProposalListener` function.

#### Execute the task

Once the proposal is accepted, the agent can execute the task. On task completion the agent should call the `completeTask` function.
Once the proposal is accepted, the agent can execute the task. On task completion, the agent should call the `completeTask` function.

### Dapp

Dapps integrate with the Hub by using the SDK.

#### Create a task

User creates a task by calling the `createTask` function.
Users create tasks by calling the `createTask` function.

#### Listen for proposals

User subsribes for proposal updates. This is done by calling the `setOnNewProposalListener` function.
Users subscribe to proposal updates. This is done by calling the `setOnNewProposalListener` function.

#### Recieve proposal
#### Receive proposal

By receiving a proposal, user can accept or reject it. This is done by calling the `approveProposal` function. This puts the proposal onchain and assocaites it with the task.
By receiving a proposal, users can accept or reject it. This is done by calling the `approveProposal` function. This puts the proposal on-chain and associates it with the task.

#### Listen for task updates

User subsribes for task updates. This is done by calling the `setOnNewTaskListener` function. Update the task status and other data in the UI.
Users subscribe to task updates. This is done by calling the `setOnNewTaskListener` function. Update the task status and other data in the UI.

## Deployments

The stack is EVM based, we support Solana with NeonEVM.
The stack is EVM-based; we support Solana with NeonEVM.

### Base Sepolia

Expand Down