Skip to content

Commit 9c1e6c7

Browse files
yoniebansyoniebans
authored
Merge branch 'main' into feat/add_image_text_model_provider_seperation_and_falai
2 parents 27542e7 + c31eddf commit 9c1e6c7

File tree

28 files changed

+4328
-322
lines changed

28 files changed

+4328
-322
lines changed

‎.env.example

+11-2
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ SMALL_OLLAMA_MODEL= # Default: llama3.2
6262
MEDIUM_OLLAMA_MODEL= # Default: hermes3
6363
LARGE_OLLAMA_MODEL= # Default: hermes3:70b
6464

65+
#LlamaLocal Configuration
66+
LLAMALOCAL_PATH= # Default: "" which is the current directory in plugin-node/dist/ which gets destroyed and recreated on every build
67+
6568
# API Keys
6669
ANTHROPIC_API_KEY= # For Claude
6770
HEURIST_API_KEY= # Get from https://heurist.ai/dev-access
@@ -138,13 +141,19 @@ ZEROG_PRIVATE_KEY=
138141
ZEROG_FLOW_ADDRESS=
139142

140143

141-
# Coinbase Commerce
144+
# Coinbase
142145
COINBASE_COMMERCE_KEY=
146+
COINBASE_API_KEY=
147+
COINBASE_PRIVATE_KEY=
148+
149+
COINBASE_GENERATED_WALLET_ID=
150+
COINBASE_GENERATED_WALLET_HEX_SEED=
143151

144152

145153
# TEE Configuration
146154
DSTACK_SIMULATOR_ENDPOINT=
147155
WALLET_SECRET_SALT=secret_salt
148156

157+
# fal.ai Configuration
149158
FAL_API_KEY=
150-
FAL_AI_LORA_PATH=
159+
FAL_AI_LORA_PATH=

‎.github/workflows/ci.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,8 @@ jobs:
3838

3939
- name: Build packages
4040
run: pnpm run build
41+
42+
- name: Upload coverage reports to Codecov
43+
uses: codecov/codecov-action@v5
44+
with:
45+
token: ${{ secrets.CODECOV_TOKEN }}

‎agent/src/index.ts

