Credential.serialize

Serializes a Credential to the Payment Credential header format.

Usage

import { Credential, Challenge } from 'mppx'
 
const challenge = Challenge.from({
  id: 'abc123',
  intent: 'charge',
  method: 'tempo',
  realm: 'mpp.dev',
  request: { amount: '1000000', currency: '0x...', recipient: '0x...' },
})
 
const credential = Credential.from({
  challenge,
  payload: { signature: '0x...' },
})
 
const header = Credential.serialize(credential)
// => 'Payment eyJjaGFsbGVuZ2UiOnsi...'

Return type

type ReturnType = string

A string suitable for the HTTP field advertised by challenge.header, or Authorization when the Challenge omits it.

When the Credential includes an echoed Challenge, mppx keeps the HTTP wire format intact: challenge.request and challenge.opaque serialize as the same base64url-encoded strings that came from the Challenge header.

Parameters

credential

• Type: Credential

The Credential to serialize.