Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions skills/birdeye-plugin/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

## 0.1.0
- Initial plugin scaffold for OKX Plugin Store.
- Added dual mode runtime support: `apikey`, `x402`, `auto`.
- Added core commands: `price`, `trending`, `overview`, `security`.
- Added x402 endpoint allowlist guard and clear mode/config errors.
Empty file added skills/birdeye-plugin/LICENSE
Empty file.
34 changes: 34 additions & 0 deletions skills/birdeye-plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# birdeye-plugin

Birdeye multi-chain DeFi analytics plugin with dual live access mode:

- `apikey`: standard Birdeye API with `X-API-KEY` (full endpoint coverage in this plugin)
- `x402`: pay-per-request Birdeye API (`/x402`) using Solana USDC (x402-supported subset)
- `auto`: use `apikey` when available, otherwise `x402`

## Runtime Notes

- `apikey` mode can run on lower Node versions.
- `x402` mode requires Node.js 20+.
- If you see `No random values implementation could be found`, switch to Node 20 and retry.

## Requirements

- For `apikey` mode: `BIRDEYE_API_KEY`
- For `x402` mode: `SOLANA_PRIVATE_KEY` (base58 private key), wallet funded with USDC on Solana mainnet

## Commands

- `node runtime/dist/index.js list [--mode apikey|x402]`
- `node runtime/dist/index.js call --endpoint <key> --chain solana --param value ...`
- Backward-compatible aliases:
- `node runtime/dist/index.js price --address <TOKEN> --chain solana`
- `node runtime/dist/index.js trending --chain solana --limit 20`
- `node runtime/dist/index.js overview --address <TOKEN> --chain solana`
- `node runtime/dist/index.js security --address <TOKEN> --chain solana`

## Coverage Policy

- `apikey` mode: full registry defined in runtime endpoint map.
- `x402` mode: restricted to endpoints supported by bd-x402/x402 routes.
- If an endpoint is unavailable in `x402`, switch to `apikey` mode.
29 changes: 29 additions & 0 deletions skills/birdeye-plugin/plugin.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
schema_version: 1
name: birdeye-plugin
version: "0.1.0"
description: "Birdeye multi-chain DeFi analytics plugin with dual mode access: API key and x402 pay-per-request."
author:
name: "Dat Dang"
github: "dangquocdat97"
license: MIT
category: analytics
tags:
- birdeye
- defi
- analytics
- solana
- x402

components:
skill:
dir: skills/birdeye-plugin

build:
lang: node
source_repo: "dangquocdat97/plugin-store"
source_commit: "a147b5c57503e8222d4f2f852d31c24f7f28fe54"
binary_name: "birdeye-plugin-runtime"
main: "dist/index.js"

api_calls:
- public-api.birdeye.so
2 changes: 2 additions & 0 deletions skills/birdeye-plugin/runtime/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
dist/
Loading