Skip to content

Commit

Permalink
Add Superfluid Plugin (#156)
Browse files Browse the repository at this point in the history
* adding changes to superfluid plugin

* add superfluid to workspace

* add superfluid service and plugin

* remove wrapper and add readme

* rmove abis

* add first release superfluid plugin

* add superfluid plugin

---------

Co-authored-by: Agus <[email protected]>
  • Loading branch information
youssefea and 0xaguspunk authored Jan 2, 2025
1 parent 7bd8743 commit 1db621d
Show file tree
Hide file tree
Showing 13 changed files with 1,625 additions and 4 deletions.
4 changes: 4 additions & 0 deletions goat.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@
"name": "[Plugin] ⛽️ opensea",
"path": "./typescript/packages/plugins/opensea"
},
{
"name": "[Plugin] 💰 superfluid",
"path": "./typescript/packages/plugins/superfluid"
},
{
"name": "[Plugin] 🌍 zerodev-global-address",
"path": "./typescript/packages/plugins/zerodev-global-address"
Expand Down
5 changes: 5 additions & 0 deletions typescript/.changeset/rotten-apes-watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@goat-sdk/plugin-superfluid": patch
---

First release of the Superfluid Protocol Plugin
44 changes: 44 additions & 0 deletions typescript/packages/plugins/superfluid/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Goat Superfluid Plugin 🐐 - TypeScript

[Superfluid Protocol](https://docs.superfluid.finance/) plugin for Goat. Allows you to create tools for interacting with the Superfluid Protocol.

## Installation
```
npm install @goat-sdk/plugin-superfluid
```

## Setup

```typescript
import { superfluid } from "@goat-sdk/plugin-superfluid";

const plugin = superfluid({
});
```

## Available Actions

### Create or Update or Delete Flow
Creates, updates, or deletes a flow of tokens from sender to receiver.

### Get Flow Rate
Fetches the current flow rate of a token from sender to receiver.

### Get Units
Fetches the current units of a member in a pool.

### Update Member Units
Updates the units of a member in a pool.

### Get Total Flow Rate
Fetches the total flow rate of a pool of a pool.

## Goat

<div align="center">
Go out and eat some grass.

[Docs](https://ohmygoat.dev) | [Examples](https://github.com/goat-sdk/goat/tree/main/typescript/examples) | [Discord](https://discord.gg/goat-sdk)</div>

## Goat 🐐
Goat 🐐 (Great Onchain Agent Toolkit) is an open-source library enabling AI agents to interact with blockchain protocols and smart contracts via their own wallets.
32 changes: 32 additions & 0 deletions typescript/packages/plugins/superfluid/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "@goat-sdk/plugin-superfluid",
"version": "0.1.0",
"files": ["dist/**/*", "README.md", "package.json"],
"scripts": {
"build": "tsup",
"clean": "rm -rf dist",
"test": "vitest run --passWithNoTests"
},
"sideEffects": false,
"main": "./dist/index.js",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"dependencies": {
"@goat-sdk/core": "workspace:*",
"@goat-sdk/wallet-evm": "workspace:*",
"zod": "catalog:"
},
"peerDependencies": {
"@goat-sdk/core": "workspace:*"
},
"homepage": "https://ohmygoat.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/goat-sdk/goat.git"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/goat-sdk/goat/issues"
},
"keywords": ["ai", "agents", "web3"]
}
Loading

0 comments on commit 1db621d

Please sign in to comment.