feat: [plugin-sui] programmable transaction block generation action
Relates to:
Risks
- no risks
Background
What does this PR do?
Adds a Programmable Transaction Block Builder Action to Sui Plugin
What kind of change is this?
Features (non-breaking change which adds functionality)
Documentation changes needed?
Testing
Where should a reviewer start?
cdintopackages/plugin-sui- run
pnpm i
Detailed testing steps
- Replace Default Character here:
// Replace the existing character initialization with custom setup
const character = defaultCharacter;
character.plugins = [suiPlugin];
character.modelProvider = ModelProviderName.OPENAI;
let characters = [character];
Discord username
@em.eieiron
POW
not sure what's up with the smoke-test
must've been the differences in pnpm-lock.yaml. a rebase seems to have cleaned it.
[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.
🔧 eslint
If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.
packages/plugin-sui/src/actions/ptb.ts
Oops! Something went wrong! :(
ESLint: 9.18.0
ESLint couldn't find an eslint.config.(js|mjs|cjs) file.
From ESLint v9.0.0, the default configuration file is now eslint.config.js. If you are using a .eslintrc.* file, please follow the migration guide to update your configuration file to the new format:
https://eslint.org/docs/latest/use/configure/migration-guide
If you still have problems after following the migration guide, please stop by https://eslint.org/chat/help to chat with the team.
📝 Walkthrough
Walkthrough
A new TypeScript module for Sui blockchain interactions has been added, introducing a Process Transaction Block (PTB) builder action. The implementation uses Zod schemas to validate complex transaction structures, including object transfers, coin operations, and move calls. The action provides robust input validation, error handling, and a structured approach to composing blockchain transactions.
Changes
| File | Change Summary |
|---|---|
packages/plugin-sui/src/actions/ptb.ts |
- Added Zod schemas for PTB commands - Created PTBContent interface- Implemented validation and handler functions for PTB building |
packages/plugin-sui/src/index.ts |
- Added buildPTB action to suiPlugin.actions array |
Finishing Touches
- [ ] 📝 Generate Docstrings (Beta)
🪧 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.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 generate unit testing code.@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.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Hello,
We are changing our plugin development strategy to be more scalable. We have moved the plugins out into their own repos and we're looking for people to either maintain those or own them on their own Github.
Please make your code changes to this repo: https://github.com/elizaos-plugins/plugin-sui
If you'd like to be a maintainer, file an issue in the plugin repo and join our Discord https://discord.gg/elizaos to coordinate.
If you'd like to control the plugin on your own Github, please add an issue to the plugin repo pointing to your repo, and add a modification to the registry. Submit a PR to edit the registry here: https://github.com/elizaos-plugins/registry
Closing this PR for now. Let us know if you have any questions.