Class FilsnapAdapter

constructor

• new FilsnapAdapter(options: FilsnapAdapterOptions): FilsnapAdapter

• Parameters

  • options: FilsnapAdapterOptions

  Returns FilsnapAdapter

config

Readonlyprovider

Readonlysnap

calculateGasForMessage

• calculateGasForMessage(
      params: {
          maxFee?: string;
          message: {
              gasFeeCap?: string;
              gasLimit?: number;
              gasPremium?: string;
              method?: number;
              nonce?: number;
              params?: string;
              to: string;
              value: string;
              version?: 0;
          };
      },
  ): Promise<
      | JsonifyObject<{ error: SnapError; result: null }>
      | JsonifyObject<{ error: null; result: MessageGasEstimate }>,
  >

• 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

  Returns Promise<
      | JsonifyObject<{ error: SnapError; result: null }>
      | JsonifyObject<{ error: null; result: MessageGasEstimate }>,
  >

changeChain

• changeChain(chain: string | number): Promise<ConfigureResponse>

• Change the chain

  Parameters

  • chain: string | number

    Chain to switch to

  Returns Promise<ConfigureResponse>

configure

• configure(
      params?: Partial<
          {
              derivationPath: string;
              network: "mainnet"
              | "testnet";
              rpc: { token: string; url: string };
              unit?: { decimals: number; symbol: "FIL" | "tFIL" };
          },
      >,
  ): 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>

disconnect

• disconnect(): Promise<void>

• Returns Promise<void>

exportPrivateKey

• exportPrivateKey(): Promise<ExportPrivateKeyResponse>

• Export the account private key from the snap

  Returns Promise<ExportPrivateKeyResponse>

  See

  FilSnapMethods.fil_exportPrivateKey

getAccountInfo

• getAccountInfo(): Promise<
      | JsonifyObject<{ error: SnapError; result: null }>
      | JsonifyObject<{ error: null; result: AccountInfo }>,
  >

• Request account info from the snap

  Returns Promise<
      | JsonifyObject<{ error: SnapError; result: null }>
      | JsonifyObject<{ error: null; result: AccountInfo }>,
  >

  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

rpc

• rpc(): RPC

• Get the RPC instance configured by Filsnap

  Returns RPC

  RPC instance

sendMessage

• sendMessage(
      params: {
          message: {
              from: string;
              gasFeeCap: string;
              gasLimit: number;
              gasPremium: string;
              method: number;
              nonce: number;
              params: string;
              to: string;
              value: string;
              version: 0;
          };
          signature: { data: string; type: "SECP256K1" };
      },
  ): Promise<SendMessageResponse>

• Send a signed message

  Parameters

  • params: {
        message: {
            from: string;
            gasFeeCap: string;
            gasLimit: number;
            gasPremium: string;
            method: number;
            nonce: number;
            params: string;
            to: string;
            value: string;
            version: 0;
        };
        signature: { data: string; type: "SECP256K1" };
    }

    FilSnapMethods.fil_sendMessage params

  Returns Promise<SendMessageResponse>

signMessage

• signMessage(
      params: {
          gasFeeCap?: string;
          gasLimit?: number;
          gasPremium?: string;
          method?: number;
          nonce?: number;
          params?: string;
          to: string;
          value: string;
          version?: 0;
      },
  ): 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

  Returns Promise<SignMessageResponse>

signMessageRaw

• signMessageRaw(params: { message: string }): Promise<SignMessageRawResponse>

• Sign a raw message

  Parameters

  • params: { message: string }

    FilSnapMethods.fil_signMessageRaw params

  Returns Promise<SignMessageRawResponse>

Staticconnect

• connect(options: ConnectOptions): Promise<FilsnapAdapter>

• Installs and connects to Filsnap

  Parameters

  • options: ConnectOptions

    Connect options

  Returns Promise<FilsnapAdapter>

  Throws

  Error if Metamask is not installed

Staticreconnect

• reconnect(
      options: Omit<ConnectOptions, "config">,
  ): Promise<undefined | { account: AccountInfo; adapter: FilsnapAdapter }>

• Parameters

  • options: Omit<ConnectOptions, "config">

  Returns Promise<undefined | { account: AccountInfo; adapter: FilsnapAdapter }>