docs: update documentation

.devcontainer/devcontainer.json

@@ -10,8 +10,8 @@
     },
     "privileged": true,
     "runArgs": [
-        "-p=3000:3000", // Add port for server api
-        "-p=5173:5173", // Add port for client
+        "-p 3000:3000", // Add port for server api
+        "-p 5173:5173", // Add port for client
         //"--volume=/usr/lib/wsl:/usr/lib/wsl", // uncomment for WSL
         //"--volume=/mnt/wslg:/mnt/wslg", // uncomment for WSL
         "--gpus=all", // ! uncomment for vGPU
@@ -35,4 +35,4 @@
         }
     },
     "features": {}
-}
+}

.env.example

@@ -4,10 +4,12 @@
 
 # Cache Configs
 CACHE_STORE=database # Defaults to database. Other available cache store: redis and filesystem
+CACHE_DIR=./data/cache # Directory to store the cache files if using filesystem cache
 REDIS_URL=           # Redis URL - could be a local redis instance or cloud hosted redis. Also support rediss:// URLs
 PGLITE_DATA_DIR=     #../pgLite/ if selecting a directory   --- or memory:// if selecting in memory
 
-# Eliza Port Config
+# Eliza Server & Port Config
+SERVER_URL=http://localhost
 SERVER_PORT=3000
 
 # Supabase Configuration
@@ -350,6 +352,22 @@ SMALL_LMSTUDIO_MODEL=  # Default: hermes-3-llama-3.1-8b
 MEDIUM_LMSTUDIO_MODEL= # Default: hermes-3-llama-3.1-8b
 LARGE_LMSTUDIO_MODEL=  # Default: hermes-3-llama-3.1-8b
 
+# Secret AI Configuration
+SECRET_AI_API_KEY=            # Secret AI API Key
+SECRET_AI_URL=                # Default: https://ai1.scrtlabs.com:21434
+SMALL_SECRET_AI_MODEL=        # Default: deepseek-r1:70b
+MEDIUM_SECRET_AI_MODEL=       # Default: deepseek-r1:70b
+LARGE_SECRET_AI_MODEL=        # Default: deepseek-r1:70b
+
+# NEAR AI (https://near.ai) Configuration
+NEARAI_API_URL=      # Default: https://api.near.ai/v1
+NEARAI_API_KEY=      # NEAR AI API Key (optional). If you have run `nearai login` with NEAR AI CLI, the API key will be parsed from `~/.nearai/config.json`: https://docs.near.ai/agents/quickstart/
+NEARAI_MODEL=
+SMALL_NEARAI_MODEL=  # Default: fireworks::accounts/fireworks/models/llama-v3p2-3b-instruct
+MEDIUM_NEARAI_MODEL= # Default: fireworks::accounts/fireworks/models/llama-v3p1-70b-instruct
+LARGE_NEARAI_MODEL=  # Default: fireworks::accounts/fireworks/models/llama-v3p1-405b-instruct
+IMAGE_NEARAI_MODEL=   # Default: fireworks::accounts/fireworks/models/playground-v2-5-1024px-aesthetic
+
 # Remaining Provider Configurations
 GOOGLE_GENERATIVE_AI_API_KEY= # Gemini API key
 ALI_BAILIAN_API_KEY=          # Ali Bailian API Key
@@ -374,7 +392,7 @@ COINGECKO_PRO_API_KEY=
 MORALIS_API_KEY=
 
 # EVM
-EVM_PRIVATE_KEY=
+EVM_PRIVATE_KEY=          # Add the "0x" prefix infront of your private key string                  
 EVM_PROVIDER_URL=
 
 # Zilliqa
@@ -421,7 +439,7 @@ ABSTRACT_RPC_URL=https://api.testnet.abs.xyz
 # Starknet Configuration
 STARKNET_ADDRESS=
 STARKNET_PRIVATE_KEY=
-STARKNET_RPC_URL=
+STARKNET_RPC_URL=https://rpc.starknet-testnet.lava.build
 
 # Lens Network Configuration
 LENS_ADDRESS=
@@ -553,7 +571,7 @@ NEAR_WALLET_SECRET_KEY= # NEAR Wallet Secret Key
 NEAR_WALLET_PUBLIC_KEY= # NEAR Wallet Public Key
 NEAR_ADDRESS=
 NEAR_SLIPPAGE=1
