Skip to content

[Toolbox][SDK] Community-built SDK to integrate with CBWeb3 (contract-first, spec-driven) #36

Description

@carolacnet

Goal
Provide a community-maintained SDK/client library that accelerates integration with CBWeb3 by offering typed clients, standard error handling, and reference examples, aligned with Toolbox artifacts (contracts, mocks, test vectors, conformance).

Scope (v1)

  • Generate and/or implement client stubs from Toolbox interface contracts (e.g., OpenAPI/JSON schemas/ABIs, as applicable).
  • Provide a minimal set of features:
    • request/response models + validation helpers
    • consistent error mapping (retries, timeouts, idempotency guidance)
    • safe logging defaults (no sensitive payloads)
    • example “golden path” integration snippets
  • CI: lint/tests + compatibility checks against test vectors and reference mocks.

Non-goals

  • Key management, custody, HSM integration, production secrets, or any privileged runtime material.
  • Replacing the core implementation—this is an integration accelerator, not the network itself.

Acceptance criteria

  • SDK builds and runs using non-sensitive sample configs
  • At least 1 end-to-end example passes against reference mocks
  • Versioned release + changelog + clear upgrade notes

Open questions
Target language(s) for v1 (e.g., TypeScript/Java/Python) and the initial API surface to support.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions