Skip to content

integration-guide.md gives two contradictory API descriptions of the same bindings/typescript package #1400

Description

@Haroldwonder

docs/integration-guide.md's "Which TypeScript package do I need?" section describes @trustlink/contract (bindings/typescript/) as exporting a Client class with snake_case, single-object-argument methods (import { Client } from "@trustlink/contract"; client.has_valid_claim({ subject: "G...", claim_type: "KYC_PASSED" })). Section 3 ("JavaScript / TypeScript Integration") later describes the same physical package under a different, incorrect name @trustlink/bindings (import { TrustLinkClient } from "@trustlink/bindings") with camelCase, positional-argument, Keypair-based methods (client.createAttestation(issuer, subject, claimType, ...)). Neither description is fully correct: per bindings/typescript/package.json the real npm name is @trustlink/contract, and per bindings/typescript/src/client.ts:130 (export class TrustLinkClient) and its camelCase, positional-arg methods (e.g. hasValidClaim(subject, claimType) at line 581, createAttestation(issuer: Keypair, ...) at line 405), the actual API matches section 3's calling convention but not its package name, while the top section gets neither the class name, method casing, nor argument style right.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programarchitecturedocumentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions