feat: init plugin-bsc (#2)

Author: pythonberg1997

.env.example

@@ -495,6 +495,12 @@ STARGAZE_ENDPOINT=
 # GenLayer
 GENLAYER_PRIVATE_KEY= # Private key of the GenLayer account to use for the agent in this format (0x0000000000000000000000000000000000000000000000000000000000000000)
 
+# BNB chain
+BNB_PRIVATE_KEY=            # BNB chain private key
+BNB_PUBLIC_KEY=             # BNB-smart-chain public key (address)
+BSC_PROVIDER_URL=           # BNB-smart-chain rpc url
+OPBNB_PROVIDER_URL=         # OPBNB rpc url
+
 ####################################
 #### Misc Plugin Configurations ####
 ####################################

.gitignore

@@ -60,4 +60,4 @@ agent/content
 
 eliza.manifest
 eliza.manifest.sgx
-eliza.sig
+eliza.sig

agent/package.json

@@ -41,6 +41,7 @@
         "@elizaos/plugin-coinmarketcap": "workspace:*",
         "@elizaos/plugin-binance": "workspace:*",
         "@elizaos/plugin-avail": "workspace:*",
+        "@elizaos/plugin-bnb": "workspace:*",
         "@elizaos/plugin-bootstrap": "workspace:*",
         "@elizaos/plugin-cosmos": "workspace:*",
         "@elizaos/plugin-intiface": "workspace:*",

agent/src/index.ts

@@ -53,6 +53,7 @@ import { avalanchePlugin } from "@elizaos/plugin-avalanche";
 import { b2Plugin } from "@elizaos/plugin-b2";
 import { binancePlugin } from "@elizaos/plugin-binance";
 import { birdeyePlugin } from "@elizaos/plugin-birdeye";
+import { bnbPlugin } from "@elizaos/plugin-bnb";
 import {
     advancedTradePlugin,
     coinbaseCommercePlugin,
@@ -940,6 +941,11 @@ export async function createAgent(
             getSecret(character, "RESERVOIR_API_KEY")
                 ? createNFTCollectionsPlugin()
                 : null,
+            getSecret(character, "BNB_PRIVATE_KEY") ||
+            (getSecret(character, "BNB_PUBLIC_KEY") &&
+                getSecret(character, "BNB_PUBLIC_KEY")?.startsWith("0x"))
+                ? bnbPlugin
+                : null,
         ].filter(Boolean),
         providers: [],
         actions: [],

packages/plugin-bnb/README.md

@@ -0,0 +1,141 @@
+# `@ai16z/plugin-bnb`
+
+This plugin enables interaction with the BNB Chain ecosystem, providing support for BNB Smart Chain, opBNB, and BNB Greenfield networks.
+
+---
+
+## Configuration
+
+### Default Setup
+
+By default, **plugin-bnb** is not enabled. To use it, simply add your private key and public key to the `.env` file:
+
+```env
+BNB_PRIVATE_KEY=your-private-key-here
+BNB_PUBLIC_KEY=your-public-key-here
+```
+
+### Custom RPC URLs
+
+By default, the RPC URL is inferred from the `viem/chains` config. To use custom RPC URLs, add the following to your `.env` file:
+
+```env
+BSC_PROVIDER_URL=https://your-custom-bsc-rpc-url
+OPBNB_PROVIDER_URL=https://your-custom-opbnb-rpc-url
+```
+
+## Provider
+
+The **Wallet Provider** initializes with BSC as the default. It:
+
+- Provides the **context** of the currently connected address and its balance.
+- Creates **Public** and **Wallet clients** to interact with the supported chains.
+
+---
+
+## Actions
+
+### Get Balance
+
+Get the balance of an address on BSC. Just specify the:
+
+- **Chain**
+- **Address**
+- **Token**
+
+**Example usage:**
+
+```bash
+Get the USDC balance of 0x1234567890 on BSC.
+```
+
+### Transfer
+
+Transfer tokens from one address to another on BSC/opBNB. Just specify the:
+
+- **Chain**
+- **Token**
+- **Amount**
+- **Recipient Address**
+- **Data**(Optional)
+
+**Example usage:**
+
+```bash
+Transfer 1 BNB to 0xRecipient on BSC.
+```
+
+### Swap
+
+Swap tokens from one address to another on BSC. Just specify the:
+
+- **Input Token**
+- **Output Token**
+- **Amount**
+- **Chain**
+- **Slippage**(Optional)
+
+**Example usage:**
+
+```bash
+Swap 1 BNB to USDC on BSC.
+```
+
+### Bridge
+
+Bridge tokens from one chain to another on BSC/opBNB. Just specify the:
+
+- **From Chain**
+- **To Chain**
+- **From Token**
+- **To Token**
+- **Amount**
+- **Recipient Address**(Optional)
+
+**Example usage:**
+
+```bash
+Bridge 1 BNB from BSC to opBNB.
+```
+
+### Stake
+
+Perform staking operations on BSC through [Lista Dao](https://lista.org/liquid-staking/BNB). User will receive sliBNB(0xB0b84D294e0C75A6abe60171b70edEb2EFd14A1B) as staking credit. Just specify the:
+
+- **Action**
+- **Amount**
+
+**Example usage:**
+
+```bash
+Deposit 1 BNB to Lista Dao.
+```
+
+### Faucet
+
+Request testnet tokens from the faucet. You could request any of the supported tokens(BNB, BTC, BUSD, DAI, ETH, USDC). Just specify the:
+
+- **Token**(Optional)
+- **Recipient Address**
+
+The recipient address must maintain a minimum balance of 0.002 BNB on BSC Mainnet to qualify.
+
+**Example usage:**
+
+```bash
+Get some testnet USDC from the faucet.
+```
+
+---
+
+## Contribution
+
+The plugin contains tests. Whether you're using **TDD** or not, please make sure to run the tests before submitting a PR.
+
+### Running Tests
+
+Navigate to the `plugin-bnb` directory and run:
+
+```bash
+pnpm test
+```

packages/plugin-bnb/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@elizaos/plugin-bnb",
+    "version": "0.1.0-alpha.1",
+    "main": "dist/index.js",
+    "type": "module",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "@lifi/data-types": "5.15.5",
+        "@lifi/sdk": "3.4.1",
+        "@lifi/types": "16.3.0",
+        "@web3-name-sdk/core": "^0.3.2",
+        "@openzeppelin/contracts": "^5.1.0",
+        "@types/node": "^22.10.5",
+        "solc": "^0.8.28",
+        "tsup": "8.3.5",
+        "viem": "2.21.53",
+        "ws": "^8.18.0"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch",
+        "test": "vitest run",
+        "lint": "eslint --fix  --cache ."
+    },
+    "peerDependencies": {
+        "whatwg-url": "7.1.0"
+    }
+}