Interface FilSnapMethods

The 'wallet_invokeSnap' RPC request handlers

Should always return a promise as this is on the metamask side

Hierarchy

FilSnapMethods

Index

Properties

fil_configure fil_exportPrivateKey fil_getAccountInfo fil_getAddress fil_getBalance fil_getGasForMessage fil_getPublicKey fil_sendMessage fil_signMessage fil_signMessageRaw

Properties

fil_configure

fil_configure: ((ctx, params) => Promise<ConfigureResponse>)

Type declaration

- (ctx, params): Promise<ConfigureResponse>
- Configures the snap with the provided configuration
  Parameters
  - ctx: SnapContext
    
    Snap context
  - params: Partial<{
        derivationPath: string;
        network: "mainnet" | "testnet";
        rpc: { url: string; token: string; };
        unit?: { symbol: "FIL" | "tFIL"; decimals: number; };
    }>
    
    overrides for the default configuration
  Returns Promise<ConfigureResponse>

fil_exportPrivateKey

fil_exportPrivateKey: ((ctx) => Promise<ExportPrivateKeyResponse>)

Type declaration

- (ctx): Promise<ExportPrivateKeyResponse>
- Export the private key of the current account
  Parameters
  - ctx: SnapContext
    
    Snaps context
  Returns Promise<ExportPrivateKeyResponse>
  Private key of the current account

fil_getAccountInfo

fil_getAccountInfo: ((ctx) => Promise<GetAccountInfoResponse>)

Type declaration

- (ctx): Promise<GetAccountInfoResponse>
- Get the balance of the current account
  Parameters
  - ctx: SnapContext
    
    Snaps context
  Returns Promise<GetAccountInfoResponse>
  Balance of the account in attoFIL

fil_getAddress

fil_getAddress: ((snap) => Promise<GetAddressResponse>)

Type declaration

- (snap): Promise<GetAddressResponse>
- Parameters
  - snap: SnapsGlobalObject
  Returns Promise<GetAddressResponse>

fil_getBalance

fil_getBalance: ((ctx) => Promise<GetBalanceResponse>)

Type declaration

- (ctx): Promise<GetBalanceResponse>
- Get the balance of the current account
  Parameters
  - ctx: SnapContext
    
    Snaps context
  Returns Promise<GetBalanceResponse>
  Balance of the account in attoFIL

fil_getGasForMessage

fil_getGasForMessage: ((ctx, params) => Promise<GasForMessageResponse>)

Type declaration

- (ctx, params): Promise<GasForMessageResponse>
- Get the gas estimate for a message
  Parameters
  - ctx: SnapContext
    
    Snap context
  - params: {
    maxFee?: string;
    message: {};
    }
    
    Estimate params
    - Optional maxFee?: string
      
      Max fee in attoFIL
      
      Default
      100000000000000000 - 0.1 FIL
    - message: {}
      
      Message to estimate gas for
  Returns Promise<GasForMessageResponse>

fil_getPublicKey

fil_getPublicKey: ((snap) => Promise<GetPublicResponse>)

Type declaration

- (snap): Promise<GetPublicResponse>
- Parameters
  - snap: SnapsGlobalObject
  Returns Promise<GetPublicResponse>

fil_sendMessage

fil_sendMessage: ((ctx, params) => Promise<SendMessageResponse>)

Type declaration

- (ctx, params): Promise<SendMessageResponse>
- Send a message to the network
  Parameters
  - ctx: SnapContext
    
    Snap context
  - params: SignedMessage
    
    The signed message
  Returns Promise<SendMessageResponse>

fil_signMessage

fil_signMessage: ((ctx, params) => Promise<SignMessageResponse>)

Type declaration

- (ctx, params): Promise<SignMessageResponse>
- Sign a message
  Parameters
  - ctx: SnapContext
    
    Snap context
  - params: {}
    
    The message request
  Returns Promise<SignMessageResponse>

fil_signMessageRaw

fil_signMessageRaw: ((ctx, params) => Promise<SignMessageRawResponse>)

Type declaration

- (ctx, params): Promise<SignMessageRawResponse>
- Sign a raw message
  Parameters
  - ctx: SnapContext
    
    Snap context
  - params: {
    message: string;
    }
    
    Parameters
    - message: string
      
      The raw message
  Returns Promise<SignMessageRawResponse>

Generated using TypeDoc