Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Quick Start: TypeScript mediation example calls ConnectionsManager with missing arguments

Open Beginner friendly
  • Is something wrong?
#302 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Read the TypeScript mediation example in documentation/develop/quick-start.md (lines 375–402) and compare its ConnectionsManager call with the constructor in the pinned SDK v6.6.0 source, src/edge-agent/connectionsManager/ConnectionsManager.ts. Update the example to supply the required dependencies, then verify against that constructor that the handler is defined and the call type-checks.

Written by the indexing model from the issue text.

Description

bug documentation

User impact

Developers copying the Quick Start's "establish mediation when building your own application" TypeScript example cannot construct the connection manager at the SDK version the page itself selects. The call supplies four arguments, so the mediator handler is passed into the Pollux position and the required mediation-handler argument is missing. Starting the agent then reaches mediation setup with an undefined handler instead of a working manager.

Affected documentation and ownership

Observed versus expected

The page example calls:

const manager = new SDK.ConnectionsManager(castor, mercury, pluto, handler);

At the selected v6.6.0 commit, ConnectionsManager requires five positional dependencies before the optional arguments (ConnectionsManager.ts lines 70–78):

constructor(
  public castor: Castor,
  public mercury: Mercury,
  public pluto: Pluto,
  public pollux: Pollux,
  public mediationHandler: MediatorHandler,
  public pairings: DIDPair[] = [],
  public options?: AgentOptions
)

With the page's four arguments, handler binds to pollux, and mediationHandler is undefined. The manager's startMediator() calls this.mediationHandler.bootRegisteredMediator().

Expected: the example supplies the dependencies the selected SDK requires, so the copied code type-checks and agent start can begin mediation.

The rest of the snippet is consistent with v6.6.0: SDK.Agent resolves to edge-agent/didcomm/Agent (src/index.ts lines 10–11), whose constructor takes apollo, castor, pluto, mercury, mediationHandler, connectionManager, seed, ... (Agent.ts lines 62–72). The defect is the manager construction, not a comparison against an unrelated base Agent class.

Evidence and reproduction

Static comparison at immutable revisions, observed 2026-10-29T16:57:35Z:

  1. Read the page snippet in the current source at fa985df and in the saved deployed HTML.
  2. Read the v6.6.0 ConnectionsManager constructor and startMediator() in hyperledger-identus/sdk-ts at 1a9da81.
  3. Count the page's arguments (4) against the constructor's required parameters (5).

Limitations: no TypeScript compiler, build or agent run was executed. Execution was blocked because no disposable credential-free check environment was established. This is a source-level contradiction with the page's own selected version, not a runtime trace.

Existing work checked

Searched open and closed issues and PRs in hyperledger-identus/docs (full title inventory of 62 issues and 238 PRs) and in hyperledger-identus/sdk-ts, by ConnectionsManager, Pollux, mediation, code example and quick start, and read matching bodies and discussion.

  • The seven open Quick Start issues #290–#296 cover startup paths, schema examples, offer/response IDs, demo controls and manual issuance attribution; none covers this mediation constructor snippet.
  • sdk-ts PR #394 (feat!: refactor ConnectionManager) is the SDK-side API change that the portal example did not follow; it is not a documentation repair.
  • No open issue or PR repairs this example.

Acceptance criteria

  • The TypeScript mediation example constructs ConnectionsManager with the dependencies required by the page's selected SDK version.
  • Verification against the pinned v6.6.0 source, or a type-check/build in a disposable environment, shows the example compiles and reaches mediation setup with a defined handler.
Dominant language
TypeScript
Stars
15
Forks
8
Avg merge
3d 14h
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hyperledger-identus/docs

All issues in hyperledger-identus/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.