sphinx-bridge/dist/provider.d.ts

Embed apps within Sphinx

export interface AuthorizeRes {
    budget: number;
    pubkey: string;
    routeHint: string;
    signature: string;
}
export interface AuthorizeArgs {
    challenge: string;
    noBudget: boolean;
}
export interface EnableRes {
    budget: number;
    pubkey: string;
    routeHint: string;
}
export interface KeysendArgs {
    amt: number;
    dest: string;
    route_hint?: string;
}
export interface KeysendRes {
    success: boolean;
    budget: number;
}
export interface SendPaymentRes {
    preimage: string;
}
export interface InvoiceArgs {
    amt: number;
    memo: string;
}
export interface InvoiceRes {
    paymentRequest: string;
}
export interface LsatRes {
    paymentRequest: string;
    macaroon: string;
    issuer: string;
}
export interface GetLsatRes {
    paymentRequest: string;
    macaroon: string;
    issuer: string;
    identifier: string;
    preimage: string;
    paths: string;
    status: string;
    success: boolean;
}
export interface GetLsatArgs {
    issuer?: string;
}
export interface UpdateLsatRes {
    success: boolean;
}
export interface UpdateLsatArgs {
    identifier: string;
    status: string;
}
export interface SendLsatRes {
    success: boolean;
    budget: number;
}
export interface SignMessageArgs {
    message: string;
}
export interface SignMessageRes {
    signature: string;
}
export interface VerifyMessageArgs {
    message: string;
    signature: string;
}
export interface ReloadArgs {
    password: string;
}
export interface SaveDataArgs {
    type: number;
    metaData: any;
}
export interface SaveDataRes {
    success: boolean;
}
export interface GetPersonDataRes {
    success: boolean;
    alias: string;
    publicKey: string;
    photoUrl: string;
}
export interface GetBudgetRes {
    success: boolean;
    budget: number;
}
export interface SetBudgetRes {
    success: boolean;
    budget: number;
}
export interface GetSignedTokenRes {
    success: boolean;
    token: string;
}
export interface GetSecondBrainListRes {
    success: boolean;
    second_brain_list: string[];
}
export interface SphinxProvider {
    enable(): Promise<EnableRes | null>;
    topup(): Promise<SetBudgetRes | null>;
    authorize(challenge: string): Promise<AuthorizeRes | null>;
    keysend(dest: string, amt: number, routeHint?: string): Promise<KeysendRes | null>;
    updated(): Promise<undefined | null>;
    sendPayment(paymentRequest: string): Promise<SendPaymentRes | null>;
    makeInvoice(amt: number, memo: string): Promise<InvoiceRes | null>;
    signMessage(message: string): Promise<SignMessageRes | null>;
    verifyMessage(signature: string, message: string): Promise<boolean | null>;
    reload(password: string): Promise<EnableRes | null>;
    saveGraphData(data: SaveDataArgs): Promise<SaveDataRes | null>;
    getPersonData(): Promise<GetPersonDataRes | null>;
}