Merge branch 'develop' of https://github.com/elizaos/eliza into test-eliza

Author: odilitime

.env.example

@@ -162,10 +162,22 @@ LARGE_GAIANET_SERVER_URL=       # Default: https://qwen72b.gaia.domains/v1
 GAIANET_EMBEDDING_MODEL=
 USE_GAIANET_EMBEDDING=          # Set to TRUE for GAIANET/768, leave blank for local
 
+# Volcengine Configuration
+VOLENGINE_API_URL=              # Volcengine API Endpoint, Default: https://open.volcengineapi.com/api/v3/
+VOLENGINE_MODEL=
+SMALL_VOLENGINE_MODEL=          # Default: doubao-lite-128k
+MEDIUM_VOLENGINE_MODEL=         # Default: doubao-pro-128k
+LARGE_VOLENGINE_MODEL=          # Default: doubao-pro-256k
+VOLENGINE_EMBEDDING_MODEL=      # Default: doubao-embedding
+
 # EVM
 EVM_PRIVATE_KEY=
 EVM_PROVIDER_URL=
 
+# Avalanche
+AVALANCHE_PRIVATE_KEY=
+AVALANCHE_PUBLIC_KEY=
+
 # Solana
 SOLANA_PRIVATE_KEY=
 SOLANA_PUBLIC_KEY=

.github/pull_request_template.md

@@ -1,15 +1,15 @@
-<!-- Use this template by filling in information and copy and pasting relevant items out of the html comments. -->
+<!-- Use this template by filling in information and copying and pasting relevant items out of the HTML comments. -->
 
-# Relates to:
+# Relates to
 
 <!-- LINK TO ISSUE OR TICKET -->
 
-<!-- This risks section is to be filled out before final review and merge. -->
+<!-- This risks section must be filled out before the final review and merge. -->
 
 # Risks
 
 <!--
-Low, medium, large. List what kind of risks, and what could be effected.
+Low, medium, large. List what kind of risks and what could be affected.
 -->
 
 # Background
@@ -25,7 +25,7 @@ Features (non-breaking change which adds functionality)
 Updates (new versions of included code)
 -->
 
-<!-- This "Why" section is most relevant if there is no linked issue explaining why. If there is a related issue it might make sense to skip this why section. -->
+<!-- This "Why" section is most relevant if there are no linked issues explaining why. If there is a related issue, it might make sense to skip this why section. -->
 <!--
 ## Why are we doing this? Any context or related work?
 -->
@@ -35,10 +35,10 @@ Updates (new versions of included code)
 <!--
 My changes do not require a change to the project documentation.
 My changes require a change to the project documentation.
-If a docs change is needed: I have updated the documentation accordingly.
+If documentation change is needed: I have updated the documentation accordingly.
 -->
 
-<!-- Please show how you tested the PR. This will really help if the PR needs to be retested, and probably help the PR get merged quicker. -->
+<!-- Please show how you tested the PR. This will really help if the PR needs to be retested and probably help the PR get merged quicker. -->
 
 # Testing
 
@@ -47,7 +47,7 @@ If a docs change is needed: I have updated the documentation accordingly.
 ## Detailed testing steps
 
 <!--
-None, automated tests are fine.
+None: Automated tests are acceptable.
 -->
 
 <!--
@@ -63,22 +63,22 @@ None, automated tests are fine.
 ### After
 -->
 
-<!-- If there is anything about the deploy, please make a note. -->
+<!-- If there is anything about the deployment, please make a note. -->
 <!--
 # Deploy Notes
 -->
 
-<!--  Copy and paste commandline output. -->
+<!--  Copy and paste command line output. -->
 <!--
 ## Database changes
 -->
 
-<!--  If there is something more than the automated steps, please specifiy deploy instructions. -->
+<!--  Please specify deploy instructions if there is something more than the automated steps. -->
 <!--
 ## Deployment instructions
 -->
 
-<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for contribute role and join us in #development-feed -->
+<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for the contributor role and join us in #development-feed -->
 <!--
 ## Discord username
 

.github/workflows/jsdoc-automation.yml

@@ -22,6 +22,11 @@ on:
         required: true
         default: ''
         type: string
+      branch:
+        description: 'Target branch for PR (defaults to develop)'
+        required: false
+        default: 'develop'
+        type: string
 
 jobs:
   generate-docs:
@@ -49,7 +54,7 @@ jobs:
           run_install: false
 
       - name: Update lockfile
-        working-directory: packages/jsdoc-automation
+        working-directory: scripts/jsdoc-automation
         run: |
           echo "Updating lockfile..."
           pnpm install --no-frozen-lockfile
@@ -63,11 +68,11 @@ jobs:
         run: pnpm install --no-frozen-lockfile
 
       - name: Install package dependencies
-        working-directory: packages/jsdoc-automation
+        working-directory: scripts/jsdoc-automation
         run: pnpm install --no-frozen-lockfile
 
       - name: Run documentation generator
-        working-directory: packages/jsdoc-automation
+        working-directory: scripts/jsdoc-automation
         run: |
           echo "Node version: $(node --version)"
           echo "NPM version: $(npm --version)"
@@ -78,4 +83,5 @@ jobs:
           INPUT_ROOT_DIRECTORY: ${{ inputs.root_directory }}
           INPUT_PULL_NUMBER: ${{ inputs.pull_number }}
           INPUT_EXCLUDED_DIRECTORIES: ${{ inputs.excluded_directories }}
