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

Aftermath TypeScript SDK

import { Caller } from "../../general/utils/caller";
import { CallerConfig } from "../../types";
import { AftermathApi } from "../../general/providers";
import { ApiMultisigUserBody } from "./multisigTypes";
/**
 * The `Multisig` class provides methods to interact with multisig-related functionality,
 * such as retrieving a multisig address and associated public key for a user.
 */
export declare class Multisig extends Caller {
    private readonly Provider?;
    /**
     * Creates a new instance of `Multisig`.
     *
     * @param config - Optional configuration for the `Caller`, including network and access token.
     * @param Provider - An optional instance of `AftermathApi` to build or fetch multisig data.
     */
    constructor(config?: CallerConfig, Provider?: AftermathApi | undefined);
    /**
     * Retrieves a multisig address and corresponding public key for a user based on their
     * provided single public key.
     *
     * @param inputs - An object implementing `ApiMultisigUserBody`, containing the user's public key as a `Uint8Array`.
     * @returns A promise that resolves to an object containing both the multisig address and its public key.
     *
     * @example
     * ```typescript
     *
     * const afSdk = new Aftermath("MAINNET");
     * await afSdk.init(); // initialize provider
     *
     * const multisig = afSdk.Multisig();
     *
     * const data = await multisig.getMultisigForUser({
     *   userPublicKey: myPublicKeyBytes
     * });
     * console.log(data.address, data.publicKey);
     * ```
     */
    getMultisigForUser(inputs: ApiMultisigUserBody): import("./multisigTypes").MultisigData;
    /**
     * Internal helper to get the configured `Multisig` provider from `AftermathApi`.
     * Throws an error if the provider is not available.
     */
    private useProvider;
}
//# sourceMappingURL=multisig.d.ts.map