-
Notifications
You must be signed in to change notification settings - Fork 13
Community wallets modules page #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
raigal-r
wants to merge
25
commits into
tetherto:main
Choose a base branch
from
raigal-r:dev/new-wallet
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
937fc2f
new wallet guide draft
raigal-r becaace
protocol new guide
raigal-r 4e451cf
added at summary
raigal-r b0ec9b3
Fixed YALM error
raigal-r e710eda
Fixed YALM error
raigal-r 2cc3ecf
Fixed summary
raigal-r 2a5e8d1
Fixed summary
raigal-r 6beb2a5
Fixed summary
raigal-r 44e044a
Fixed YALM error
raigal-r 7285546
updated wallet-module-template
raigal-r 42799bd
updated summary
raigal-r b186e04
added READMEs and structure
raigal-r cf7a298
some changes
raigal-r 8afc5ab
revised the wallet section
raigal-r f1d2528
removed unused folders
raigal-r d0fdd55
Update wdk-wallet-template.md
gatteo 7bc33f7
first draft protocols template
raigal-r 3c2bf54
Merge branch 'dev/new-wallet' of https://github.com/raigal-r/wdk-docs…
raigal-r 5b9b625
changed the summary structures, fixed comments
raigal-r 5c0d66f
updated version of the wallet page
raigal-r 43fc1be
link fix from wallet template guide
raigal-r 8ac7daf
link fix from wallet template guide
raigal-r 41a2674
removed number bullets from wallet template
raigal-r 37da88f
docs for protocol templates updated
raigal-r 3177740
fixed small erros bc templates changes
raigal-r File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| title: Community Modules | ||
| layout: | ||
| width: default | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: true | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: false | ||
| metadata: | ||
| visible: false | ||
| --- | ||
|
|
||
| # Community Modules | ||
|
|
||
| This section lists wallet and protocol modules created by the community. | ||
|
|
||
| - These modules are **not official** and **not maintained by the WDK or Tether team**. | ||
| - They are built and supported by the community to help others add new features or connect to more ecosystems. | ||
|
|
||
| ## Why Community Modules? | ||
|
|
||
| - Share modules that solve specific problems | ||
| - Connect your wallet to more ecosystems | ||
| - Learn from code made by other users | ||
|
|
||
| ## Listing a Module | ||
|
|
||
| To add your module here: | ||
| 1. Make sure your code is public and has a simple README. | ||
| 2. Open an issue or pull request to suggest your module be listed. | ||
| 3. Include: name, short description, maintainer/contact, and link to repository. | ||
|
|
||
| The WDK team will review and add new modules at their discretion. | ||
|
|
||
| <!-- ## Community Modules List --> | ||
|
|
||
| <!-- Add community modules below --> | ||
|
|
||
| <!-- - _(Example: [community-wallet-example](https://github.com/example/community-wallet-example) — wallet for ExampleChain, by @example)_ --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| --- | ||
| title: Create custom SDK modules | ||
| layout: | ||
| width: default | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: true | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: false | ||
| metadata: | ||
| visible: false | ||
| --- | ||
|
|
||
| # WDK Modules Template | ||
|
|
||
| Build your own plug-in wallet and protocol modules (bridge, swap, lending, and more) that work seamlessly with the WDK ecosystem. Start with these ready-made templates for fast, robust, and standards-compliant integration. | ||
|
|
||
| ## Available Templates | ||
|
|
||
| - [Wallet Module Template Guide](./wdk-wallet-template.md) | ||
| - [Protocol Module Template Guide](./wdk-protocol-template.md) | ||
|
|
||
| ## Official Inclusion | ||
|
|
||
| If you want your module (wallet or protocol) to be considered for official listing in the WDK ecosystem, please follow these requirements: | ||
|
|
||
| ### Package and Code | ||
| - Use correct naming: `@wdk/wallet-<feature>` or `@wdk/protocol-<feature>` | ||
| - Follow monorepo structure and naming conventions (kebab-case files, PascalCase types) | ||
| - Export only from `index.js`; keep helpers internal to `src/` | ||
| - Implement all WDK-required public methods and API for the module type (wallet or protocol)—conform to official interfaces | ||
| - Avoid deep/unsafe dependencies; keep dependencies minimal and audited | ||
| - All code must run in bare/portable environments by default | ||
|
|
||
| ### Documentation, Testing, and Versioning | ||
| - Include clear install, config, usage, and API docs in `README.md` | ||
| - Publish an up-to-date `CHANGELOG.md` with semver releases | ||
| - Include basic tests for every public method, integration tests if relevant, and a CI pipeline for linting and type checks | ||
| - Use semantic versioning for releases (major.minor.patch) | ||
|
|
||
| ### Security & Maintenance | ||
| - No unsafe/unreviewed dependencies | ||
| - Document all known edge cases, limitations, and security notes | ||
| - List maintainer(s) and provide contact info for ongoing support | ||
|
|
||
| ### Important Notes | ||
| {% hint style="warning" %} | ||
| Bare compatibility is required for official modules. If something does not run in bare, document it and coordinate with the WDK team for an agreed plan before requesting official inclusion. | ||
| {% endhint %} | ||
|
|
||
| ### Inclusion Checklist | ||
| - [ ] Correct naming and file structure | ||
| - [ ] Minimal, bare-compatible dependencies | ||
| - [ ] All required methods implemented & tested | ||
| - [ ] Docs and tests present | ||
| - [ ] Clear maintainer contact | ||
|
|
||
| **To propose for official status:** | ||
| Open a GitHub issue or PR and provide: | ||
| - The module repository | ||
| - Short overview, documentation, and config | ||
| - Tests and usage example | ||
| - Maintainer contact info | ||
| - Security and dependency notes if relevant | ||
|
|
||
| A WDK team member will review your submission. Meeting all requirements does not guarantee inclusion; acceptance is at the team's discretion. | ||
|
|
||
| ## How to Use | ||
|
|
||
| 1. Read the guide for the module type you need | ||
| 2. Follow the step-by-step instructions to copy and change the template | ||
| 3. Implement and include the correct configuration for your desired wallet/ecosyste/network | ||
| 4. Ensure all public methods use the WDK interface and are consistent in naming, parameters, and expected behavior | ||
| 5. Test your changes meet all basic requirements and pass the example workflows | ||
| 6. For official listing, review the inclusion checklist in the guide | ||
|
|
||
| ## Our Oficial Modules | ||
|
|
||
| ### Wallet Modules | ||
|
|
||
| Explore the comments in the sample code for implementation tips. For real-world reference implementations, check out the official WDK module repositories: | ||
|
|
||
| - [wdk-wallet](https://github.com/tetherto/wdk-wallet) | ||
| - [wdk-wallet-btc](https://github.com/tetherto/wdk-wallet-btc) | ||
| - [wdk-wallet-spark](https://github.com/tetherto/wdk-wallet-spark) | ||
| - [wdk-wallet-evm](https://github.com/tetherto/wdk-wallet-evm) | ||
| - [wdk-wallet-evm-erc-4337](https://github.com/tetherto/wdk-wallet-evm-erc-4337) | ||
| - [wdk-wallet-tron](https://github.com/tetherto/wdk-wallet-tron) | ||
| - [wdk-wallet-tron-gasfree](https://github.com/tetherto/wdk-wallet-tron-gasfree) | ||
| - [wdk-wallet-ton](https://github.com/tetherto/wdk-wallet-ton) | ||
| - [wdk-wallet-ton-gasless](https://github.com/tetherto/wdk-wallet-ton-gasless) | ||
| - [wdk-wallet-solana](https://github.com/tetherto/wdk-wallet-solana) | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link is broken here. Also please check the copy, sounds a bit strange, permissionless means another thing.
We can simplify it and just point to the correct guide