Merge branch 'develop' into feature/squid-bridge

elizaOS · Jan 2, 2025 · 962077b · 962077b
2 parents ba4e8fd + 0d80c57
commit 962077b
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 250 deletions.
diff --git a/packages/plugin-story/README.md → packages/plugin-story/README.MD b/packages/plugin-story/README.md → packages/plugin-story/README.MD
@@ -5,6 +5,7 @@ The Story Protocol plugin enables interaction with Story Protocol's IP managemen
 ## Overview
 
 This plugin provides functionality to:
+
 - Register IP assets on Story Protocol
 - License IP assets
 - Attach license terms to IP assets
@@ -14,7 +15,7 @@ This plugin provides functionality to:
 ## Installation
 
 ```bash
-npm install @elizaos/plugin-story
+pnpm install @elizaos/plugin-story
 ```
 
 ## Configuration
@@ -36,8 +37,8 @@ Import and register the plugin in your Eliza configuration:
 import { storyPlugin } from "@elizaos/plugin-story";
 
 export default {
-  plugins: [storyPlugin],
-  // ... other configuration
+    plugins: [storyPlugin],
+    // ... other configuration
 };
 ```
 
@@ -49,8 +50,8 @@ Register a new IP asset on Story Protocol:
 
 ```typescript
 // Example conversation
-User: "I want to register my IP titled 'My Story' with the description 'An epic tale'"
-Assistant: "I'll help you register your IP on Story Protocol..."
+User: "I want to register my IP titled 'My Story' with the description 'An epic tale'";
+Assistant: "I'll help you register your IP on Story Protocol...";
 ```
 
 ### License IP
@@ -59,8 +60,8 @@ License an existing IP asset:
 
 ```typescript
 // Example conversation
-User: "I want to license IP Asset 0x1234...5678 with license terms ID 1"
-Assistant: "I'll help you license that IP asset..."
+User: "I want to license IP Asset 0x1234...5678 with license terms ID 1";
+Assistant: "I'll help you license that IP asset...";
 ```
 
 ### Attach Terms
@@ -69,8 +70,8 @@ Attach license terms to an IP asset:
 
 ```typescript
 // Example conversation
-User: "I want to attach commercial license terms with 10% revenue share to IP 0x1234...5678"
-Assistant: "I'll help you attach those license terms..."
+User: "I want to attach commercial license terms with 10% revenue share to IP 0x1234...5678";
+Assistant: "I'll help you attach those license terms...";
 ```
 
 ### Get IP Details
@@ -79,8 +80,8 @@ Query details about an IP asset:
 
 ```typescript
 // Example conversation
-User: "Get details for IP Asset 0x1234...5678"
-Assistant: "Here are the details for that IP asset..."
+User: "Get details for IP Asset 0x1234...5678";
+Assistant: "Here are the details for that IP asset...";
 ```
 
 ### Get Available Licenses
@@ -89,8 +90,8 @@ Query available licenses for an IP asset:
 
 ```typescript
 // Example conversation
-User: "What licenses are available for IP Asset 0x1234...5678?"
-Assistant: "Here are the available licenses..."
+User: "What licenses are available for IP Asset 0x1234...5678?";
+Assistant: "Here are the available licenses...";
 ```
 
 ## API Reference
@@ -112,13 +113,13 @@ Assistant: "Here are the available licenses..."
 ### Building
 
 ```bash
-npm run build
+pnpm run build
 ```
 
 ### Testing
 
 ```bash
-npm run test
+pnpm run test
 ```
 
 ## Dependencies
@@ -133,68 +134,75 @@ npm run test
 The following features and improvements are planned for future releases:
 
 1. **IP Management**
-   - Batch IP registration
-   - Advanced metadata management
-   - IP relationship mapping
-   - Automated IP verification
-   - Collection management
-   - IP analytics dashboard
+
+    - Batch IP registration
+    - Advanced metadata management
+    - IP relationship mapping
+    - Automated IP verification
+    - Collection management
+    - IP analytics dashboard
 
 2. **Licensing Features**
-   - Custom license templates
-   - License negotiation tools
-   - Automated royalty distribution
-   - Usage tracking system
-   - License violation detection
-   - Bulk licensing tools
+
+    - Custom license templates
+    - License negotiation tools
+    - Automated royalty distribution
+    - Usage tracking system
+    - License violation detection
+    - Bulk licensing tools
 
 3. **Rights Management**
-   - Advanced permission systems
-   - Rights transfer automation
-   - Usage rights tracking
-   - Derivative works management
-   - Rights verification tools
-   - Dispute resolution system
+
+    - Advanced permission systems
+    - Rights transfer automation
+    - Usage rights tracking
+    - Derivative works management
+    - Rights verification tools
+    - Dispute resolution system
 
 4. **Smart Contract Integration**
-   - Contract deployment templates
-   - Automated verification
-   - Contract upgrade system
-   - Security analysis tools
-   - Gas optimization
-   - Multi-signature support
+
+    - Contract deployment templates
+    - Automated verification
+    - Contract upgrade system
+    - Security analysis tools
+    - Gas optimization
+    - Multi-signature support
 
 5. **Content Management**
-   - Media file handling
-   - Content versioning
-   - Distribution tracking
-   - Content authentication
-   - Storage optimization
-   - Format conversion tools
+
+    - Media file handling
+    - Content versioning
+    - Distribution tracking
+    - Content authentication
+    - Storage optimization
+    - Format conversion tools
 
 6. **Revenue Management**
-   - Automated payments
-   - Revenue sharing tools
-   - Payment tracking
-   - Financial reporting
-   - Tax documentation
-   - Audit trail system
+
+    - Automated payments
+    - Revenue sharing tools
+    - Payment tracking
+    - Financial reporting
+    - Tax documentation
+    - Audit trail system
 
 7. **Developer Tools**
-   - Enhanced SDK features
-   - Testing framework
-   - Documentation generator
-   - CLI improvements
-   - Integration templates
-   - Performance monitoring
+
+    - Enhanced SDK features
+    - Testing framework
+    - Documentation generator
+    - CLI improvements
+    - Integration templates
+    - Performance monitoring
 
 8. **Analytics and Reporting**
-   - Usage statistics
-   - Revenue analytics
-   - License tracking
-   - Performance metrics
-   - Custom reporting
-   - Market analysis tools
+    - Usage statistics
+    - Revenue analytics
+    - License tracking
+    - Performance metrics
+    - Custom reporting
+    - Market analysis tools
 
 We welcome community feedback and contributions to help prioritize these enhancements.
 
@@ -212,12 +220,14 @@ This plugin integrates with and builds upon several key technologies:
 - [viem](https://www.npmjs.com/package/viem): Ethereum interaction library
 
 Special thanks to:
+
 - The Story Protocol team for developing the IP management platform
 - The Story Protocol Developer community
 - The Pinata team for IPFS infrastructure
 - The Eliza community for their contributions and feedback
 
 For more information about Story Protocol capabilities:
+
 - [Story Protocol Documentation](https://docs.story.xyz/)
 - [Story Protocol Dashboard](https://app.story.xyz/)
 - [Story Protocol Blog](https://www.story.xyz/blog)