Merge branch 'develop' into feature/add-gitbook-provider

Author: azep-ninja

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[discord server](https://discord.gg/ai16z).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

packages/client-twitter/src/utils.ts

@@ -247,7 +247,7 @@ export async function sendTweet(
             sentTweets.push(finalTweet);
             previousTweetId = finalTweet.id;
         } else {
-            console.error("Error sending chunk", chunk, "repsonse:", body);
+            console.error("Error sending chunk", chunk, "response:", body);
         }
 
         // Wait a bit between tweets to avoid rate limiting issues

packages/plugin-story/src/actions/attachTerms.ts

@@ -4,9 +4,9 @@ import {
     generateObjectDeprecated,
     HandlerCallback,
     ModelClass,
-    type IAgentRuntime,
-    type Memory,
-    type State,
+    IAgentRuntime,
+    Memory,
+    State,
 } from "@elizaos/core";
 import { WalletProvider } from "../providers/wallet";
 import { attachTermsTemplate } from "../templates";

packages/plugin-story/src/actions/getAvailableLicenses.ts

@@ -4,9 +4,9 @@ import {
     generateObjectDeprecated,
     HandlerCallback,
     ModelClass,
-    type IAgentRuntime,
-    type Memory,
-    type State,
+    IAgentRuntime,
+    Memory,
+    State,
 } from "@elizaos/core";
 import { getAvailableLicensesTemplate, licenseIPTemplate } from "../templates";
 import { Address } from "viem";

packages/plugin-story/src/actions/getIPDetails.ts

@@ -4,9 +4,9 @@ import {
     generateObjectDeprecated,
     HandlerCallback,
     ModelClass,
-    type IAgentRuntime,
-    type Memory,
-    type State,
+    IAgentRuntime,
+    Memory,
+    State,
 } from "@elizaos/core";
 import { getIPDetailsTemplate } from "../templates";
 import { Address } from "viem";

packages/plugin-story/src/actions/licenseIP.ts

@@ -4,9 +4,9 @@ import {
     generateObjectDeprecated,
     HandlerCallback,
     ModelClass,
-    type IAgentRuntime,
-    type Memory,
-    type State,
+    IAgentRuntime,
+    Memory,
+    State,
 } from "@elizaos/core";
 import { WalletProvider } from "../providers/wallet";
 import { licenseIPTemplate } from "../templates";

packages/plugin-story/src/actions/registerIP.ts

@@ -4,9 +4,9 @@ import {
     generateObjectDeprecated,
     HandlerCallback,
     ModelClass,
-    type IAgentRuntime,
-    type Memory,
-    type State,
+    IAgentRuntime,
+    Memory,
+    State,
 } from "@elizaos/core";
 import pinataSDK from "@pinata/sdk";
 import { RegisterIpResponse } from "@story-protocol/core-sdk";

packages/plugin-story/src/index.ts

@@ -6,7 +6,7 @@ export * from "./actions/getIPDetails";
 export * from "./providers/wallet";
 export * from "./types";
 
-import type { Plugin } from "@elizaos/core";
+import { Plugin } from "@elizaos/core";
 import { storyWalletProvider } from "./providers/wallet";
 import { registerIPAction } from "./actions/registerIP";
 import { licenseIPAction } from "./actions/licenseIP";

packages/plugin-story/src/providers/wallet.ts

@@ -1,4 +1,4 @@
-import type { IAgentRuntime, Provider, Memory, State } from "@elizaos/core";
+import { IAgentRuntime, Provider, Memory, State } from "@elizaos/core";
 import {
     createPublicClient,
     createWalletClient,

packages/plugin-ton/Readme.md

@@ -0,0 +1,124 @@
+# Plugin TON
+
+A plugin for handling TON (Telegram Open Network) blockchain operations, such as wallet management and transfers.
+
+## Overview and Purpose
+
+The Plugin TON provides a streamlined interface to interact with the TON blockchain. It simplifies wallet management and facilitates secure, efficient transfers while maintaining compatibility with TypeScript and modern JavaScript development practices.
+
+## Installation
+
+Install the plugin using npm:
+
+```bash
+npm install plugin-ton
+```
+
+## Configuration Requirements
+
+Ensure your environment is set up with the necessary configuration files and environment variables. Update the `src/enviroment.ts` file or set environment variables directly for sensitive information.
+
+### Environment Variables
+
+| Variable Name            | Description                           |
+| ------------------------ | ------------------------------------- |
+| `TON_API_ENDPOINT`       | API endpoint for interacting with TON |
+| `TON_WALLET_PRIVATE_KEY` | Private key for wallet operations     |
+
+## Usage Examples
+
+### Importing the Plugin
+
+```typescript
+import { WalletProvider, TransferAction } from 'plugin-ton';
+
+// Initialize wallet provider
+const wallet = new WalletProvider('YOUR_PRIVATE_KEY');
+
+// Fetch wallet balance
+const balance = await wallet.getBalance();
+console.log('Wallet Balance:', balance);
+
+// Transfer TON coins
+const transfer = new TransferAction(wallet);
+await transfer.execute({
+  to: 'RECIPIENT_ADDRESS',
+  amount: 10,
+});
+console.log('Transfer successful');
+```
+
+## API Reference
+
+### WalletProvider
+
+#### Methods:
+
+- `constructor(privateKey: string)` - Initializes the wallet with a private key.
+- `getBalance(): Promise<number>` - Retrieves the wallet balance.
+
+### TransferAction
+
+#### Methods:
+
+- `constructor(wallet: WalletProvider)` - Initializes the transfer action.
+- `execute({ to: string, amount: number }): Promise<void>` - Executes a transfer of TON coins.
+
+## Common Issues/Troubleshooting
+
+### Issue: Balance Fetching Failure
+
+- **Cause**: Incorrect API endpoint or private key.
+- **Solution**: Verify `TON_API_ENDPOINT` and private key in your configuration.
+
+### Issue: Transfer Fails
+
+- **Cause**: Insufficient balance or invalid recipient address.
+- **Solution**: Ensure sufficient funds and a valid recipient address.
+
+## Additional Documentation
+
+### Examples Folder Documentation
+
+The examples folder includes sample scripts demonstrating wallet initialization, balance checking, and transfers. Use these as a starting point for your integration.
+
+### Testing Guide Expansion
+
+Run tests using the following command:
+
+```bash
+npm test
+```
+
+The `src/tests/wallet.test.ts` file provides unit tests for wallet functionality. Add tests for additional features as needed.
+
+### Plugin Development Guide
+
+1. Clone the repository.
+2. Run `npm install` to install dependencies.
+3. Use `tsup` for building the project: `npm run build`.
+4. Add new features in the `src` directory.
+
+### Security Best Practices
+
+- **Key Management**: Use environment variables for sensitive information like private keys.
+- **Testing**: Validate all inputs to prevent injection attacks.
+- **Dependencies**: Regularly update dependencies to patch vulnerabilities.
+
+### Performance Optimization Guide
+
+- Use efficient data structures for large transactions.
+- Avoid unnecessary API calls by caching frequent responses.
+- Use async/await for optimal asynchronous operations.
+
+## Contributing
+
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b feature/amazing-feature`).
+3. Commit your changes (`git commit -m 'Add some amazing feature'`).
+4. Push to the branch (`git push origin feature/amazing-feature`).
+5. Open a Pull Request.
+
+## License
+
+MIT