Skip to content

Commit 082bbc4

Browse files
monilpatmonilpat
authored
Merge branch 'develop' into 1506--clean-cache
2 parents 4084905 + 2633a5e commit 082bbc4

17 files changed

+827
-67
lines changed

‎.env.example

+3
Original file line numberDiff line numberDiff line change
@@ -344,3 +344,6 @@ PINATA_JWT= # Pinata JWT for uploading files to IPFS
344344
# Cronos zkEVM
345345
CRONOSZKEVM_ADDRESS=
346346
CRONOSZKEVM_PRIVATE_KEY=
347+
348+
# Fuel Ecosystem (FuelVM)
349+
FUEL_WALLET_PRIVATE_KEY=

‎agent/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"@elizaos/plugin-twitter": "workspace:*",
5757
"@elizaos/plugin-cronoszkevm": "workspace:*",
5858
"@elizaos/plugin-3d-generation": "workspace:*",
59+
"@elizaos/plugin-fuel": "workspace:*",
5960
"readline": "1.3.0",
6061
"ws": "8.18.0",
6162
"yargs": "17.7.2"

‎agent/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ import { confluxPlugin } from "@elizaos/plugin-conflux";
4646
import { evmPlugin } from "@elizaos/plugin-evm";
4747
import { storyPlugin } from "@elizaos/plugin-story";
4848
import { flowPlugin } from "@elizaos/plugin-flow";
49+
import { fuelPlugin } from "@elizaos/plugin-fuel";
4950
import { imageGenerationPlugin } from "@elizaos/plugin-image-generation";
5051
import { ThreeDGenerationPlugin } from "@elizaos/plugin-3d-generation";
5152
import { multiversxPlugin } from "@elizaos/plugin-multiversx";
@@ -591,6 +592,7 @@ export async function createAgent(
591592
getSecret(character, "TON_PRIVATE_KEY") ? tonPlugin : null,
592593
getSecret(character, "SUI_PRIVATE_KEY") ? suiPlugin : null,
593594
getSecret(character, "STORY_PRIVATE_KEY") ? storyPlugin : null,
595+
getSecret(character, "FUEL_PRIVATE_KEY") ? fuelPlugin : null,
594596
].filter(Boolean),
595597
providers: [],
596598
actions: [],

‎client/tsconfig.app.json

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,36 @@
11
{
22
"compilerOptions": {
3+
"incremental": true,
34
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
45
"target": "ES2020",
56
"useDefineForClassFields": true,
6-
"lib": ["ES2020", "DOM", "DOM.Iterable"],
7+
"lib": [
8+
"ES2020",
9+
"DOM",
10+
"DOM.Iterable"
11+
],
712
"module": "ESNext",
813
"skipLibCheck": true,
9-
1014
/* Bundler mode */
1115
"moduleResolution": "Bundler",
1216
"allowImportingTsExtensions": true,
1317
"isolatedModules": true,
1418
"moduleDetection": "force",
1519
"noEmit": true,
1620
"jsx": "react-jsx",
17-
1821
/* Linting */
1922
"strict": true,
2023
"noUnusedLocals": true,
2124
"noUnusedParameters": true,
2225
"noFallthroughCasesInSwitch": true,
23-
"noUncheckedSideEffectImports": true,
2426
"baseUrl": ".",
2527
"paths": {
26-
"@/*": ["./src/*"]
28+
"@/*": [
29+
"./src/*"
30+
]
2731
}
2832
},
29-
"include": ["src"]
30-
}
33+
"include": [
34+
"src"
35+
]
36+
}

‎client/tsconfig.node.json

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
{
22
"compilerOptions": {
3+
"incremental": true,
34
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
45
"target": "ES2022",
5-
"lib": ["ES2023"],
6+
"lib": [
7+
"ES2023"
8+
],
69
"module": "ESNext",
710
"skipLibCheck": true,
8-
911
/* Bundler mode */
1012
"moduleResolution": "Bundler",
1113
"allowImportingTsExtensions": true,
1214
"isolatedModules": true,
1315
"moduleDetection": "force",
1416
"noEmit": true,
15-
1617
/* Linting */
1718
"strict": true,
1819
"noUnusedLocals": true,
1920
"noUnusedParameters": true,
20-
"noFallthroughCasesInSwitch": true,
21-
"noUncheckedSideEffectImports": true
21+
"noFallthroughCasesInSwitch": true
2222
},
23-
"include": ["vite.config.ts"]
24-
}
23+
"include": [
24+
"vite.config.ts"
25+
]
26+
}

‎docs/docs/packages/plugins.md

