Merge branch 'main' into feature/tests

Author: mladcepes

.env.example

@@ -55,8 +55,12 @@ LARGE_OLLAMA_MODEL=         #default hermes3:70b
 # For asking Claude stuff
 ANTHROPIC_API_KEY=
 
-# Heurist API 
+# Heurist API (Get API Key at https://heurist.ai/dev-access)
 HEURIST_API_KEY=
+SMALL_HEURIST_LANGUAGE_MODEL=
+MEDIUM_HEURIST_LANGUAGE_MODEL=
+LARGE_HEURIST_LANGUAGE_MODEL=
+HEURIST_IMAGE_MODEL=
 
 WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
 WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
@@ -75,3 +79,7 @@ TELEGRAM_BOT_TOKEN=
 
 TOGETHER_API_KEY=
 SERVER_PORT=3000
+
+# Starknet
+STARKNET_ADDRESS=
+STARKNET_PRIVATE_KEY=

.github/workflows/pr.yaml

@@ -0,0 +1,28 @@
+name: PR Title Check
+
+on:
+    pull_request:
+        types: [opened, edited, synchronize]
+
+jobs:
+    check-pr-title:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Check out the repository
+              uses: actions/checkout@v2
+
+            - name: Validate PR title
+              id: validate
+              run: |
+                  PR_TITLE=$(jq -r .pull_request.title "$GITHUB_EVENT_PATH")
+                  echo "PR Title: $PR_TITLE"
+                  if [[ ! "$PR_TITLE" =~ ^(feat|fix|docs|style|refactor|test|chore):\ .+ ]]; then
+                    echo "PR title does not match the required pattern."
+                    exit 1
+                  fi
+
+            - name: Set status
+              if: failure()
+              run: |
+                  gh pr comment ${{ github.event.pull_request.number }} --body "❌ PR title does not match the required pattern. Please use the format: 'type: description' (e.g., 'feat: add new feature')."

README.md

@@ -3,9 +3,13 @@
 <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
 
 ### [For Chinese Version: 中文说明](./README_CN.md)
+
 ### [For Japanese Version: 日本語の説明](./README_JA.md)
+
 ### [For Korean Version: 한국어 설명](./README_KOR.md)
+
 ### [For French Version: Instructions en français](./README_FR.md)
+
 ### [For Portuguese Version: Instruções em português](./README_PTBR.md)
 
 ## Features
@@ -193,4 +197,21 @@ pnpm docker
 
 This will drop you into a shell inside the docker container where you can continue to configure the instance
 
