(feat) A plugin for the Zilliqa blockchain

Author: rrw-zilliqa

.env.example

@@ -357,6 +357,10 @@ MORALIS_API_KEY=
 EVM_PRIVATE_KEY=
 EVM_PROVIDER_URL=
 
+# Zilliqa
+ZILLIQA_PRIVATE_KEY=
+ZILLIQA_PROVIDER_URL=
+
 # Avalanche
 AVALANCHE_PRIVATE_KEY=
 AVALANCHE_PUBLIC_KEY=

agent/package.json

@@ -144,9 +144,10 @@
 		"@elizaos/plugin-dcap": "workspace:*",
 		"@elizaos/plugin-form": "workspace:*",
 		"@elizaos/plugin-ankr": "workspace:*",
-        "@elizaos/client-xmtp": "workspace:*",
+                "@elizaos/client-xmtp": "workspace:*",
 		"@elizaos/plugin-btcfun": "workspace:*",
-		"@elizaos/plugin-trikon": "workspace:*",
+	        "@elizaos/plugin-trikon": "workspace:*",
+                "@elizaos/plugin-zilliqa": "workspace:*",
 		"readline": "1.3.0",
 		"ws": "8.18.0",
 		"yargs": "17.7.2"
@@ -158,4 +159,4 @@
 		"ts-node": "10.9.2",
 		"tsup": "8.3.5"
 	}
-}
+}

agent/src/index.ts

@@ -52,6 +52,8 @@ import { footballPlugin } from "@elizaos/plugin-football"
 import { bootstrapPlugin } from "@elizaos/plugin-bootstrap"
 import { normalizeCharacter } from "@elizaos/plugin-di"
 import createGoatPlugin from "@elizaos/plugin-goat"
+import createZilliqaPlugin from "@elizaos/plugin-zilliqa";
+
 // import { intifacePlugin } from "@elizaos/plugin-intiface";
 import { ThreeDGenerationPlugin } from "@elizaos/plugin-3d-generation"
 import { abstractPlugin } from "@elizaos/plugin-abstract"
@@ -750,6 +752,13 @@ export async function createAgent(character: Character, db: IDatabaseAdapter, ca
 		goatPlugin = await createGoatPlugin((secret) => getSecret(character, secret))
 	}
 
+        let zilliqaPlugin: any | undefined;
+        if (getSecret(character, "ZILLIQA_PRIVATE_KEY")) {
+          zilliqaPlugin = await createZilliqaPlugin((secret) =>
+             getSecret(character, secret)
+          );
+        }
+
 	// Initialize Reclaim adapter if environment variables are present
 	// let verifiableInferenceAdapter;
 	// if (
@@ -846,7 +855,8 @@ export async function createAgent(character: Character, db: IDatabaseAdapter, ca
 			getSecret(character, "ENABLE_TEE_LOG") && ((teeMode !== TEEMode.OFF && walletSecretSalt) || getSecret(character, "SGX")) ? teeLogPlugin : null,
 			getSecret(character, "OMNIFLIX_API_URL") && getSecret(character, "OMNIFLIX_MNEMONIC") ? OmniflixPlugin : null,
 			getSecret(character, "COINBASE_API_KEY") && getSecret(character, "COINBASE_PRIVATE_KEY") && getSecret(character, "COINBASE_NOTIFICATION_URI") ? webhookPlugin : null,
-			goatPlugin,
+   		        goatPlugin,
+                        zilliqaPlugin,
 			getSecret(character, "COINGECKO_API_KEY") || getSecret(character, "COINGECKO_PRO_API_KEY") ? coingeckoPlugin : null,
 			getSecret(character, "MORALIS_API_KEY") ? moralisPlugin : null,
 			getSecret(character, "EVM_PROVIDER_URL") ? goatPlugin : null,

packages/plugin-zilliqa/README.md

@@ -0,0 +1,49 @@
+# @elizaos/plugin-zilliqa
+
+A plugin for integrating Zilliqa blockchain capabilities through the GOAT (Great Onchain Agent Toolkit) framework within the ElizaOS ecosystem.
+
+## Description
+
+[GOAT](https://ohmygoat.dev/) 🐐 (Great Onchain Agent Toolkit) is an open-source framework for adding blockchain tools such as wallets, being able to hold or trade tokens, or interacting with blockchain smart contracts, to your AI agent.
+
+- [Chains supported](https://ohmygoat.dev/chains-wallets-plugins)
+- [Plugins supported](https://ohmygoat.dev/chains-wallets-plugins)
+
+This plugin integrates the GOAT Zilliqa plugin and wallet with Eliza.
+
+## Installation
+
+```bash
+pnpm install @elizaos/plugin-goat
+```
+
+## Configuration
+
+### Environment Variables
+
+```typescript
+EVM_PRIVATE_KEY=<Your EVM wallet private key>
+EVM_PROVIDER_URL=<Your RPC provider URL (e.g., Infura, Alchemy)>
+```
+
+## Common Issues & Troubleshooting
+
+1. **Agent not executing an action**:
+
+    - If you are also using the EVM Plugin, sometimes the agent might confuse the action name with an EVM Plugin action name instead of the GOAT Plugin action. Removing the EVM Plugin should fix this issue. There is no need for you to use both plugins at the same time.
+    - If you are using Trump as a character it might be tricky to get them to perform any action since the character is full of prompts that aim to change the topic of the conversation. To fix this try using a different character or create your own with prompts that are more suitable to what the agent is supposed to do.
+
+2. **Wallet Connection Issues**
+
+    - Verify private key is correctly formatted
+    - Check RPC endpoint availability
+    - Ensure sufficient network balance
+
+3. **Transaction Issues**
+    - Verify gas availability
+    - Check network congestion
+    - Confirm transaction parameters
+
+## License
+
+This plugin is part of the Eliza project. See the main project repository for license information.

packages/plugin-zilliqa/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "@elizaos/plugin-zilliqa",
+    "version": "0.1.7-alpha.2",
+    "main": "dist/index.js",
+    "type": "module",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "@goat-sdk/adapter-vercel-ai": "0.2.7",
+        "@goat-sdk/core": "0.4.6",
+        "@goat-sdk/plugin-zilliqa": "0.1.2",
+        "@goat-sdk/wallet-evm": "0.2.6",
+        "@goat-sdk/wallet-viem": "0.2.6",
+        "@goat-sdk/wallet-zilliqa": "0.2.5",
+        "@zilliqa-js/account": "^3.5.0",
+        "@zilliqa-js/zilliqa": "^3.5.0",
+        "tsup": "8.3.5"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch"
+    },
+    "peerDependencies": {
+        "whatwg-url": "7.1.0"
+    }
+}