Class FilsnapAdapter

constructor

• new FilsnapAdapter(snapId, snapVersion): FilsnapAdapter

• Parameters

  • snapId: string

  • snapVersion: string

  Returns FilsnapAdapter

config

Readonly request

Readonly snapId

Readonly snapVersion

calculateGasForMessage

• calculateGasForMessage(params): Promise<GasForMessageResponse>

• Estimate the gas for a message

  maxFee is optional and defaults to 100000000000000000 attoFIL (0.1 FIL)

  Parameters

  • params: {
        maxFee?: string;
        message: {
            gasFeeCap?: string;
            gasLimit?: number;
            gasPremium?: string;
            method?: number;
            nonce?: number;
            params?: string;
            to: string;
            value: string;
            version?: 0;
        };
    }

    fil_getGasForMessage RPC method params

    • Optional maxFee?: string

    • message: {
          gasFeeCap?: string;
          gasLimit?: number;
          gasPremium?: string;
          method?: number;
          nonce?: number;
          params?: string;
          to: string;
          value: string;
          version?: 0;
      }

      • Optional gasFeeCap?: string

      • Optional gasLimit?: number

      • Optional gasPremium?: string

      • Optional method?: number

      • Optional nonce?: number

      • Optional params?: string

      • to: string

      • value: string

      • Optional version?: 0

  Returns Promise<GasForMessageResponse>

configure

• configure(params): Promise<ConfigureResponse>

• Configure the snap

  Parameters

  • params: Partial<{
        derivationPath: string;
        network: "mainnet" | "testnet";
        rpc: {
            token: string;
            url: string;
        };
        unit?: {
            decimals: number;
            symbol: "FIL" | "tFIL";
        };
    }>

    FilSnapMethods.fil_configure params

  Returns Promise<ConfigureResponse>

exportPrivateKey

• exportPrivateKey(): Promise<ExportPrivateKeyResponse>

• Export the account private key from the snap

  Returns Promise<ExportPrivateKeyResponse>

  See

  FilSnapMethods.fil_exportPrivateKey

getAccountInfo

• getAccountInfo(): Promise<GetAccountInfoResponse>

• Request account info from the snap

  Returns Promise<GetAccountInfoResponse>

  See

  FilSnapMethods.fil_getAccountInfo

getAddress

• getAddress(): Promise<GetAddressResponse>

• Request account address from the snap

  Returns Promise<GetAddressResponse>

  See

  FilSnapMethods.fil_getAddress

getBalance

• getBalance(): Promise<GetBalanceResponse>

• Request account balance from the snap

  Returns Promise<GetBalanceResponse>

  See

  FilSnapMethods.fil_getBalance

getPublicKey

• getPublicKey(): Promise<GetPublicResponse>

• Request account public key from the snap

  Returns Promise<GetPublicResponse>

  See

  FilSnapMethods.fil_getPublicKey

isConnected

• isConnected(): boolean

• Check dapp is connected to Filsnap

  Returns boolean

  true if connected to Filsnap, false otherwise

rpc

• rpc(): RPC

• Get the RPC instance configured by Filsnap

  Returns RPC

  RPC instance

sendMessage

• sendMessage(params): Promise<SendMessageResponse>

• Send a signed message

  Parameters

  • params: SignedMessage

    FilSnapMethods.fil_sendMessage params

  Returns Promise<SendMessageResponse>

signMessage

• signMessage(params): Promise<SignMessageResponse>

• Sign a message

  Parameters

  • params: {
        gasFeeCap?: string;
        gasLimit?: number;
        gasPremium?: string;
        method?: number;
        nonce?: number;
        params?: string;
        to: string;
        value: string;
        version?: 0;
    }

    FilSnapMethods.fil_signMessage params

    • Optional gasFeeCap?: string

    • Optional gasLimit?: number

    • Optional gasPremium?: string

    • Optional method?: number

    • Optional nonce?: number

    • Optional params?: string

    • to: string

    • value: string

    • Optional version?: 0

  Returns Promise<SignMessageResponse>

signMessageRaw

• signMessageRaw(params): Promise<SignMessageRawResponse>

• Sign a raw message

  Parameters

  • params: {
        message: string;
    }

    FilSnapMethods.fil_signMessageRaw params

    • message: string

  Returns Promise<SignMessageRawResponse>

switchOrAddChain

• switchOrAddChain(network): Promise<void>

• Switch to or add a different network

  Parameters

  • network: Network

    Network to switch to. Defaults to mainnet

  Returns Promise<void>

Static connect

• connect(config, snapId?, snapVersion?): Promise<FilsnapAdapter>

• Installs and connects to Filsnap

  Parameters

  • config: Partial<{
        derivationPath: string;
        network: "mainnet" | "testnet";
        rpc: {
            token: string;
            url: string;
        };
        unit?: {
            decimals: number;
            symbol: "FIL" | "tFIL";
        };
    }>

    Snap config

  • snapId: string = 'npm:filsnap'

    Snap ID to check for. Defaults to npm:filsnap which is the default ID for the Filsnap snap.

  • snapVersion: string = '*'

    Snap version to check for. Defaults to * which matches any version.

  Returns Promise<FilsnapAdapter>

  Throws

  Error if Metamask is not installed

Static hasSnaps

• hasSnaps(): Promise<boolean>

• Check if Metamask has Snaps API

  Returns Promise<boolean>

Static isAvailable

• isAvailable(snapId?, snapVersion?): Promise<boolean>

• Check if Filsnap is installed and enabled

  Parameters

  • snapId: string = 'npm:filsnap'

    Snap ID to check for. Defaults to npm:filsnap which is the default ID for the Filsnap snap.

  • snapVersion: string = '*'

    Snap version to check for. Defaults to * which matches any version.

  Returns Promise<boolean>