Interface FilSnapMethods

The 'wallet_invokeSnap' RPC request handlers

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

interface FilSnapMethods {
    fil_changeNetwork: (
        ctx: SnapContext,
        params: { network: Network },
    ) => Promise<
        SnapResponse<
            {
                account: JsonifyObject<
                    {
                        address: string;
                        path: string;
                        publicKey: string;
                        type: "SECP256K1";
                    },
                >;
                network: Network;
            },
        >,
    >;
    fil_configure: (
        ctx: SnapContext,
        params: Partial,
    ) => Promise<ConfigureResponse>;
    fil_deriveAccount: (
        ctx: SnapContext,
        params: { index: number },
    ) => Promise<
        SnapResponse<
            JsonifyObject<
                {
                    address: string;
                    path: string;
                    publicKey: string;
                    type: "SECP256K1";
                },
            >,
        >,
    >;
    fil_exportPrivateKey: (
        ctx: SnapContext,
    ) => Promise<ExportPrivateKeyResponse>;
    fil_getAccount: (
        ctx: SnapContext,
    ) => Promise<
        SnapResponse<
            JsonifyObject<
                {
                    address: string;
                    path: string;
                    publicKey: string;
                    type: "SECP256K1";
                },
            >,
        >,
    >;
    fil_getAccountInfo: (
        ctx: SnapContext,
    ) => Promise<
        | JsonifyObject<{ error: SnapError; result: null }>
        | JsonifyObject<{ error: null; result: AccountInfo }>,
    >;
    fil_getAddress: (snap: SnapsProvider) => Promise<GetAddressResponse>;
    fil_getBalance: (ctx: SnapContext) => Promise<GetBalanceResponse>;
    fil_getConfig: (
        ctx: SnapContext,
    ) => Promise<
        SnapResponse<
            | null
            | {
                derivationPath: string;
                network: Network;
                rpc: { token: string; url: string };
                unit?: { decimals: number; symbol: "FIL" | "tFIL" };
            },
        >,
    >;
    fil_getGasForMessage: (
        ctx: SnapContext,
        params: { maxFee?: string; message: {} },
    ) => Promise<
        | JsonifyObject<{ error: SnapError; result: null }>
        | JsonifyObject<{ error: null; result: MessageGasEstimate }>,
    >;
    fil_getPublicKey: (snap: SnapsProvider) => Promise<GetPublicResponse>;
    fil_sendMessage: (
        ctx: SnapContext,
        params: { message: {}; signature: { data: string; type: "SECP256K1" } },
    ) => Promise<SendMessageResponse>;
    fil_setConfig: (
        ctx: SnapContext,
        params: {
            decimals?: number;
            index?: number;
            network: Network;
            rpcToken?: string;
            rpcUrl?: string;
            symbol?: "FIL" | "tFIL";
        },
    ) => Promise<
        SnapResponse<
            {
                account: JsonifyObject<
                    {
                        address: string;
                        path: string;
                        publicKey: string;
                        type: "SECP256K1";
                    },
                >;
                config: {
                    derivationPath: string;
                    network: Network;
                    rpc: { token: string; url: string };
                    unit?: { decimals: number; symbol: "FIL" | "tFIL" };
                };
            },
        >,
    >;
    fil_sign: (
        ctx: SnapContext,
        params: { data: string },
    ) => Promise<SignMessageRawResponse>;
    fil_signMessage: (
        ctx: SnapContext,
        params: {},
    ) => Promise<SignMessageResponse>;
    fil_signMessageRaw: (
        ctx: SnapContext,
        params: { message: string },
    ) => Promise<SignMessageRawResponse>;
}

Index

Properties

fil_changeNetwork fil_configure fil_deriveAccount fil_exportPrivateKey fil_getAccount fil_getAccountInfo fil_getAddress fil_getBalance fil_getConfig fil_getGasForMessage fil_getPublicKey fil_sendMessage fil_setConfig fil_sign fil_signMessage fil_signMessageRaw

Properties

fil_changeNetwork

fil_changeNetwork: (
    ctx: SnapContext,
    params: { network: Network },
) => Promise<
    SnapResponse<
        {
            account: JsonifyObject<
                {
                    address: string;
                    path: string;
                    publicKey: string;
                    type: "SECP256K1";
                },
            >;
            network: Network;
        },
    >,
>

Type declaration

