@connext/channel-commitments

@connext/channel-commitments

Usage

The CommitmentClient is responsible for interacting with the backend to collect signatures for channel signers. It will be consumed by the claim UI to capture signatures from returning users to redeem commitments.

Interface

The class has the following interface:

class CommitmentClient {
  // What consumer should prompt user to sign
  public readonly SIGN_IN_PROMPT: string = "...";

  // This method should:
  // - generate the channel wallet from input signature
  // - store the backend URL
  // - store the injected provider
  // - create a new CommitmentClient + return it
  public async post(signature: string, backend?: string): Promise<void> {}
}

Quickstart

1. Install the package:

npm i @connext/channel-commitments

1. Instantiate the client in your application:

import { CommitmentClient } from "@connext/channel-commitments";

const client = new CommitmentClient();

1. Generate the signature:

const signature = await injectedProvider.signMessage(client.SIGN_IN_PROMPT);

1. Post signature to backend:

try {
  await client.post(signature);
} catch (e) {
  console.warn("Failed to post to client");
}