X402.Extensions.SIWX.Verifier behaviour (X402 v0.3.3)

Copy Markdown View Source

Behaviour for SIWX signature verification.

Implementations verify a SIWX message signature and return whether the signature matches the claimed wallet address.

Summary

Types

Verifier return value.

Callbacks

Verifies a signature against a message and claimed wallet address.

Functions

Validates that a value is a module implementing X402.Extensions.SIWX.Verifier.

Types

verify_result()

@type verify_result() :: {:ok, boolean()} | {:error, term()}

Verifier return value.

Callbacks

verify_signature(message, signature, address)

@callback verify_signature(
  message :: String.t(),
  signature :: String.t(),
  address :: String.t()
) :: verify_result()

Verifies a signature against a message and claimed wallet address.

Functions

validate_module(module)

(since 0.3.0)
@spec validate_module(term()) :: :ok | {:error, String.t()}

Validates that a value is a module implementing X402.Extensions.SIWX.Verifier.

This function is intended for NimbleOptions custom validation.