@self.id/3box-legacy
Version:
Load legacy 3Box profiles
35 lines (34 loc) • 1.09 kB
TypeScript
/**
* Load legacy 3Box profiles.
*
* ## Purpose
*
* The`3box-legacy` module provides utility functions to load legacy 3Box profiles.
*
* ## Installation
*
* ```sh
* npm install @self.id/3box-legacy
* ```
*
* ## Common use-cases
*
* ### Load a legacy 3Box profile as a Self.ID basic profile
*
* ```ts
* import { getLegacy3BoxProfileAsBasicProfile } from '@self.id/3box-legacy'
*
* async function getProfile() {
* // Ethereum address to load the profile of
* const address = '0x123efad...'
* return await getLegacy3BoxProfileAsBasicProfile(address)
* }
* ```
*
* @module 3box-legacy
*/
import type { BasicProfile } from '@datamodels/identity-profile-basic';
import crossFetch from 'cross-fetch';
export declare function loadLegacy3BoxProfile<T = Record<string, any>>(address: string, fetchFunc?: typeof crossFetch): Promise<T | null>;
export declare const transformProfile: (profile: Record<string, any>) => BasicProfile;
export declare function getLegacy3BoxProfileAsBasicProfile(address: string, fetchFunc?: typeof crossFetch): Promise<BasicProfile | null>;