@types/arconnect
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

Installation

npm install --save @types/arconnect

Summary

This package contains type definitions for arconnect (https://github.com/th8ta/ArConnect).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/arconnect.

index.d.ts

import { SignatureOptions } from "arweave/node/lib/crypto/crypto-interface";
import Transaction from "arweave/node/lib/transaction";

/**
 * Arweave wallet declarations
 */
declare global {
    interface Window {
        arweaveWallet: {
            connect(permissions: PermissionType[]): Promise<void>;
            disconnect(): Promise<void>;
            getActiveAddress(): Promise<string>;
            getAllAddresses(): Promise<string[]>;
            getWalletNames(): Promise<{ [addr: string]: string }>;
            sign(
                transaction: Transaction,
                options?: SignatureOptions,
            ): Promise<Transaction>;
            getPermissions(): Promise<PermissionType[]>;
            encrypt(
                data: string,
                options: {
                    algorithm: string;
                    hash: string;
                    salt?: string | undefined;
                },
            ): Promise<Uint8Array>;
            decrypt(
                data: Uint8Array,
                options: {
                    algorithm: string;
                    hash: string;
                    salt?: string | undefined;
                },
            ): Promise<string>;
        };
    }
    interface WindowEventMap {
        walletSwitch: CustomEvent<{ address: string }>;
        arweaveWalletLoaded: CustomEvent<{}>;
    }
}

/**
 * Arweave wallet permission types
 */
export type PermissionType =
    | "ACCESS_ADDRESS"
    | "ACCESS_ALL_ADDRESSES"
    | "SIGN_TRANSACTION"
    | "ENCRYPT"
    | "DECRYPT";

export {};

Additional Details

  • Last updated: Mon, 06 Nov 2023 22:41:04 GMT
  • Dependencies: arweave

Credits

These definitions were written by Marton Lederer.

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @types/arconnect

    Weekly Downloads

    12

    Version

    1.0.5

    License

    MIT

    Unpacked Size

    5.76 kB

    Total Files

    5

    Last publish

    Collaborators

    • types