-          INPUT_REVIEWERS: ${{ inputs.reviewers }}
+          INPUT_REVIEWERS: ${{ inputs.reviewers }}
+          INPUT_BRANCH: ${{ inputs.branch }}

.github/workflows/stale.yml

@@ -12,13 +12,23 @@ jobs:
       issues: write
       pull-requests: write
 
+    env:
+      DAYS_BEFORE_STALE: 30  # Define the days-before-stale value
+      DAYS_BEFORE_CLOSE: 7   # Define the days-before-close value
+
     steps:
     - uses: actions/stale@v5
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue has been automatically marked as stale due to inactivity.'
-        stale-pr-message: 'This pull request has been automatically marked as stale due to inactivity.'
+        stale-issue-message: |
+          This issue has been automatically marked as stale due to ${{
+          env.DAYS_BEFORE_STALE }} days of inactivity.
+          If no further activity occurs within ${{ env.DAYS_BEFORE_CLOSE }} days, it will be closed automatically. Please take action if this issue is still relevant.
+        stale-pr-message: |
+          This pull request has been automatically marked as stale due to ${{
+          env.DAYS_BEFORE_STALE }} days of inactivity.
+          If no further activity occurs within ${{ env.DAYS_BEFORE_CLOSE }} days, it will be closed automatically. Please take action if this pull request is still relevant.
         stale-issue-label: 'no-issue-activity'
         stale-pr-label: 'no-pr-activity'
-        days-before-stale: 30  # Marks issues and PRs as stale after X days of inactivity
-        days-before-close: 7  # Closes issues and PRs X days after being marked as stale
+        days-before-stale: ${{ env.DAYS_BEFORE_STALE }}  
+        days-before-close: ${{ env.DAYS_BEFORE_CLOSE }}  

.gitignore

@@ -49,6 +49,7 @@ packages/plugin-coinbase/src/plugins/transactions.csv
 tsup.config.bundled_*.mjs
 
 .turbo
+.cursorrules
 
 coverage
 .eslintcache

CHANGELOG.md

@@ -1224,4 +1224,4 @@
 
 
 
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

README.md

@@ -12,7 +12,13 @@
 
 ## 🌍 README Translations
 
-[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md)
+[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md)
+
+## 🚩 Overview
+
+<div align="center">
+  <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
+</div>
 
 ## ✨ Features
 
@@ -56,7 +62,7 @@ cp .env.example .env
 pnpm i && pnpm build && pnpm start
 ```
 Once the agent is running, You should see the message to run "pnpm start:client" at the end.
-Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. 
+Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
 ```bash
 pnpm start:client
 ```
@@ -86,11 +92,11 @@ Copy .env.example to .env and fill in the appropriate values.
 cp .env.example .env
 ```
 
-Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
+Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
 
 ### Automatically Start Eliza
 
-This will run everything to setup the project and start the bot with the default character.
+This will run everything to set up the project and start the bot with the default character.
 
 ```bash
 sh scripts/start.sh

README_CN.md

@@ -104,13 +104,55 @@ pnpm start
 
 ## 配置不同的大模型
 
-### 配置Llama
+您可以使用不同的大模型来驱动您的AI Agent，切换不同大模型需要两步：
 
-您可以通过设置 `XAI_MODEL` 环境变量为 `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` 或 `meta-llama/Meta-Llama-3.1-405B-Instruct` 来运行 Llama 70B 或 405B 模型
+1. 确认您在`.env`文件内配置了对应的大模型API Key或对应的访问配置，例如如果您想使用OpenAI，则需要找到`OPENAI_API_KEY`参数，并填入您的OpenAI API Key，并以此类推。
+2. 在您的*Character*文件里找到`modelProvider`，并更改这里的内容，例如如果想要切换到Claude，则需要填入`anthropic`,以此来表明您将使用anthropic大模型作为您的对应Agent的Provider.
+
+在`.env`文件内您可以找到不同大模型的详细配置，包括设定具体想要使用对应提供商的哪个模型，下方我们给出了两个实例：
 
 ### 配置OpenAI
 
-您可以通过设置 `XAI_MODEL` 环境变量为 `gpt-4o-mini` 或 `gpt-4o` 来运行 OpenAI 模型
+首先您需要在Character文件内指定model provider
+
+```json
+    "name": "C-3PO",
+    "clients": [],
+    "modelProvider": "openai"
+    ...
+```
+
+其次请在`env`文件内配置相关参数
+
+```
+# AI Model API Keys
+OPENAI_API_KEY=                 # OpenAI API key, starting with sk-
+SMALL_OPENAI_MODEL=             # Default: gpt-4o-mini
+MEDIUM_OPENAI_MODEL=            # Default: gpt-4o
+LARGE_OPENAI_MODEL=             # Default: gpt-4o
+EMBEDDING_OPENAI_MODEL=         # Default: text-embedding-3-small
+IMAGE_OPENAI_MODEL=             # Default: dall-e-3
+
+```
+
+### 配置Anthorpic
+
+```json
+    "name": "C-3PO",
+    "clients": [],
+    "modelProvider": "anthropic"
+    ...
+```
+
+其次请在`env`文件内配置相关参数
+
+```
+# Anthropic Configuration
+ANTHROPIC_API_KEY=              # For Claude
+SMALL_ANTHROPIC_MODEL=          # Default: claude-3-haiku-20240307
+MEDIUM_ANTHROPIC_MODEL=         # Default: claude-3-5-sonnet-20241022
+LARGE_ANTHROPIC_MODEL=          # Default: claude-3-5-sonnet-20241022
+```
 
 ## 其他要求