Sunosuporno/bmx (#371)

* add BMX plugin * Make some formatting/linting changes * Fix version and add README * Add changeset --------- Co-authored-by: Agustin Armellini Fischer <[email protected]>
goat-sdk · Mar 3, 2025 · 54ac028 · 54ac028
1 parent 70e80b9
commit 54ac028
Show file tree

Hide file tree

Showing 15 changed files with 4,584 additions and 0 deletions.
diff --git a/typescript/.changeset/rotten-dancers-unite.md b/typescript/.changeset/rotten-dancers-unite.md
@@ -0,0 +1,5 @@
+---
+"@goat-sdk/plugin-bmx": patch
+---
+
+Release package
diff --git a/typescript/packages/plugins/bmx/README.md b/typescript/packages/plugins/bmx/README.md
@@ -0,0 +1,45 @@
+<div align="center">
+<a href="https://github.com/goat-sdk/goat">
+
+<img src="https://github.com/user-attachments/assets/5fc7f121-259c-492c-8bca-f15fe7eb830c" alt="GOAT" width="100px" height="auto" style="object-fit: contain;">
+</a>
+</div>
+
+# BMX GOAT Plugin
+
+Get token information from [BMX](https://www.bmx.trade/)
+
+## Installation
+```bash
+npm install @goat-sdk/plugin-bmx
+yarn add @goat-sdk/plugin-bmx
+pnpm add @goat-sdk/plugin-bmx
+```
+
+## Usage
+
+```typescript
+import { bmx } from "@goat-sdk/plugin-bmx";
+
+const tools = await getOnChainTools({
+    wallet: // ...
+    plugins: [
+       bmx()
+    ]
+});
+```
+
+## Tools
+- Open positions
+- Closed positions
+- Get position details
+
+<footer>
+<br/>
+<br/>
+<div>
+<a href="https://github.com/goat-sdk/goat">
+  <img src="https://github.com/user-attachments/assets/4821833e-52e5-4126-a2a1-59e9fa9bebd7" alt="GOAT" width="100%" height="auto" style="object-fit: contain; max-width: 800px;">
+</a>
+</div>
+</footer>
diff --git a/typescript/packages/plugins/bmx/package.json b/typescript/packages/plugins/bmx/package.json
@@ -0,0 +1,34 @@
+{
+    "name": "@goat-sdk/plugin-bmx",
+    "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:*",
+        "viem": "catalog:",
+        "zod": "catalog:"
+    },
+    "peerDependencies": {
+        "@goat-sdk/core": "workspace:*",
+        "viem": "catalog:"
+    },
+    "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", "defi"]
+}