-NEAR_RPC_URL=https://rpc.testnet.near.org
+NEAR_RPC_URL=https://near-testnet.lava.build
 NEAR_NETWORK=testnet # or mainnet
 
 # ZKsync Era Configuration
@@ -968,3 +986,16 @@ BUNDLE_EXECUTOR_ADDRESS=          # Address of the bundle executor contract
 DESK_EXCHANGE_PRIVATE_KEY=                  # Required for trading and cancelling orders
 DESK_EXCHANGE_NETWORK=                      # "mainnet" or "testnet
 
+# Compass plugin configuration
+COMPASS_WALLET_PRIVATE_KEY=
+COMPASS_ARBITRUM_RPC_URL=
+COMPASS_ETHEREUM_RPC_URL=
+COMPASS_BASE_RPC_URL=
+
+# d.a.t.a Plugin Configurations
+DATA_API_KEY=           # Your d.a.t.a API key
+DATA_AUTH_TOKEN=       # Your d.a.t.a auth token
+
+# NKN Configuration
+NKN_CLIENT_PRIVATE_KEY=           # Required, NKN client private key
+NKN_CLIENT_ID=                    # Optional, NKN client ID

.github/pull_request_template.md

@@ -78,7 +78,7 @@ None: Automated tests are acceptable.
 ## Deployment instructions
 -->
 
-<!-- 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 -->
+<!-- If you are on Discord, please join https://discord.gg/elizaOS and state your Discord username here for the contributor role and join us in #development-feed -->
 <!--
 ## Discord username
 

.github/workflows/integrationTests.yaml

@@ -14,9 +14,11 @@ jobs:
       OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
       TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
       TURBO_TEAM: ${{ vars.TURBO_TEAM }}
-      TURBO_REMOTE_ONLY: true
+      TURBO_CACHE: remote:rw
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true  # Ensures submodules are checked out
 
       - uses: pnpm/action-setup@v3
         with:
@@ -41,4 +43,4 @@ jobs:
           fi
 
       - name: Run integration tests
-        run: pnpm run integrationTests
+        run: pnpm run integrationTests

.github/workflows/smoke-tests.yml

@@ -14,10 +14,11 @@ jobs:
       OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
       TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
       TURBO_TEAM: ${{ vars.TURBO_TEAM }}
-      TURBO_REMOTE_ONLY: true
+      TURBO_CACHE: remote:rw
     steps:
       - uses: actions/checkout@v4
-
+        with:
+          submodules: true  # Ensures submodules are checked out
       - uses: pnpm/action-setup@v3
         with:
           version: 9.15.0

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "characters"]
+	path = characters
+	url = https://github.com/elizaos/characters

.gitpod.yml

@@ -2,6 +2,9 @@ tasks:
     - name: "init eliza env"
       init: |
           nvm install v23.3.0
-          git fetch --tags
-          git checkout $(git describe --tags --abbrev=0)
-      command: pnpm install && pnpm run build
+          nvm use v23.3.0
+          git clone https://github.com/dforce-network/elizaos-plugin-intenet packages/plugin-intenet
+          pnpm add "@elizaos/core@workspace:*" --filter ./packages/plugin-intenet/
+          pnpm add "@elizaos-plugins/plugin-intenet@workspace:*" --filter ./agent
+          cp .env.example .env
+      command: pnpm install --no-frozen-lockfile && pnpm build

.npmrc

@@ -1,2 +1 @@
-node-linker=hoisted
-frozen-lockfile=true
+frozen-lockfile=true

CHANGELOG.md