- (
      ctx: SnapContext,
      params: { network: Network },
  ): Promise<
      SnapResponse<
          {
              account: JsonifyObject<
                  {
                      address: string;
                      path: string;
                      publicKey: string;
                      type: "SECP256K1";
                  },
              >;
              network: Network;
          },
      >,
  >
- RPC method to change the network
  Parameters
  - ctx: SnapContext
  - params: { network: Network }
  Returns Promise<
      SnapResponse<
          {
              account: JsonifyObject<
                  {
                      address: string;
                      path: string;
                      publicKey: string;
                      type: "SECP256K1";
                  },
              >;
              network: Network;
          },
      >,
  >

fil_configure

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

Type declaration

- (ctx: SnapContext, params: Partial): Promise<ConfigureResponse>
- Configures the snap with the provided configuration
  Parameters
  - ctx: SnapContext
    Snap context
  - params: Partial
    overrides for the default configuration
  Returns Promise<ConfigureResponse>

fil_deriveAccount

fil_deriveAccount: (
    ctx: SnapContext,
    params: { index: number },
) => Promise<
    SnapResponse<
        JsonifyObject<
            {
                address: string;
                path: string;
                publicKey: string;
                type: "SECP256K1";
            },
        >,
    >,
>

Type declaration

- (
      ctx: SnapContext,
      params: { index: number },
  ): Promise<
      SnapResponse<
          JsonifyObject<
              {
                  address: string;
                  path: string;
                  publicKey: string;
                  type: "SECP256K1";
              },
          >,
      >,
  >
- RPC method to change the network
  Parameters
  - ctx: SnapContext
  - params: { index: number }
  Returns Promise<
      SnapResponse<
          JsonifyObject<
              {
                  address: string;
                  path: string;
                  publicKey: string;
                  type: "SECP256K1";
              },
          >,
      >,
  >

fil_exportPrivateKey

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

Type declaration

- (ctx: SnapContext): 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_getAccount

fil_getAccount: (
    ctx: SnapContext,
) => Promise<
    SnapResponse<
        JsonifyObject<
            {
                address: string;
                path: string;
                publicKey: string;
                type: "SECP256K1";
            },
        >,
    >,
>

Type declaration

- (
      ctx: SnapContext,
  ): Promise<
      SnapResponse<
          JsonifyObject<
              {
                  address: string;
                  path: string;
                  publicKey: string;
                  type: "SECP256K1";
              },
          >,
      >,
  >
- RPC method to get the account info of the current account
  Parameters
  - ctx: SnapContext
    Snaps context
  Returns Promise<
      SnapResponse<
          JsonifyObject<
              {
                  address: string;
                  path: string;
                  publicKey: string;
                  type: "SECP256K1";
              },
          >,
      >,
  >

fil_getAccountInfo

fil_getAccountInfo: (
    ctx: SnapContext,
) => Promise<
    | JsonifyObject<{ error: SnapError; result: null }>
    | JsonifyObject<{ error: null; result: AccountInfo }>,
>

Type declaration

- (
      ctx: SnapContext,
  ): Promise<
      | JsonifyObject<{ error: SnapError; result: null }>
      | JsonifyObject<{ error: null; result: AccountInfo }>,
  >
- Get the account info and balance of the current account
  Parameters
  - ctx: SnapContext
    Snaps context
  Returns Promise<
  | JsonifyObject<{ error: SnapError; result: null }>
  | JsonifyObject<{ error: null; result: AccountInfo }>,
  >
  Balance of the account in attoFIL

fil_getAddress

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

fil_getBalance

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

Type declaration

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

fil_getConfig

fil_getConfig: (
    ctx: SnapContext,
) => Promise<
    SnapResponse<
        | null
        | {
            derivationPath: string;
            network: Network;
            rpc: { token: string; url: string };
            unit?: { decimals: number; symbol: "FIL" | "tFIL" };
        },
    >,
>

Type declaration

- (
      ctx: SnapContext,
  ): Promise<
      SnapResponse<
          | null
          | {
              derivationPath: string;
              network: Network;
              rpc: { token: string; url: string };
              unit?: { decimals: number; symbol: "FIL" | "tFIL" };
          },
      >,
  >
- RPC method to get the current configuration
  Parameters
  - ctx: SnapContext
    Snap context
  Returns Promise<
      SnapResponse<
          | null
          | {
              derivationPath: string;
              network: Network;
              rpc: { token: string; url: string };
              unit?: { decimals: number; symbol: "FIL" | "tFIL" };
          },
      >,
  >