+31
Original file line numberDiff line numberDiff line change
@@ -603,6 +603,37 @@ console.log("Webhook creation response:", response);
603603
- **Validation**: Always validate input parameters to ensure compliance with expected formats and supported networks.
604604
- **Error Handling**: Monitor logs for errors during webhook creation and adjust retry logic as needed.
605605

606+
### 10. Fuel Plugin (`@elizaos/plugin-fuel`)
607+
608+
The Fuel plugin provides an interface to the Fuel Ignition blockchain.
609+
610+
**Actions:**
611+
612+
1. `TRANSFER_FUEL_ETH` - Transfer ETH to a given Fuel address. - **Inputs**: - `toAddress` (string): The Fuel address to transfer ETH to. - `amount` (string): The amount of ETH to transfer. - **Outputs**: Confirmation message with transaction details. - **Example**:
613+
`json
614+
{
615+
"toAddress": "0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1",
616+
"amount": "0.00001"
617+
}
618+
`
619+
**Setup and Configuration:**
620+
621+
1. **Configure the Plugin**
622+
Add the plugin to your character's configuration:
623+
624+
```typescript
625+
import { fuelPlugin } from "@eliza/plugin-fuel";
626+
627+
const character = {
628+
plugins: [fuelPlugin],
629+
};
630+
```
631+
632+
1. **Required Configurations**
633+
Set the following environment variables or runtime settings:
634+
635+
- `FUEL_WALLET_PRIVATE_KEY`: Private key for secure transactions
636+
606637
### Writing Custom Plugins
607638

608639
Create a new plugin by implementing the Plugin interface:

