Skip to content
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

discussion: try refactoring examples/rgbpp/xudt/launch into a simpler single-step test #247

Open
2 tasks
Tracked by #47
Flouse opened this issue Jul 3, 2024 · 0 comments
Open
2 tasks
Tracked by #47
Labels
documentation Improvements or additions to documentation enhancement New feature or request example P-Medium

Comments

@Flouse
Copy link
Contributor

Flouse commented Jul 3, 2024

Some developers have encountered issues when launching RGB++ assets on Bitcoin

To address this issue, I suggests exploring the possibility of restructuring the testing process into a simpler, single-step test, rather than the current multi-step approach.

The goal is to make the testing process more streamlined and efficient for new developers, reducing the complexity and potential for issues during the launch of RGB++ assets on the Bitcoin network.

Related Thoughts about Streamlined Developer Experience

  • Providing default access tokens for Testnet3 and Signet can reduce friction and improve the developer experience, as they can quickly get started with the SDK examples without the need to get an assets-api access-token.

    If the default Testnet/Signet tokens are used excessively, there is a risk of abuse. To mitigate this, we can rotate the default tokens if necessary.

  • Developers prefer a development experience that is as close to "zero-config" or "minimal configuration" as possible.

    1. Inferring and providing default values for configurations: Whenever possible, infer and provide default values for configurations that developers would otherwise need to set manually. This reduces the cognitive load on developers and allows them to focus on writing code rather than configuring the environment.
    2. Documenting the default values and their rationale: Clearly document the default values provided and explain the reasoning behind them. This helps developers understand the choices made and when it might be appropriate to override the defaults.
    3. Allowing for easy overriding of defaults: While providing sensible defaults, ensure that developers can easily override them when necessary. This flexibility allows for customization while still providing a zero-config experience for common use cases.

These strategies may provide a more developer-friendly experience that reduces the time and effort required to get started with rgbpp-sdk.

@Flouse Flouse changed the title discussion: try refactoring examples/rgbpp/xudt/launch into a simpler one-step-test discussion: try refactoring examples/rgbpp/xudt/launch into a simpler single-step test Jul 3, 2024
@Flouse Flouse added documentation Improvements or additions to documentation enhancement New feature or request P-Medium example labels Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request example P-Medium
Projects
None yet
Development

No branches or pull requests

1 participant