aftermath-ts-sdk/dist/packages/userData/userData.d.ts

Aftermath TypeScript SDK

import { Caller } from "../../general/utils/caller";
import { CallerConfig } from "../../types";
import { ApiUserDataCreateUserBody, ApiUserDataPublicKeyBody } from "./userDataTypes";
/**
 * The `UserData` class provides functionality for managing user-specific
 * information in the Aftermath system. It enables creating and retrieving
 * user public keys, as well as generating messages for signing.
 */
export declare class UserData extends Caller {
    /**
     * Creates a new instance of the `UserData` class for interacting with user data endpoints.
     *
     * @param config - Optional configuration for the `Caller`, including network and access token.
     */
    constructor(config?: CallerConfig);
    /**
     * Retrieves the stored user public key (if any) for a given wallet address.
     *
     * @param inputs - An object implementing `ApiUserDataPublicKeyBody`, containing the user's wallet address.
     * @returns A promise that resolves to a string representation of the user's public key, or `undefined` if none is found.
     *
     * @example
     * ```typescript
     * const afSdk = new Aftermath("MAINNET");
     * await afSdk.init(); // initialize provider
     *
     * const userData = afSdk.UserData();
     *
     * const pubkey = await userData.getUserPublicKey({
     *   walletAddress: "0x<address>"
     * });
     * console.log(pubkey); // "0x<hex_public_key>" or undefined
     * ```
     */
    getUserPublicKey(inputs: ApiUserDataPublicKeyBody): Promise<string | undefined>;
    /**
     * Creates (or updates) the stored public key for a user on the backend, linking
     * it to their wallet address.
     *
     * @param inputs - Details required to create or update the user's public key, including signature data.
     * @returns A promise that resolves to `true` if the public key was successfully created/updated, otherwise `false` or an error.
     *
     * @example
     * ```typescript
     * const created = await userData.createUserPublicKey({
     *   walletAddress: "0x<address>",
     *   bytes: "0x<message_as_bytes>",
     *   signature: "0x<signature>"
     * });
     * console.log("Was public key created?", created);
     * ```
     */
    createUserPublicKey(inputs: ApiUserDataCreateUserBody): Promise<boolean>;
    /**
     * Generates a simple message object that the user should sign to prove their
     * intention to create or link an account in the Aftermath system.
     *
     * @returns An object with an `action` property, used as the data to sign.
     *
     * @example
     * ```typescript
     * const userData = new UserData();
     * const msgToSign = userData.createUserAccountMessageToSign();
     * console.log(msgToSign.action); // "CREATE_USER_ACCOUNT"
     * // The user can then sign msgToSign with their private key.
     * ```
     */
    createUserAccountMessageToSign(): {
        action: string;
    };
    /**
     * Generates a simple message object that the user should sign to confirm their agreement
     * with the Terms and Conditions of the service.
     *
     * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
     *
     * @example
     * ```typescript
     * const userData = new UserData();
     * const termsMsg = userData.createSignTermsAndConditionsMessageToSign();
     * console.log(termsMsg.action); // "SIGN_TERMS_AND_CONDITIONS"
     * // The user can sign this to show acceptance of the T&C.
     * ```
     */
    createSignTermsAndConditionsMessageToSign(): {
        action: string;
    };
}
//# sourceMappingURL=userData.d.ts.map