‎packages/plugin-fuel/.npmignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*
2+
3+
!dist/**
4+
!package.json
5+
!readme.md
6+
!tsup.config.ts

‎packages/plugin-fuel/eslint.config.mjs

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import eslintGlobalConfig from "../../eslint.config.mjs";
2+
3+
export default [...eslintGlobalConfig];

‎packages/plugin-fuel/package.json

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"name": "@elizaos/plugin-fuel",
3+
"version": "0.1.7-alpha.1",
4+
"main": "dist/index.js",
5+
"type": "module",
6+
"types": "dist/index.d.ts",
7+
"dependencies": {
8+
"@elizaos/core": "workspace:*",
9+
"fuels": "0.97.2",
10+
"tsup": "8.3.5",
11+
"vitest": "2.1.4"
12+
},
13+
"scripts": {
14+
"build": "tsup --format esm --dts",
15+
"dev": "tsup --format esm --dts --watch",
16+
"lint": "eslint --fix --cache .",
17+
"test": "vitest run"
18+
},
19+
"peerDependencies": {
20+
"form-data": "4.0.1",
21+
"whatwg-url": "7.1.0"
22+
}
23+
}

‎packages/plugin-fuel/src/actions/transfer.ts

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
import {
2+
Action,
3+
composeContext,
4+
generateObjectDeprecated,
5+
IAgentRuntime,
6+
ModelClass,
7+
State,
8+
} from "@elizaos/core";
9+
import { initWalletProvider, WalletProvider } from "../providers/wallet";
10+
import { bn } from "fuels";
11+
import { transferTemplate } from "../templates";
12+
13+
type TransferParams = {
14+
toAddress: string;
15+
amount: string;
16+
};
17+
18+
export class TransferAction {
19+
constructor(private walletProvider: WalletProvider) {}
20+
21+
async transfer(params: TransferParams) {
22+
try {
23+
const { toAddress, amount } = params;
24+
const res = await this.walletProvider.wallet.transfer(
25+
toAddress,
26+
bn.parseUnits(amount)
27+
);
28+
const tx = await res.waitForResult();
29+
return tx;
30+
} catch (error) {
31+
throw new Error(`Transfer failed: ${error.message}`);
32+
}
33+
}
34+
}
35+
36+
const buildTransferDetails = async (state: State, runtime: IAgentRuntime) => {
37+
const context = composeContext({
38+
state,
39+
template: transferTemplate,
40+
});
41+
42+
const transferDetails = (await generateObjectDeprecated({
43+
runtime,
44+
context,
45+
modelClass: ModelClass.SMALL,
46+
})) as TransferParams;
47+
48+
return transferDetails;
49+
};
50+
51+
export const transferAction: Action = {
52+
name: "transfer",
53+
description: "Transfer Fuel ETH between addresses on Fuel Ignition",
54+
handler: async (runtime, message, state, options, callback) => {
55+
const walletProvider = await initWalletProvider(runtime);
56+
const action = new TransferAction(walletProvider);
57+
58+
const paramOptions = await buildTransferDetails(state, runtime);
59+
60+
try {
61+
const transferResp = await action.transfer(paramOptions);
62+
if (callback) {
63+
callback({
64+
text: `Successfully transferred ${paramOptions.amount} ETH to ${paramOptions.toAddress}\nTransaction Hash: ${transferResp.id}`,
65+
content: {
66+
success: true,
67+
hash: transferResp.id,
68+
amount: paramOptions.amount,
69+
recipient: paramOptions.toAddress,
70+
},
71+
});
72+
}
73+
return true;
74+
} catch (error) {
75+
console.error("Error during token transfer:", error);
76+
if (callback) {
77+
callback({
78+
text: `Error transferring tokens: ${error.message}`,
79+
content: { error: error.message },
80+
});
81+
}
82+
return false;
83+
}
84+
},
85+
// template: transferTemplate,
86+
validate: async (runtime: IAgentRuntime) => {
87+
const privateKey = runtime.getSetting("FUEL_PRIVATE_KEY");
88+
return typeof privateKey === "string" && privateKey.startsWith("0x");
89+
},
90+
examples: [
91+
[
92+
{
93+
user: "assistant",
94+
content: {
95+
text: "I'll help you transfer 1 ETH to 0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1",
96+
action: "SEND_TOKENS",
97+
},
98+
},
99+
{
100+
user: "user",
101+
content: {
102+
text: "Transfer 1 ETH to 0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1",
103+
action: "SEND_TOKENS",
104+
},
105+
},
106+
],
107+
],
108+
similes: ["TRANSFER_FUEL_ETH"],
109+
};

‎packages/plugin-fuel/src/index.ts

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { Plugin } from "@elizaos/core";
2+
import { transferAction } from "./actions/transfer";
3+
import { fuelWalletProvider } from "./providers/wallet";
4+
5+
export const fuelPlugin: Plugin = {
6+
name: "fuel",
7+
description: "Fuel blockchain integration plugin",
8+
providers: [fuelWalletProvider],
9+
evaluators: [],
10+
services: [],
11+
actions: [transferAction],
12+
};
13+
14+
export default fuelPlugin;

‎packages/plugin-fuel/src/providers/wallet.ts

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
import type { IAgentRuntime, Provider, Memory, State } from "@elizaos/core";
2+
import { Provider as FuelProvider, Wallet, WalletUnlocked } from "fuels";
3+
4+
export class WalletProvider {
5+
wallet: WalletUnlocked;
6+
7+
constructor(privateKey: `0x${string}`, provider: FuelProvider) {
8+
this.wallet = Wallet.fromPrivateKey(privateKey, provider);
9+
}
10+
11+
getAddress(): string {
12+
return this.wallet.address.toB256();
13+
}
14+
15+
async getBalance() {
16+
const balance = await this.wallet.getBalance();
17+
return balance.format();
18+
}
19+
}
20+
21+
export const initWalletProvider = async (runtime: IAgentRuntime) => {
22+
const privateKey = runtime.getSetting("FUEL_PRIVATE_KEY");
23+
if (!privateKey) {
24+
throw new Error("FUEL_PRIVATE_KEY is missing");
25+
}
26+
const fuelProviderUrl =
27+
runtime.getSetting("FUEL_PROVIDER_URL") ||
28+
"https://mainnet.fuel.network/v1/graphql";
29+
30+
const provider = await FuelProvider.create(fuelProviderUrl);
31+
return new WalletProvider(privateKey as `0x${string}`, provider);
32+
};
33+
34+
export const fuelWalletProvider: Provider = {
35+
async get(
36+
runtime: IAgentRuntime,
37+
_message: Memory,
38+
_state?: State
39+
): Promise<string | null> {
40+
const walletProvider = await initWalletProvider(runtime);
41+
const balance = await walletProvider.getBalance();
42+
return `Fuel Wallet Address: ${walletProvider.getAddress()}\nBalance: ${balance} ETH`;
43+
},
44+
};

‎packages/plugin-fuel/src/templates/index.ts

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
export const transferTemplate = `Given the recent messages and wallet information below:
2+
3+
{{recentMessages}}
4+
5+
{{walletInfo}}
6+
7+
Extract the following information about the requested transfer:
8+
- Amount to transfer: Must be a string representing the amount in ETH (only number without coin symbol, e.g., "0.1")
9+
- Recipient address: Must be a valid Fuel wallet address starting with "0x"
10+
11+
Respond with a JSON markdown block containing only the extracted values. All fields except 'token' are required:
12+
13+
\`\`\`json
14+
{
15+
"amount": string,
16+
"toAddress": string,
17+
}
18+
\`\`\`
19+
`;

0 commit comments

Comments
 (0)