@@ -101,7 +101,7 @@
 - feat: add docs for story plugin [\#1672](https://github.com/elizaOS/eliza/pull/1672) ([chandiniv1](https://github.com/chandiniv1))
 - fix: 1668  fix twitter image link [\#1671](https://github.com/elizaOS/eliza/pull/1671) ([nusk0](https://github.com/nusk0))
 - fix: 1634  fix image description service [\#1667](https://github.com/elizaOS/eliza/pull/1667) ([nusk0](https://github.com/nusk0))
-- fix: Seperated imageModelProvider and imageVisionModelProvider for ImageDescriptioServices [\#1664](https://github.com/elizaOS/eliza/pull/1664) ([denizekiz](https://github.com/denizekiz))
+- fix: Separated imageModelProvider and imageVisionModelProvider for ImageDescriptionServices [\#1664](https://github.com/elizaOS/eliza/pull/1664) ([denizekiz](https://github.com/denizekiz))
 - fix: Update Supabase schema.sql [\#1660](https://github.com/elizaOS/eliza/pull/1660) ([0xRider](https://github.com/0xRider))
 - fix: Fix bug in plugin-bootstrap/src/evaluators/facts.ts [\#1648](https://github.com/elizaOS/eliza/pull/1648) ([metakai1](https://github.com/metakai1))
 - Added Hungarian README [\#1645](https://github.com/elizaOS/eliza/pull/1645) ([mdominikd](https://github.com/mdominikd))
@@ -188,7 +188,7 @@
 - pnpm install shows errors [\#1234](https://github.com/elizaOS/eliza/issues/1234)
 - Long tweets fail with error Tweet needs to be a bit shorter \(Code 186\) [\#1178](https://github.com/elizaOS/eliza/issues/1178)
 - Unable to Perform Transfer with plugin-evm Due to Parameter Parsing Error [\#964](https://github.com/elizaOS/eliza/issues/964)
-- I have a twitter premium subscription and MAX\_TWEET\_LENGTH  to 2500 but I can't to post a tweet with more than 280 characteres [\#883](https://github.com/elizaOS/eliza/issues/883)
+- I have a twitter premium subscription and MAX\_TWEET\_LENGTH  to 2500 but I can't to post a tweet with more than 280 characters [\#883](https://github.com/elizaOS/eliza/issues/883)
 - Twitter cookies do not match the docs [\#558](https://github.com/elizaOS/eliza/issues/558)
 
 **Closed issues:**
@@ -234,7 +234,7 @@
 - fix: duplicate twitter post [\#1472](https://github.com/elizaOS/eliza/pull/1472) ([tcm390](https://github.com/tcm390))
 - fix: cleaner interaction prompts in the Twitter plugin [\#1469](https://github.com/elizaOS/eliza/pull/1469) ([todorkolev](https://github.com/todorkolev))
 - fix: cronoszkEVM -\> cronoszkevm [\#1468](https://github.com/elizaOS/eliza/pull/1468) ([shakkernerd](https://github.com/shakkernerd))
-- chore: update defailt character topic test case [\#1466](https://github.com/elizaOS/eliza/pull/1466) ([shakkernerd](https://github.com/shakkernerd))
+- chore: update default character topic test case [\#1466](https://github.com/elizaOS/eliza/pull/1466) ([shakkernerd](https://github.com/shakkernerd))
 - docs: Fixed Incorrect Model Name in API Integration [\#1465](https://github.com/elizaOS/eliza/pull/1465) ([mdqst](https://github.com/mdqst))
 - feat: Adding plugin for Cronos ZKEVM [\#1464](https://github.com/elizaOS/eliza/pull/1464) ([samarth30](https://github.com/samarth30))
 - fix: client-twitter: fix ENABLE\_ACTION\_PROCESSING logic [\#1463](https://github.com/elizaOS/eliza/pull/1463) ([zkvm](https://github.com/zkvm))
@@ -299,7 +299,7 @@
 
 **Fixed bugs:**
 
-- Vector missmatch sqlite \(when trying to use TTS\) [\#1349](https://github.com/elizaOS/eliza/issues/1349)
+- Vector mismatch sqlite \(when trying to use TTS\) [\#1349](https://github.com/elizaOS/eliza/issues/1349)
 - Postgres adapter busted [\#1344](https://github.com/elizaOS/eliza/issues/1344)
 - Why do I have a running Agent on WSL2, but the browser shows don't work? [\#1326](https://github.com/elizaOS/eliza/issues/1326)
 - http proxy error /agents [\#1322](https://github.com/elizaOS/eliza/issues/1322)
@@ -457,7 +457,7 @@
 - fal.ai image generation [\#648](https://github.com/elizaOS/eliza/issues/648)
 - Upgrade to turborepo for monorepo management [\#639](https://github.com/elizaOS/eliza/issues/639)
 - Add a plugin for storing data using the 0G protocol. [\#415](https://github.com/elizaOS/eliza/issues/415)
-- way for bots to have cool down periods \(dynamic tempature adjusts\) & only direct reply setting [\#399](https://github.com/elizaOS/eliza/issues/399)
+- way for bots to have cool down periods \(dynamic temperature adjusts\) & only direct reply setting [\#399](https://github.com/elizaOS/eliza/issues/399)
 - Create an Eliza Trained on Dev Documentation [\#352](https://github.com/elizaOS/eliza/issues/352)
 - Get to a place where we can reliably create release tags [\#317](https://github.com/elizaOS/eliza/issues/317)
 - Managing Divergence Across the Eliza Ecosystem \(Multiple Forks\) [\#305](https://github.com/elizaOS/eliza/issues/305)
@@ -951,7 +951,7 @@
 - feat: starknet portfolio provider [\#595](https://github.com/elizaOS/eliza/pull/595) ([milancermak](https://github.com/milancermak))
 - Download updates [\#594](https://github.com/elizaOS/eliza/pull/594) ([justabot](https://github.com/justabot))
 - feat: update sidebars [\#593](https://github.com/elizaOS/eliza/pull/593) ([madjin](https://github.com/madjin))
-- feat: Adding tests for actions and generation. Skiping test step in defaultCharacters [\#591](https://github.com/elizaOS/eliza/pull/591) ([ai16z-demirix](https://github.com/ai16z-demirix))
+- feat: Adding tests for actions and generation. Skipping test step in defaultCharacters [\#591](https://github.com/elizaOS/eliza/pull/591) ([ai16z-demirix](https://github.com/ai16z-demirix))
 - fix: enable test run in CI for core package [\#590](https://github.com/elizaOS/eliza/pull/590) ([pgoos](https://github.com/pgoos))
 - fix: Shaw/fix zerog [\#589](https://github.com/elizaOS/eliza/pull/589) ([lalalune](https://github.com/lalalune))
 - fix: React Client fixes [\#588](https://github.com/elizaOS/eliza/pull/588) ([lalalune](https://github.com/lalalune))
@@ -965,7 +965,7 @@
 - Add community stream notes for WDYGDTW 2 [\#580](https://github.com/elizaOS/eliza/pull/580) ([YoungPhlo](https://github.com/YoungPhlo))
 - fix: remove postinstall script from plugin-coinbase [\#573](https://github.com/elizaOS/eliza/pull/573) ([bmgalego](https://github.com/bmgalego))
 - fix: add missing documents and knowledge memory managers to runtime interface [\#572](https://github.com/elizaOS/eliza/pull/572) ([bmgalego](https://github.com/bmgalego))
-- fix: remove db adapters depencies from core and remove plugin-node from telegram  [\#571](https://github.com/elizaOS/eliza/pull/571) ([bmgalego](https://github.com/bmgalego))
+- fix: remove db adapters dependencies from core and remove plugin-node from telegram  [\#571](https://github.com/elizaOS/eliza/pull/571) ([bmgalego](https://github.com/bmgalego))
 - feat: implement coinbase mass payments across base/sol/eth/pol/arb [\#569](https://github.com/elizaOS/eliza/pull/569) ([monilpat](https://github.com/monilpat))
 - CS - first api hookups. [\#564](https://github.com/elizaOS/eliza/pull/564) ([justabot](https://github.com/justabot))
 - fix: bump echogarden to fix case sensitive issue [\#561](https://github.com/elizaOS/eliza/pull/561) ([0xFlicker](https://github.com/0xFlicker))
@@ -1060,7 +1060,7 @@
 - chore: add contributor license [\#502](https://github.com/elizaOS/eliza/pull/502) ([awidearray](https://github.com/awidearray))
 - node-v [\#501](https://github.com/elizaOS/eliza/pull/501) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
 - fix: improve embeddings [\#496](https://github.com/elizaOS/eliza/pull/496) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
-- feat: improve type saftey [\#494](https://github.com/elizaOS/eliza/pull/494) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
+- feat: improve type safety [\#494](https://github.com/elizaOS/eliza/pull/494) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
 - fix: added missing packages to tsup configs' externals [\#488](https://github.com/elizaOS/eliza/pull/488) ([massivefermion](https://github.com/massivefermion))
 - fix: fix character path loading [\#487](https://github.com/elizaOS/eliza/pull/487) ([bmgalego](https://github.com/bmgalego))
 - fix: agent loadCharacters file resolver [\#486](https://github.com/elizaOS/eliza/pull/486) ([bmgalego](https://github.com/bmgalego))
@@ -1075,7 +1075,7 @@
 - docs: Update Contributors to bring inline with PR468 [\#470](https://github.com/elizaOS/eliza/pull/470) ([odilitime](https://github.com/odilitime))
 - docs: Add Discord username question [\#468](https://github.com/elizaOS/eliza/pull/468) ([odilitime](https://github.com/odilitime))
 - feat: adds check [\#466](https://github.com/elizaOS/eliza/pull/466) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
-- fix: Fixing failling tests token.test.ts and videoGeneration.test.ts [\#465](https://github.com/elizaOS/eliza/pull/465) ([ai16z-demirix](https://github.com/ai16z-demirix))
+- fix: Fixing failing tests token.test.ts and videoGeneration.test.ts [\#465](https://github.com/elizaOS/eliza/pull/465) ([ai16z-demirix](https://github.com/ai16z-demirix))
 - docs: Create best-practices.md documentation [\#463](https://github.com/elizaOS/eliza/pull/463) ([snobbee](https://github.com/snobbee))
 - feat: create-eliza-app [\#462](https://github.com/elizaOS/eliza/pull/462) ([coffeeorgreentea](https://github.com/coffeeorgreentea))
 - fix: Add missing fuzzystrmatch extension for levenshtein\(\) method to postgresql schema.sql definition [\#460](https://github.com/elizaOS/eliza/pull/460) ([martincik](https://github.com/martincik))
@@ -1238,8 +1238,8 @@
 - feat: readme [\#370](https://github.com/elizaOS/eliza/pull/370) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
 - default set to new standard  post time 90-180 type: post time [\#369](https://github.com/elizaOS/eliza/pull/369) ([o-on-x](https://github.com/o-on-x))
 - post time set in env [\#368](https://github.com/elizaOS/eliza/pull/368) ([o-on-x](https://github.com/o-on-x))
-- feat: Adding unit tests for start - Covering goals, defaultCharacters, relationships, evaulators, posts, database, messages [\#367](https://github.com/elizaOS/eliza/pull/367) ([ai16z-demirix](https://github.com/ai16z-demirix))
-- fix: bug in getRecentMessageInteractions not awating for promisses before formating [\#366](https://github.com/elizaOS/eliza/pull/366) ([bmgalego](https://github.com/bmgalego))
+- feat: Adding unit tests for start - Covering goals, defaultCharacters, relationships, evaluators, posts, database, messages [\#367](https://github.com/elizaOS/eliza/pull/367) ([ai16z-demirix](https://github.com/ai16z-demirix))
+- fix: bug in getRecentMessageInteractions not awating for promises before formatting [\#366](https://github.com/elizaOS/eliza/pull/366) ([bmgalego](https://github.com/bmgalego))
 - feat: \[Issue-185\] Token Provider Tests  [\#365](https://github.com/elizaOS/eliza/pull/365) ([normand1](https://github.com/normand1))
 - feat: update docs with new stream notes [\#364](https://github.com/elizaOS/eliza/pull/364) ([madjin](https://github.com/madjin))
 - update tweet interval to 90-180 mins [\#360](https://github.com/elizaOS/eliza/pull/360) ([oguzserdar](https://github.com/oguzserdar))
@@ -1314,7 +1314,7 @@
 - Implement grok beta [\#216](https://github.com/elizaOS/eliza/pull/216) ([MeDott29](https://github.com/MeDott29))
 - Abstracts Eliza into a Package to enable publishing onto NPM along with plugin system [\#214](https://github.com/elizaOS/eliza/pull/214) ([ponderingdemocritus](https://github.com/ponderingdemocritus))
 - add the template overrides [\#207](https://github.com/elizaOS/eliza/pull/207) ([lalalune](https://github.com/lalalune))
-- Shaw fix characters paths, .ts requirement and missings args [\#204](https://github.com/elizaOS/eliza/pull/204) ([lalalune](https://github.com/lalalune))
+- Shaw fix characters paths, .ts requirement and missing args [\#204](https://github.com/elizaOS/eliza/pull/204) ([lalalune](https://github.com/lalalune))
 - Fix Discord Voice and DMs [\#203](https://github.com/elizaOS/eliza/pull/203) ([lalalune](https://github.com/lalalune))
 - Major documentation updates [\#199](https://github.com/elizaOS/eliza/pull/199) ([madjin](https://github.com/madjin))
 - Add RedPill API Support [\#198](https://github.com/elizaOS/eliza/pull/198) ([HashWarlock](https://github.com/HashWarlock))

Dockerfile

@@ -38,7 +38,7 @@ WORKDIR /app
 COPY . .
 
 # Install dependencies
-RUN pnpm install --no-frozen-lockfile
+RUN pnpm install
 
 # Build the project
 RUN pnpm run build && pnpm prune --prod

MEM7.md

@@ -0,0 +1 @@
+# v7 mem

MEMSCAN.md

@@ -0,0 +1 @@
+# Memory scan test