Skip to content

PUBLISHING.md

Latest commit

 

History

History
24 lines (18 loc) · 1.34 KB

PUBLISHING.md

File metadata and controls

24 lines (18 loc) · 1.34 KB
Raw

Publishing Strategy for TypeScript Bindings

We have generated TypeScript client bindings for the attester-registry and attestation-registry contracts.

Decision

We will publish the bindings as a dedicated npm package under the @lafiya organization (e.g., @lafiya/contract-bindings). This package will be versioned independently and can be consumed by lafiya-web via a standard npm dependency.

Rationale

  • Discoverability: An npm package is the most common way for JavaScript/TypeScript projects to consume reusable libraries.
  • Versioning: Allows us to release updates without touching the lafiya-web repo.
  • CI/CD: We can automate publishing using GitHub Actions once a release tag is created.

Publishing Steps

  1. Add a package.json at the root of the bindings directory (already present).
  2. Configure the publishConfig to scope the package to the @lafiya org.
  3. Run npm publish --access public from the bindings directory when ready.
  4. Update lafiya-web to depend on @lafiya/contract-bindings with the appropriate version range.

Coordination

  • The maintainer of lafiya-web should add @lafiya/contract-bindings as a dependency in its package.json.
  • Future changes to the contracts will trigger a new version publish, and lafiya-web can update its lockfile accordingly.

Generated by Antigravity.