@agent-shield/plugin-solana-agent-kit 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,78 @@
+# @agent-shield/plugin-solana-agent-kit
+
+AgentShield plugin for [Solana Agent Kit](https://github.com/sendaifun/solana-agent-kit) — routes agent DeFi actions through permission-guarded vaults with spending limits, token whitelists, and leverage controls.
+
+## Installation
+
+```bash
+npm install @agent-shield/plugin-solana-agent-kit @agent-shield/sdk
+```
+
+Peer dependencies: `solana-agent-kit >=2.0.0`, `@agent-shield/sdk >=0.1.0`, `@solana/web3.js >=1.90.0`, `@coral-xyz/anchor >=0.30.0`
+
+## Quick Start
+
+```typescript
+import { createAgentShieldPlugin } from "@agent-shield/plugin-solana-agent-kit";
+import { SolanaAgentKit } from "solana-agent-kit";
+import { PublicKey } from "@solana/web3.js";
+import { BN } from "@coral-xyz/anchor";
+
+const plugin = createAgentShieldPlugin({
+  vaultOwner: new PublicKey("..."),  // vault owner pubkey
+  vaultId: new BN(1),               // vault identifier
+});
+
+const agent = new SolanaAgentKit(wallet, rpcUrl, {
+  plugins: [plugin],
+});
+```
+
+## Tools
+
+The plugin registers 6 tools on the agent:
+
+### Trading
+
+| Tool | Description | Parameters |
+|------|-------------|------------|
+| `shield_swap` | Execute a token swap through Jupiter, routed through the AgentShield vault with policy enforcement | `inputMint`, `outputMint`, `amount`, `slippageBps` |
+| `shield_open_position` | Open a leveraged perpetual position on Flash Trade. Enforces leverage limits and position count caps | `collateralMint`, `targetMint`, `collateralAmount`, `side`, `leverage` |
+| `shield_close_position` | Close an existing perpetual position on Flash Trade | `positionMint`, `targetMint`, `side` |
+
+### Read-Only
+
+| Tool | Description | Parameters |
+|------|-------------|------------|
+| `shield_check_policy` | Read the vault policy: spending caps, allowed tokens/protocols, leverage limits, fee BPS | *(none)* |
+| `shield_check_balance` | Read vault balances, status, and statistics (total volume, open positions, fees collected) | *(none)* |
+| `shield_check_spending` | Read the rolling 24h spending tracker: per-token spend vs daily cap, recent transaction history | *(none)* |
+
+## Configuration
+
+```typescript
+interface AgentShieldPluginConfig {
+  /** Vault owner public key */
+  vaultOwner: PublicKey;
+  /** Vault identifier (u64) */
+  vaultId: BN;
+  /** Optional program ID override (defaults to mainnet deployment) */
+  programId?: PublicKey;
+}
+```
+
+The plugin creates an `AgentShieldClient` on initialization using the agent's connection and wallet. The client is cached per agent instance.
+
+## How It Works
+
+All trading tools (`shield_swap`, `shield_open_position`, `shield_close_position`) build atomic composed transactions:
+
+```
+[ValidateAndAuthorize, DeFi instruction(s), FinalizeSession]
+```
+
+The on-chain program checks the agent's action against the vault policy (spending cap, token whitelist, protocol whitelist, leverage limits) before the DeFi instruction executes. If any check fails, the entire transaction reverts.
+
+## License
+
+MIT

package/dist/tools/checkPolicy.js

@@ -32,7 +32,7 @@ async function checkPolicy(agent, config, input) {
         `Max Leverage: ${policy.maxLeverageBps} bps (${(policy.maxLeverageBps / 100).toFixed(1)}x)`,
         `Can Open Positions: ${policy.canOpenPositions}`,
         `Max Concurrent Positions: ${policy.maxConcurrentPositions}`,
-        `Fee: ${policy.feeBps} bps (${(policy.feeBps / 100).toFixed(2)}%)`,
+        `Developer Fee Rate: ${policy.developerFeeRate} (${(policy.developerFeeRate / 10000).toFixed(4)}%)`,
     ].join("\n");
 }
 //# sourceMappingURL=checkPolicy.js.map

