docs: Update README with comprehensive documentation

[ChristopherTrimboli]

This PR updates the README.md with comprehensive documentation including:

• Proper installation instructions with bun
• Complete list of environment variables
• Usage examples for all actions
• Feature descriptions
• Development instructions

Generated by the plugins-automation script.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-readme-1753238612692

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cursor]

Bug: Plugin Initialization Prematurely Completes

The solanaPlugin.init function prematurely resolves its internal Promise before completing its asynchronous setup (waiting for the TRADER_CHAIN service and registering the chain). This causes the init function to complete prematurely, leading to potential race conditions or incomplete plugin initialization.

src/index.ts#L17-L39

plugin-solana/src/index.ts

Lines 17 to 39 in 43423f1

	new Promise<void>(async (resolve) => {
	resolve();
	const asking = 'solana';
	const serviceType = 'TRADER_CHAIN';
	let traderChainService = runtime.getService(serviceType) as any;
	while (!traderChainService) {
	console.log(asking, 'waiting for', serviceType, 'service...');
	traderChainService = runtime.getService(serviceType) as any;
	if (!traderChainService) {
	await new Promise((waitResolve) => setTimeout(waitResolve, 1000));
	} else {
	console.log(asking, 'Acquired', serviceType, 'service...');
	}
	}
	const me = {
	name: 'Solana services',
	};
	traderChainService.registerChain(me);
	console.log('solana init done');
	});

Fix in Cursor • Fix in Web

---

Bug: Async Initialization Causes Undefined PublicKey

A race condition exists in the SolanaService constructor where this.publicKey is initialized asynchronously. This allows methods like updateWalletData() to be called before this.publicKey is set. When this.publicKey is undefined, updateWalletData() returns an empty object {}, which violates its Promise<WalletPortfolio> return type. The WalletPortfolio interface requires totalUsd: string and items: Array<Item>, leading to runtime errors when consumers attempt to access these missing properties.

src/service.ts#L181-L188

plugin-solana/src/service.ts

Lines 181 to 188 in 43423f1

	if (!this.publicKey) {
	// can't be warn if we fire every start up
	// maybe we just get the pubkey here proper
	// or fall back to SOLANA_PUBLIC_KEY
	logger.log('solana::updateWalletData - no Public Key yet');
	return {};
	}

src/service.ts#L42-L62

plugin-solana/src/service.ts

Lines 42 to 62 in 43423f1

	*/
	constructor(protected runtime: IAgentRuntime) {
	super();
	this.exchangeRegistry = {};
	const connection = new Connection(
	runtime.getSetting('SOLANA_RPC_URL') || PROVIDER_CONFIG.DEFAULT_RPC
	);
	this.connection = connection;
	// Initialize publicKey using getWalletKey
	getWalletKey(runtime, false)
	.then(({ publicKey }) => {
	if (!publicKey) {
	throw new Error('Failed to initialize public key');
	}
	this.publicKey = publicKey;
	})
	.catch((error) => {
	logger.error('Error initializing public key:', error);
	});
	this.subscriptions = new Map();
	}

Fix in Cursor • Fix in Web

---

Bug: Direct Environment Access Bypasses Configuration

The SOL_ADDRESS is directly accessed via process.env.SOL_ADDRESS in swapToken and executeSwap functions. This bypasses the runtime configuration system (runtime.getSetting) and could lead to failures if the environment variable is not set or differs from the intended runtime setting.

src/actions/swap.ts#L65-L66

plugin-solana/src/actions/swap.ts

Lines 65 to 66 in 43423f1

	const decimals =
	inputTokenCA === process.env.SOL_ADDRESS

src/actions/swap.ts#L283-L287

plugin-solana/src/actions/swap.ts

Lines 283 to 287 in 43423f1

	if (response.inputTokenSymbol?.toUpperCase() === 'SOL') {
	response.inputTokenCA = process.env.SOL_ADDRESS;
	}
	if (response.outputTokenSymbol?.toUpperCase() === 'SOL') {
	response.outputTokenCA = process.env.SOL_ADDRESS;

Fix in Cursor • Fix in Web

---

Was this report helpful? Give feedback by reacting with 👍 or 👎