-and then you can start it with `pnpm start`
+and then you can start it with `pnpm start`
+
+
+## Community & contact 
+
+* [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
+* [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
+
+
+**Contributors**
+
+<a href="https://github.com/ai16z/eliza/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ai16z/eliza" />
+</a>
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

README_FR.md

@@ -4,20 +4,20 @@
 
 ## la fonctionnalité
 
-- 🛠 soutenir la connexion discord/ twitter /telegram
-- 👥 soutien aux agents multimodaux
-- 📚 simple à importer des documents et interagir avec les documents
-- mémoire et stockage des documents accessibles
-- 🚀 haute scalabilité, vous pouvez personnaliser les clients et les comportements pour une extension fonctionnelle
-- ☁ ️ plusieurs modèles, y compris Llama, OpenAI Grok Anthropic, etc.
-- 📦 simple et facile à utiliser
+-   🛠 soutenir la connexion discord/ twitter /telegram
+-   👥 soutien aux agents multimodaux
+-   📚 simple à importer des documents et interagir avec les documents
+-   mémoire et stockage des documents accessibles
+-   🚀 haute scalabilité, vous pouvez personnaliser les clients et les comportements pour une extension fonctionnelle
+-   ☁ ️ plusieurs modèles, y compris Llama, OpenAI Grok Anthropic, etc.
+-   📦 simple et facile à utiliser
 
 Que pouvez-vous faire avec Eliza?
 
-- 🤖 le chatbot
-- 🕵 ️ Agents autonomes
-- 📈 processus métier pour automatiser le traitement
-- 🎮 jeux PNJ
+-   🤖 le chatbot
+-   🕵 ️ Agents autonomes
+-   📈 processus métier pour automatiser le traitement
+-   🎮 jeux PNJ
 
 # commencez à utiliser
 
@@ -30,17 +30,16 @@ Que pouvez-vous faire avec Eliza?
 
 ### éditer le fichier.env
 
-- copiez.env.example en.env et remplissez la valeur appropriée
-- modifier l’environnement twitter et entrer votre compte twitter et mot de passe
+-   copiez.env.example en.env et remplissez la valeur appropriée
+-   modifier l’environnement twitter et entrer votre compte twitter et mot de passe
 
 ### modifier les fichiers de rôles
 
-- voir le document ` src/core/defaultCharacter ts ` - vous pouvez le modifier
-- vous pouvez également utiliser `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json" ` et simultanément plusieurs robots.
+-   voir le document `src/core/defaultCharacter ts` - vous pouvez le modifier
+-   vous pouvez également utiliser `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json" ` et simultanément plusieurs robots.
 
 Après avoir terminé la configuration des fichiers de compte et de rôle, lancez votre bot en tapant la ligne de commande suivante:
 
-
 ```
 pnpm i
 pnpm start
@@ -164,9 +163,9 @@ pnpm test:sqljs    # Run tests with SQL.js
 
 Les tests sont écrits en Jest et se trouvent dans le fichier SRC /\*_/_.test.ts. L’environnement de test est configuré comme suit:
 
-- chargement des variables d’environnement de.env.test
-- utilisez un temps d’attente de 2 minutes pour exécuter des tests de longue durée
-- support du module ESM
-- exécuter les tests dans l’ordre (--runInBand)
+-   chargement des variables d’environnement de.env.test
+-   utilisez un temps d’attente de 2 minutes pour exécuter des tests de longue durée
+-   support du module ESM
+-   exécuter les tests dans l’ordre (--runInBand)
 
-Pour créer un nouveau test, ajoutez un fichier.test.ts à côté du code à tester.
+Pour créer un nouveau test, ajoutez un fichier.test.ts à côté du code à tester.

README_JA.md

@@ -4,37 +4,37 @@
 
 ## 機能
 
-- 🛠 Discord、Twitter、Telegramのフル機能コネクタ
-- 👥 マルチエージェントおよびルームサポート
-- 📚 ドキュメントの簡単な取り込みと対話
-- 💾 検索可能なメモリおよびドキュメントストア
-- 🚀 高い拡張性 - 機能を拡張するための独自のアクションとクライアントを作成可能
-- ☁️ Llama、OpenAI、Anthropic、Groqなど、多くのモデルをサポート
-- 📦 すぐに使える！
+-   🛠 Discord、Twitter、Telegramのフル機能コネクタ
+-   👥 マルチエージェントおよびルームサポート
+-   📚 ドキュメントの簡単な取り込みと対話
+-   💾 検索可能なメモリおよびドキュメントストア
+-   🚀 高い拡張性 - 機能を拡張するための独自のアクションとクライアントを作成可能
+-   ☁️ Llama、OpenAI、Anthropic、Groqなど、多くのモデルをサポート
+-   📦 すぐに使える！
 
 ## 何に使えるのか？
 
-- 🤖 チャットボット
-- 🕵️ 自律エージェント
-- 📈 ビジネスプロセスの処理
-- 🎮 ビデオゲームのNPC
+-   🤖 チャットボット
+-   🕵️ 自律エージェント
+-   📈 ビジネスプロセスの処理
+-   🎮 ビデオゲームのNPC
 
 # 始め方
 
 **必須条件:**
 
-- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-- [pnpm](https://pnpm.io/installation)
+-   [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+-   [pnpm](https://pnpm.io/installation)
 
 ### .envファイルの編集
 
-- .env.exampleを.envにコピーし、適切な値を入力
-- TWITTER環境変数を編集して、ボットのユーザー名とパスワードを追加
+-   .env.exampleを.envにコピーし、適切な値を入力
+-   TWITTER環境変数を編集して、ボットのユーザー名とパスワードを追加
 
 ### キャラクターファイルの編集
 
-- `src/core/defaultCharacter.ts`ファイルを確認 - これを変更可能
-- `pnpm start --characters="path/to/your/character.json"`を使用してキャラクターをロードし、複数のボットを同時に実行可能
+-   `src/core/defaultCharacter.ts`ファイルを確認 - これを変更可能
+-   `pnpm start --characters="path/to/your/character.json"`を使用してキャラクターをロードし、複数のボットを同時に実行可能
 
 .envファイルとキャラクターファイルを設定した後、以下のコマンドでボットを起動可能:
 
@@ -166,9 +166,9 @@ pnpm test:sqljs    # SQL.jsでテストを実行
 
 テストはJestを使用して記述されており、`src/**/*.test.ts`ファイルにあります。テスト環境は次のように構成されています:
 
-- `.env.test`から環境変数をロード
-- 長時間実行されるテストのために2分のタイムアウトを使用
-- ESMモジュールをサポート
-- テストを順番に実行 (--runInBand)
+-   `.env.test`から環境変数をロード
+-   長時間実行されるテストのために2分のタイムアウトを使用
+-   ESMモジュールをサポート
+-   テストを順番に実行 (--runInBand)
 
 新しいテストを作成するには、テストするコードの隣に`.test.ts`ファイルを追加します。

README_KOR.md

@@ -9,13 +9,13 @@
 -   📚 높은 유연성: 개발자가 쉽게 데이터를 추가하고, 이를 활용해 다양한 기능을 만들 수 있습니다.
 -   💾 검색 지원: 당신의 데이터와 작업을 쉽게 찾아볼 수 있도록, 검색 기능을 지원합니다.
 -   🚀 높은 확장성: 자신의 동작과 클라이언트를 만들어 기능을 확장할 수 있습니다.
--   ☁️  다양한 AI 모델 지원: local Llama, OpenAI, Anthropic, Groq 등 다양한 AI 모델을 지원합니다
--   📦 즐겁게 개발해 봐요! 
+-   ☁️ 다양한 AI 모델 지원: local Llama, OpenAI, Anthropic, Groq 등 다양한 AI 모델을 지원합니다
+-   📦 즐겁게 개발해 봐요!
 
 ## eliza로 어떤걸 만들 수 있을까요?
 
 -   🤖 챗봇 개발
--   🕵 ️AI가 자율적으로 결과를 만들어줘요! 
+-   🕵 ️AI가 자율적으로 결과를 만들어줘요!
 -   📈 업무처리 자동화
 -   🎮 비디오 게임 NPC
 
@@ -66,7 +66,7 @@ pnpm start
 
 ## 기타 요구 사항
 
-시작시 오류가 발견되면, 아래의 명령어로 Sharp를 설치해보세요:  
+시작시 오류가 발견되면, 아래의 명령어로 Sharp를 설치해보세요:
 
 ```
 pnpm install --include=optional sharp
@@ -141,7 +141,7 @@ npx --no node-llama-cpp source download --gpu cuda
 ### 로컬 실행
 
 다음 중 한가지 옵션을 선택하여 XAI_MODEL 을 추가하세요. [Run with
-Llama](#run-with-llama) - X_SERVER_URL 와 XAI_API_KEY 는 비워둬도 됩니다. 
+Llama](#run-with-llama) - X_SERVER_URL 와 XAI_API_KEY 는 비워둬도 됩니다.
 이 파일을 통해 huggingface 에서 모델이 다운로드 되며, 로컬로 쿼리 됩니다.
 
 # 클라이언트
@@ -169,7 +169,7 @@ pnpm test:sqlite   # Run tests with SQLite
 pnpm test:sqljs    # Run tests with SQL.js
 ```
 
-테스트 결과는 Jest를 통해 작성되며, `src/**/*.test.ts` 파일에서 확인할 수 있습니다. 
+테스트 결과는 Jest를 통해 작성되며, `src/**/*.test.ts` 파일에서 확인할 수 있습니다.
 테스트 환경 구성단계:
 
 -   `.env.test` 에서 환경변수가 불러와집니다.

README_PTBR.md

@@ -22,7 +22,7 @@
 # Começando
 
 **Pré-requisitos (OBRIGATÓRIO):**
-  
+
 -   [Python 2.7+](https://www.python.org/downloads/)
 -   [Node.js 23.1+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
 -   [pnpm](https://pnpm.io/installation)

docs/api/classes/AgentRuntime.md

@@ -464,7 +464,7 @@ Searchable document fragments
 
 #### Defined in
 
-[packages/core/src/runtime.ts:372](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L372)
+[packages/core/src/runtime.ts:368](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L368)
 
 ***
 
@@ -486,7 +486,7 @@ The number of recent messages to be kept in memory.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:394](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L394)
+[packages/core/src/runtime.ts:390](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L390)
 
 ***
 
@@ -512,7 +512,7 @@ The action to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:402](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L402)
+[packages/core/src/runtime.ts:398](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L398)
 
 ***
 
@@ -534,7 +534,7 @@ The evaluator to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:411](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L411)
+[packages/core/src/runtime.ts:407](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L407)
 
 ***
 
@@ -556,7 +556,7 @@ The context provider to register.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:419](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L419)
+[packages/core/src/runtime.ts:415](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L415)
 
 ***
 
@@ -588,7 +588,7 @@ The message to process.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:428](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L428)
+[packages/core/src/runtime.ts:424](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L424)
 
 ***
 
@@ -624,7 +624,7 @@ The results of the evaluation.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:501](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L501)
+[packages/core/src/runtime.ts:497](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L497)
 
 ***
 
@@ -656,7 +656,7 @@ An error if the participant cannot be added.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:571](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L571)
+[packages/core/src/runtime.ts:567](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L567)
 
 ***
 
@@ -692,7 +692,7 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:587](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L587)
+[packages/core/src/runtime.ts:583](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L583)
 
 ***
 
@@ -716,7 +716,7 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L607)
+[packages/core/src/runtime.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L603)
 
 ***
 
@@ -746,7 +746,7 @@ The user name to ensure the existence of.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:618](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L618)
+[packages/core/src/runtime.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L614)
 
 ***
 
@@ -777,7 +777,7 @@ An error if the room cannot be created.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:654](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L654)
+[packages/core/src/runtime.ts:650](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L650)
 
 ***
 
@@ -807,7 +807,7 @@ The state of the agent.
 
 #### Defined in
 
-[packages/core/src/runtime.ts:667](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L667)
+[packages/core/src/runtime.ts:663](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L663)
 
 ***