+33-18
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { bootstrapPlugin } from "@ai16z/plugin-bootstrap";
2828
import {
2929
coinbaseCommercePlugin,
3030
coinbaseMassPaymentsPlugin,
31+
tradePlugin,
3132
} from "@ai16z/plugin-coinbase";
3233
import { confluxPlugin } from "@ai16z/plugin-conflux";
3334
import { imageGenerationPlugin } from "@ai16z/plugin-image-generation";
@@ -86,7 +87,9 @@ function tryLoadFile(filePath: string): string | null {
8687
export async function loadCharacters(
8788
charactersArg: string
8889
): Promise<Character[]> {
89-
let characterPaths = charactersArg?.split(",").map((filePath) => filePath.trim());
90+
let characterPaths = charactersArg
91+
?.split(",")
92+
.map((filePath) => filePath.trim());
9093
const loadedCharacters = [];
9194

9295
if (characterPaths?.length > 0) {
@@ -99,8 +102,16 @@ export async function loadCharacters(
99102
characterPath, // exact path as specified
100103
path.resolve(process.cwd(), characterPath), // relative to cwd
101104
path.resolve(__dirname, characterPath), // relative to current script
102-
path.resolve(__dirname, "../characters", path.basename(characterPath)), // relative to characters dir from agent
103-
path.resolve(__dirname, "../../characters", path.basename(characterPath)), // relative to project root characters dir
105+
path.resolve(
106+
__dirname,
107+
"../characters",
108+
path.basename(characterPath)
109+
), // relative to characters dir from agent
110+
path.resolve(
111+
__dirname,
112+
"../../characters",
113+
path.basename(characterPath)
114+
), // relative to project root characters dir
104115
];
105116

106117
for (const tryPath of pathsToTry) {
@@ -112,9 +123,11 @@ export async function loadCharacters(
112123
}
113124

114125
if (content === null) {
115-
elizaLogger.error(`Error loading character from ${characterPath}: File not found in any of the expected locations`);
126+
elizaLogger.error(
127+
`Error loading character from ${characterPath}: File not found in any of the expected locations`
128+
);
116129
elizaLogger.error("Tried the following paths:");
117-
pathsToTry.forEach(p => elizaLogger.error(` - ${p}`));
130+
pathsToTry.forEach((p) => elizaLogger.error(` - ${p}`));
118131
process.exit(1);
119132
}
120133

@@ -135,9 +148,13 @@ export async function loadCharacters(
135148
}
136149

137150
loadedCharacters.push(character);
138-
elizaLogger.info(`Successfully loaded character from: ${resolvedPath}`);
151+
elizaLogger.info(
152+
`Successfully loaded character from: ${resolvedPath}`
153+
);
139154
} catch (e) {
140-
elizaLogger.error(`Error parsing character from ${resolvedPath}: ${e}`);
155+
elizaLogger.error(
156+
`Error parsing character from ${resolvedPath}: ${e}`
157+
);
141158
process.exit(1);
142159
}
143160
}
@@ -291,7 +308,7 @@ export function createAgent(
291308
character.name
292309
);
293310

294-
nodePlugin ??= createNodePlugin()
311+
nodePlugin ??= createNodePlugin();
295312

296313
return new AgentRuntime({
297314
databaseAdapter: db,
@@ -306,30 +323,28 @@ export function createAgent(
306323
: null,
307324
nodePlugin,
308325
getSecret(character, "SOLANA_PUBLIC_KEY") ||
309-
getSecret(character, "WALLET_PUBLIC_KEY") &&
310-
!getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x")
326+
(getSecret(character, "WALLET_PUBLIC_KEY") &&
327+
!getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x"))
311328
? solanaPlugin
312329
: null,
313330
getSecret(character, "EVM_PUBLIC_KEY") ||
314-
getSecret(character, "WALLET_PUBLIC_KEY") &&
315-
!getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x")
331+
(getSecret(character, "WALLET_PUBLIC_KEY") &&
332+
!getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x"))
316333
? evmPlugin
317334
: null,
318335
getSecret(character, "ZEROG_PRIVATE_KEY") ? zgPlugin : null,
319336
getSecret(character, "COINBASE_COMMERCE_KEY")
320337
? coinbaseCommercePlugin
321338
: null,
322-
getSecret(character, "COINBASE_API_KEY") &&
323-
getSecret(character, "COINBASE_PRIVATE_KEY")
324-
? coinbaseMassPaymentsPlugin
325-
: null,
326-
getSecret(character, "BUTTPLUG_API_KEY") ? buttplugPlugin : null,
327339
getSecret(character, "FAL_API_KEY") ||
328340
getSecret(character, "OPENAI_API_KEY") ||
329341
getSecret(character, "HEURIST_API_KEY")
330342
? imageGenerationPlugin
331343
: null,
332-
getSecret(character, "WALLET_SECRET_SALT") ? teePlugin : null,
344+
...(getSecret(character, "COINBASE_API_KEY") &&
345+
getSecret(character, "COINBASE_PRIVATE_KEY")
346+
? [coinbaseMassPaymentsPlugin, tradePlugin]
347+
: []),
333348
].filter(Boolean),
334349
providers: [],
335350
actions: [],

‎docs/docs/packages/plugins.md

+144-26
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,44 @@ This plugin enables Eliza to interact with the Coinbase Commerce API to create a
225225

226226
---
227227

228+
### Coinbase Wallet Management
229+
230+
The plugin automatically handles wallet creation or uses an existing wallet if the required details are provided during the first run.
231+
232+
1. **Wallet Generation on First Run**
233+
If no wallet information is provided (`COINBASE_GENERATED_WALLET_HEX_SEED` and `COINBASE_GENERATED_WALLET_ID`), the plugin will:
234+
235+
- **Generate a new wallet** using the Coinbase SDK.
236+
- Automatically **export the wallet details** (`seed` and `walletId`) and securely store them in `runtime.character.settings.secrets` or other configured storage.
237+
- Log the wallet’s default address for reference.
238+
- If the character file does not exist, the wallet details are saved to a characters/charactername-seed.txt file in the characters directory with a note indicating that the user must manually add these details to settings.secrets or the .env file.
239+
240+
2. **Using an Existing Wallet**
241+
If wallet information is available during the first run:
242+
- Provide `COINBASE_GENERATED_WALLET_HEX_SEED` and `COINBASE_GENERATED_WALLET_ID` via `runtime.character.settings.secrets` or environment variables.
243+
- The plugin will **import the wallet** and use it for processing mass payouts.
244+
245+
---
246+
247+
### Coinbase Wallet Management
248+
249+
The plugin automatically handles wallet creation or uses an existing wallet if the required details are provided during the first run.
250+
251+
1. **Wallet Generation on First Run**
252+
If no wallet information is provided (`COINBASE_GENERATED_WALLET_HEX_SEED` and `COINBASE_GENERATED_WALLET_ID`), the plugin will:
253+
254+
- **Generate a new wallet** using the Coinbase SDK.
255+
- Automatically **export the wallet details** (`seed` and `walletId`) and securely store them in `runtime.character.settings.secrets` or other configured storage.
256+
- Log the wallet’s default address for reference.
257+
- If the character file does not exist, the wallet details are saved to a characters/charactername-seed.txt file in the characters directory with a note indicating that the user must manually add these details to settings.secrets or the .env file.
258+
259+
2. **Using an Existing Wallet**
260+
If wallet information is available during the first run:
261+
- Provide `COINBASE_GENERATED_WALLET_HEX_SEED` and `COINBASE_GENERATED_WALLET_ID` via `runtime.character.settings.secrets` or environment variables.
262+
- The plugin will **import the wallet** and use it for processing mass payouts.
263+
264+
---
265+
228266
#### 6. Coinbase MassPayments Plugin (`@eliza/plugin-coinbase`)
229267

230268
This plugin facilitates the processing of cryptocurrency mass payouts using the Coinbase SDK. It enables the creation and management of mass payouts to multiple wallet addresses, logging all transaction details to a CSV file for further analysis.
@@ -311,7 +349,6 @@ The plugin automatically handles wallet creation or uses an existing wallet if t
311349
- Provide `COINBASE_GENERATED_WALLET_HEX_SEED` and `COINBASE_GENERATED_WALLET_ID` via `runtime.character.settings.secrets` or environment variables.
312350
- The plugin will **import the wallet** and use it for processing mass payouts.
313351

314-
315352
**Required Configurations:**
316353

317354
The following configurations must be provided for wallet management:
@@ -321,8 +358,9 @@ The following configurations must be provided for wallet management:
321358
- `COINBASE_GENERATED_WALLET_ID`: Unique wallet ID.
322359
- These variables must be securely stored in `runtime.character.settings.secrets` or as environment variables.
323360

361+
---
324362

325-
**Wallet Creation Process:**
363+
### Wallet Creation Process
326364

327365
1. **Automatic Wallet Creation**
328366
When no wallet details are available:
@@ -449,37 +487,117 @@ const provider = new DeriveKeyProvider();
449487
450488
// Derive a raw key
451489
try {
452-
const rawKey = await provider.rawDeriveKey(
453-
"/path/to/derive",
454-
"subject-identifier"
455-
);
456-
// rawKey is a DeriveKeyResponse that can be used for further processing
457-
// to get the uint8Array do the following
458-
const rawKeyArray = rawKey.asUint8Array()
490+
const rawKey = await provider.rawDeriveKey(
491+
"/path/to/derive",
492+
"subject-identifier",
493+
);
494+
// rawKey is a DeriveKeyResponse that can be used for further processing
495+
// to get the uint8Array do the following
496+
const rawKeyArray = rawKey.asUint8Array();
497+
} catch (error) {
498+
console.error("Raw key derivation failed:", error);
499+
}
500+
501+
// Derive a Solana keypair (Ed25519)
502+
try {
503+
const solanaKeypair = await provider.deriveEd25519Keypair(
504+
"/path/to/derive",
505+
"subject-identifier",
506+
);
507+
// solanaKeypair can now be used for Solana operations
508+
} catch (error) {
509+
console.error("Solana key derivation failed:", error);
510+
}
511+
512+
// Derive an Ethereum keypair (ECDSA)
513+
try {
514+
const evmKeypair = await provider.deriveEcdsaKeypair(
515+
"/path/to/derive",
516+
"subject-identifier",
517+
);
518+
// evmKeypair can now be used for Ethereum operations
519+
} catch (error) {
520+
console.error("EVM key derivation failed:", error);
521+
}
522+
```
523+
524+
**RemoteAttestationProvider Usage**
525+
526+
```typescript
527+
import { RemoteAttestationProvider } from "@ai16z/plugin-tee";
528+
// Initialize the provider
529+
const provider = new RemoteAttestationProvider();
530+
// Generate Remote Attestation
531+
try {
532+
const attestation = await provider.generateAttestation("your-report-data");
533+
console.log("Attestation:", attestation);
534+
} catch (error) {
535+
console.error("Failed to generate attestation:", error);
536+
}
537+
```
538+
539+
**Configuration**
540+
541+
When using the provider through the runtime environment, ensure the following settings are configured:
542+
543+
```env
544+
# Optional, for simulator purposes if testing on mac or windows. Leave empty for Linux x86 machines.
545+
DSTACK_SIMULATOR_ENDPOINT="http://host.docker.internal:8090"
546+
WALLET_SECRET_SALT=your-secret-salt // Required to single agent deployments
547+
```
548+
549+
---
550+
551+
#### 7. TEE Plugin (`@ai16z/plugin-tee`)
552+
553+
Integrates [Dstack SDK](https://github.com/Dstack-TEE/dstack) to enable TEE (Trusted Execution Environment) functionality and deploy secure & privacy-enhanced Eliza Agents:
554+
555+
**Providers:**
556+
557+
- `deriveKeyProvider` - Allows for secure key derivation within a TEE environment. It supports deriving keys for both Solana (Ed25519) and Ethereum (ECDSA) chains.
558+
- `remoteAttestationProvider` - Generate a Remote Attestation Quote based on `report_data`.
559+
560+
**DeriveKeyProvider Usage**
561+
562+
```typescript
563+
import { DeriveKeyProvider } from "@ai16z/plugin-tee";
564+
565+
// Initialize the provider
566+
const provider = new DeriveKeyProvider();
567+
568+
// Derive a raw key
569+
try {
570+
const rawKey = await provider.rawDeriveKey(
571+
"/path/to/derive",
572+
"subject-identifier",
573+
);
574+
// rawKey is a DeriveKeyResponse that can be used for further processing
575+
// to get the uint8Array do the following
576+
const rawKeyArray = rawKey.asUint8Array();
459577
} catch (error) {
460-
console.error("Raw key derivation failed:", error);
578+
console.error("Raw key derivation failed:", error);
461579
}
462580
463581
// Derive a Solana keypair (Ed25519)
464582
try {
465-
const solanaKeypair = await provider.deriveEd25519Keypair(
466-
"/path/to/derive",
467-
"subject-identifier"
468-
);
469-
// solanaKeypair can now be used for Solana operations
583+
const solanaKeypair = await provider.deriveEd25519Keypair(
584+
"/path/to/derive",
585+
"subject-identifier",
586+
);
587+
// solanaKeypair can now be used for Solana operations
470588
} catch (error) {
471-
console.error("Solana key derivation failed:", error);
589+
console.error("Solana key derivation failed:", error);
472590
}
473591
474592
// Derive an Ethereum keypair (ECDSA)
475593
try {
476-
const evmKeypair = await provider.deriveEcdsaKeypair(
477-
"/path/to/derive",
478-
"subject-identifier"
479-
);
480-
// evmKeypair can now be used for Ethereum operations
594+
const evmKeypair = await provider.deriveEcdsaKeypair(
595+
"/path/to/derive",
596+
"subject-identifier",
597+
);
598+
// evmKeypair can now be used for Ethereum operations
481599
} catch (error) {
482-
console.error("EVM key derivation failed:", error);
600+
console.error("EVM key derivation failed:", error);
483601
}
484602
```
485603

@@ -491,10 +609,10 @@ import { RemoteAttestationProvider } from "@ai16z/plugin-tee";
491609
const provider = new RemoteAttestationProvider();
492610
// Generate Remote Attestation
493611
try {
494-
const attestation = await provider.generateAttestation("your-report-data");
495-
console.log("Attestation:", attestation);
612+
const attestation = await provider.generateAttestation("your-report-data");
613+
console.log("Attestation:", attestation);
496614
} catch (error) {
497-
console.error("Failed to generate attestation:", error);
615+
console.error("Failed to generate attestation:", error);
498616
}
499617
```
500618

@@ -508,7 +626,7 @@ DSTACK_SIMULATOR_ENDPOINT="http://host.docker.internal:8090"
508626
WALLET_SECRET_SALT=your-secret-salt // Required to single agent deployments
509627
```
510628

511-
___
629+
---
512630

513631
### Writing Custom Plugins
514632

0 commit comments

Comments
 (0)