package/dist/tools/checkPolicy.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkPolicy.js","sourceRoot":"","sources":["../../src/tools/checkPolicy.ts"],"names":[],"mappings":";;;AAcA,kCA8BC;AA5CD,6BAAwB;AACxB,6CAA4C;AAC5C,sDAAsD;AAGzC,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,YAAY,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,wEAAwE,CAAC;CACtF,CAAC,CAAC;AAII,KAAK,UAAU,WAAW,CAC/B,KAAU,EACV,MAA+B,EAC/B,KAAuB;IAEvB,MAAM,MAAM,GAAG,IAAA,kCAAiB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEhD,IAAI,QAAmB,CAAC;IACxB,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;QACvB,QAAQ,GAAG,IAAI,mBAAS,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAElD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;IACrF,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;IAE3F,OAAO;QACL,sBAAsB;QACtB,uBAAuB,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,WAAW;QACpE,yBAAyB,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW;QACxE,mBAAmB,SAAS,EAAE;QAC9B,sBAAsB,YAAY,EAAE;QACpC,iBAAiB,MAAM,CAAC,cAAc,SAAS,CAAC,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;QAC3F,uBAAuB,MAAM,CAAC,gBAAgB,EAAE;QAChD,6BAA6B,MAAM,CAAC,sBAAsB,EAAE;QAC5D,QAAQ,MAAM,CAAC,MAAM,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;KACnE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}
+{"version":3,"file":"checkPolicy.js","sourceRoot":"","sources":["../../src/tools/checkPolicy.ts"],"names":[],"mappings":";;;AAcA,kCA8BC;AA5CD,6BAAwB;AACxB,6CAA4C;AAC5C,sDAAsD;AAGzC,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,YAAY,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,wEAAwE,CAAC;CACtF,CAAC,CAAC;AAII,KAAK,UAAU,WAAW,CAC/B,KAAU,EACV,MAA+B,EAC/B,KAAuB;IAEvB,MAAM,MAAM,GAAG,IAAA,kCAAiB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAEhD,IAAI,QAAmB,CAAC;IACxB,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;QACvB,QAAQ,GAAG,IAAI,mBAAS,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAElD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;IACrF,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;IAE3F,OAAO;QACL,sBAAsB;QACtB,uBAAuB,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,WAAW;QACpE,yBAAyB,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW;QACxE,mBAAmB,SAAS,EAAE;QAC9B,sBAAsB,YAAY,EAAE;QACpC,iBAAiB,MAAM,CAAC,cAAc,SAAS,CAAC,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;QAC3F,uBAAuB,MAAM,CAAC,gBAAgB,EAAE;QAChD,6BAA6B,MAAM,CAAC,sBAAsB,EAAE;QAC5D,uBAAuB,MAAM,CAAC,gBAAgB,KAAK,CAAC,MAAM,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;KACpG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agent-shield/plugin-solana-agent-kit",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "AgentShield plugin for Solana Agent Kit — routes agent DeFi actions through permission-guarded vaults",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
     "prepublishOnly": "npm run build"
   },
   "files": [
-    "dist/**/*"
+    "dist/**/*",
+    "README.md"
   ],
   "peerDependencies": {
     "solana-agent-kit": ">=2.0.0",
@@ -21,7 +22,7 @@
   "devDependencies": {
     "typescript": "^5.3.0",
     "solana-agent-kit": "^2.0.0",
-    "@agent-shield/sdk": "0.1.0",
+    "@agent-shield/sdk": "0.1.2",
     "@solana/web3.js": "^1.95.0",
     "@coral-xyz/anchor": "^0.32.0",
     "zod": "^3.22.0"