fil_getGasForMessage

fil_getGasForMessage: (
    ctx: SnapContext,
    params: { maxFee?: string; message: {} },
) => Promise<
    | JsonifyObject<{ error: SnapError; result: null }>
    | JsonifyObject<{ error: null; result: MessageGasEstimate }>,
>

Type declaration

- (
      ctx: SnapContext,
      params: { maxFee?: string; message: {} },
  ): Promise<
      | JsonifyObject<{ error: SnapError; result: null }>
      | JsonifyObject<{ error: null; result: MessageGasEstimate }>,
  >
- Get the gas estimate for a message
  Parameters
  - ctx: SnapContext
    Snap context
  - params: { maxFee?: string; message: {} }
    Estimate params
    - OptionalmaxFee?: string
      Max fee in attoFIL
      
      Default
      100000000000000000 - 0.1 FIL
    - message: {}
      Message to estimate gas for
  Returns Promise<
  | JsonifyObject<{ error: SnapError; result: null }>
  | JsonifyObject<{ error: null; result: MessageGasEstimate }>,
  >

fil_getPublicKey

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

fil_sendMessage

fil_sendMessage: (
ctx: SnapContext,
params: { message: {}; signature: { data: string; type: "SECP256K1" } },
) => Promise<SendMessageResponse>

Type declaration

- (
  ctx: SnapContext,
  params: { message: {}; signature: { data: string; type: "SECP256K1" } },
  ): Promise<SendMessageResponse>
- Send a message to the network
  Parameters
  - ctx: SnapContext
    Snap context
  - params: { message: {}; signature: { data: string; type: "SECP256K1" } }
    The signed message
  Returns Promise<SendMessageResponse>

fil_setConfig

fil_setConfig: (
    ctx: SnapContext,
    params: {
        decimals?: number;
        index?: number;
        network: Network;
        rpcToken?: string;
        rpcUrl?: string;
        symbol?: "FIL" | "tFIL";
    },
) => Promise<
    SnapResponse<
        {
            account: JsonifyObject<
                {
                    address: string;
                    path: string;
                    publicKey: string;
                    type: "SECP256K1";
                },
            >;
            config: {
                derivationPath: string;
                network: Network;
                rpc: { token: string; url: string };
                unit?: { decimals: number; symbol: "FIL" | "tFIL" };
            };
        },
    >,
>

Type declaration

- (
      ctx: SnapContext,
      params: {
          decimals?: number;
          index?: number;
          network: Network;
          rpcToken?: string;
          rpcUrl?: string;
          symbol?: "FIL" | "tFIL";
      },
  ): Promise<
      SnapResponse<
          {
              account: JsonifyObject<
                  {
                      address: string;
                      path: string;
                      publicKey: string;
                      type: "SECP256K1";
                  },
              >;
              config: {
                  derivationPath: string;
                  network: Network;
                  rpc: { token: string; url: string };
                  unit?: { decimals: number; symbol: "FIL" | "tFIL" };
              };
          },
      >,
  >
- RPC method to set the configuration
  Parameters
  - ctx: SnapContext
  - params: {
        decimals?: number;
        index?: number;
        network: Network;
        rpcToken?: string;
        rpcUrl?: string;
        symbol?: "FIL" | "tFIL";
    }
    - Optionaldecimals?: number
      Number of decimals of the token to be used in the UI
    - Optionalindex?: number
      Derivation path address index
    - network: Network
      Network to be used
      
      Default
      mainnet
    - OptionalrpcToken?: string
      Bearer token used to make authenticated requests to the RPC URL
    - OptionalrpcUrl?: string
      RPC URL to be used must be a valid URL and match the network
    - Optionalsymbol?: "FIL" | "tFIL"
      Symbol of the token to be used in the UI
  Returns Promise<
      SnapResponse<
          {
              account: JsonifyObject<
                  {
                      address: string;
                      path: string;
                      publicKey: string;
                      type: "SECP256K1";
                  },
              >;
              config: {
                  derivationPath: string;
                  network: Network;
                  rpc: { token: string; url: string };
                  unit?: { decimals: number; symbol: "FIL" | "tFIL" };
              };
          },
      >,
  >

fil_sign

fil_sign: (
ctx: SnapContext,
params: { data: string },
) => Promise<SignMessageRawResponse>

