githubEdit

Signed Fetch

The SignedFetch module provides an implementation of the fetch interface that is transparently compliant with the signed fetcharrow-up-right protocol, which defines how to attach signed authentication chainsarrow-up-right to outgoing requests.

The procedures for signing and verifying this request are detailed in the authentication chainarrow-up-right page.

Using SignedFetch from a scene requires the USE_FETCHarrow-up-right permission.

Methods

signedFetch

Make an HTTP request as you would with (fetcharrow-up-right), automatically adding the verification headers.

interface Request {
  // The request target URL:
  url: string;

  // Optional, self-explanatory parameters for the request:
  init?: {
    method?: string;
    body?: string;
    headers: { [key: string]: string };
  };
}

interface Response {
  // Whether the HTTP request was performed successfully (codes other than 2xx are not failures)
  ok: boolean;

  // The self-explanatory details of the response:
  status: number;
  statusText: string;
  headers: { [key: string]: string };
  body: string;
}

function signedFetch(Request): Promise<Response>;

Last updated