Bourse.Signing.Lighter (bourse v0.1.0)

Copy Markdown View Source

Lighter zk-Schnorr signing through an isolated official Go helper.

The API signing key crosses stdin exactly once into a per-key external OS process. The helper is temporary and terminating it removes that key from the signing subsystem. Network transport remains in Bourse.HTTP.

Summary

Types

signing_error()

Functions

sign_transaction(operation, params, credentials, config)

Signs a supported Lighter transaction using the same per-key helper.

terminate_helper(credentials, config)

Terminates the helper that owns these credentials.

Types

signing_error()

@type signing_error() ::
  {:lighter_signing,
   :invalid_credentials
   | :invalid_configuration
   | :helper_unavailable
   | :helper_terminated
   | Bourse.Signing.Lighter.Protocol.protocol_error()}

Functions

sign_transaction(operation, params, credentials, config)

@spec sign_transaction(
  Bourse.Signing.Lighter.Protocol.operation(),
  map(),
  Bourse.Credentials.t(),
  map()
) ::
  {:ok, Bourse.Signing.Lighter.Protocol.signed_transaction()}
  | {:error, signing_error()}

Signs a supported Lighter transaction using the same per-key helper.

terminate_helper(credentials, config)

@spec terminate_helper(Bourse.Credentials.t(), map()) ::
  :ok | {:error, signing_error()}

Terminates the helper that owns these credentials.