Type declaration

- (ctx: SnapContext, params: { data: string }): Promise<SignMessageRawResponse>
- Sign a arbitrary bytes
  Parameters
  - ctx: SnapContext
    Snap context
  - params: { data: string }
    Parameters
    - data: string
      Base64 encoded bytes to sign
  Returns Promise<SignMessageRawResponse>
  Signature in Lotus format (hex encoded) Signature.toLotusHex

fil_signMessage

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

Type declaration

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

fil_signMessageRaw

fil_signMessageRaw: (
ctx: SnapContext,
params: { message: string },
) => Promise<SignMessageRawResponse>

Type declaration

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

Interface FilSnapMethods

Index

Properties

Properties

fil_changeNetwork

Type declaration

Parameters

Returns Promise< SnapResponse< { account: JsonifyObject< { address: string; path: string; publicKey: string; type: "SECP256K1"; }, >; network: Network; }, >,>

fil_configure

Type declaration

Parameters

Returns Promise<ConfigureResponse>

fil_deriveAccount

Type declaration

Parameters

Returns Promise< SnapResponse< JsonifyObject< { address: string; path: string; publicKey: string; type: "SECP256K1"; }, >, >,>

fil_exportPrivateKey

Type declaration

Parameters

Returns Promise<ExportPrivateKeyResponse>

fil_getAccount

Type declaration

Parameters

Returns Promise< SnapResponse< JsonifyObject< { address: string; path: string; publicKey: string; type: "SECP256K1"; }, >, >,>

fil_getAccountInfo

Type declaration

Parameters

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

fil_getAddress

fil_getBalance

Type declaration

Parameters

Returns Promise<GetBalanceResponse>

fil_getConfig

Type declaration

Parameters

Returns Promise< SnapResponse< | null | { derivationPath: string; network: Network; rpc: { token: string; url: string }; unit?: { decimals: number; symbol: "FIL" | "tFIL" }; }, >,>

fil_getGasForMessage

Type declaration

Parameters

OptionalmaxFee?: string

Default

message: {}

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

fil_getPublicKey

fil_sendMessage

Type declaration

Parameters

Returns Promise<SendMessageResponse>

fil_setConfig

Type declaration

Parameters

Optionaldecimals?: number

Optionalindex?: number

network: Network

Default

OptionalrpcToken?: string

OptionalrpcUrl?: string

Optionalsymbol?: "FIL" | "tFIL"

Returns Promise< SnapResponse< { account: JsonifyObject< { address: string; path: string; publicKey: string; type: "SECP256K1"; }, >; config: { derivationPath: string; network: Network; rpc: { token: string; url: string }; unit?: { decimals: number; symbol: "FIL" | "tFIL" }; }; }, >,>

fil_sign

Type declaration

Parameters

data: string

Returns Promise<SignMessageRawResponse>

fil_signMessage

Type declaration

Parameters

Returns Promise<SignMessageResponse>

fil_signMessageRaw

Type declaration

Parameters

message: string

Returns Promise<SignMessageRawResponse>

Settings

On This Page

Returns Promise<
SnapResponse<
{
account: JsonifyObject<
{
address: string;
path: string;
publicKey: string;
type: "SECP256K1";
},
>;
network: Network;
},
>,
>

Returns Promise<
SnapResponse<
JsonifyObject<
{
address: string;
path: string;
publicKey: string;
type: "SECP256K1";
},
>,
>,
>

Returns Promise<
SnapResponse<
JsonifyObject<
{
address: string;
path: string;
publicKey: string;
type: "SECP256K1";
},
>,
>,
>

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

Returns Promise<
SnapResponse<
| null
| {
derivationPath: string;
network: Network;
rpc: { token: string; url: string };
unit?: { decimals: number; symbol: "FIL" | "tFIL" };
},
>,
>

`Optional`maxFee?: string

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

`Optional`decimals?: number

`Optional`index?: number

`Optional`rpcToken?: string

`Optional`rpcUrl?: string

`Optional`symbol?: "FIL" | "tFIL"

Returns Promise<
SnapResponse<
{
account: JsonifyObject<
{
address: string;
path: string;
publicKey: string;
type: "SECP256K1";
},
>;
config: {
derivationPath: string;
network: Network;
rpc: { token: string; url: string };
unit?: { decimals: number; symbol: "FIL" | "tFIL" };
};
},
>,
>