UNPKG

@metamask/snaps-rpc-methods

Version:
192 lines 14 kB
import type { PermittedHandlerExport } from "@metamask/permission-controller"; import type { UpdateInterfaceParams, UpdateInterfaceResult, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk"; import { type InferMatching } from "@metamask/snaps-utils"; export type UpdateInterfaceMethodHooks = { /** * @param id - The interface ID. * @param ui - The UI components. * @param context - The optional interface context object. */ updateInterface: (id: string, ui: ComponentOrElement, context?: InterfaceContext) => Promise<void>; }; export declare const updateInterfaceHandler: PermittedHandlerExport<UpdateInterfaceMethodHooks, UpdateInterfaceParameters, UpdateInterfaceResult>; declare const UpdateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{ id: string; ui: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AccountSelectorProps, "AccountSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressInputProps, "AddressInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AssetSelectorProps, "AssetSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FieldProps, "Field"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AvatarProps, "Avatar"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BannerProps, "Banner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SkeletonProps, "Skeleton"> | { value: string; type: import("@metamask/snaps-sdk").NodeType.Copyable; sensitive?: boolean | undefined; } | { type: import("@metamask/snaps-sdk").NodeType.Divider; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Heading; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Image; } | { type: import("@metamask/snaps-sdk").NodeType.Spinner; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Text; markdown?: boolean | undefined; } | { value: `0x${string}`; type: import("@metamask/snaps-sdk").NodeType.Address; } | { value: { value: string; type: import("@metamask/snaps-sdk").NodeType.Image; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Text; markdown?: boolean | undefined; } | { value: `0x${string}`; type: import("@metamask/snaps-sdk").NodeType.Address; }; type: import("@metamask/snaps-sdk").NodeType.Row; label: string; variant?: "default" | "critical" | "warning" | undefined; } | { name: string; type: import("@metamask/snaps-sdk").NodeType.Input; value?: string | undefined; label?: string | undefined; inputType?: "number" | "text" | "password" | undefined; placeholder?: string | undefined; error?: string | undefined; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Button; name?: string | undefined; variant?: "primary" | "secondary" | undefined; buttonType?: "button" | "submit" | undefined; } | { name: string; type: import("@metamask/snaps-sdk").NodeType.Form; children: ({ name: string; type: import("@metamask/snaps-sdk").NodeType.Input; value?: string | undefined; label?: string | undefined; inputType?: "number" | "text" | "password" | undefined; placeholder?: string | undefined; error?: string | undefined; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Button; name?: string | undefined; variant?: "primary" | "secondary" | undefined; buttonType?: "button" | "submit" | undefined; })[]; } | import("@metamask/snaps-sdk/jsx").SnapElement<{ src: string; alt?: string | undefined; borderRadius?: import("@metamask/snaps-sdk/jsx").BorderRadius; }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{ name: string; value?: string | undefined; children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{ value: string; children: string; disabled?: boolean | undefined; }, "Radio">>; disabled?: boolean | undefined; }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{ children: import("@metamask/snaps-sdk/jsx").StringElement; size?: "sm" | "md" | "lg" | undefined; }, "Heading">; context?: Record<string, import("@metamask/snaps-sdk").Json> | undefined; }, { id: import("@metamask/superstruct").Struct<string, null>; ui: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AccountSelectorProps, "AccountSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressInputProps, "AddressInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AssetSelectorProps, "AssetSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FieldProps, "Field"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AvatarProps, "Avatar"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BannerProps, "Banner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SkeletonProps, "Skeleton"> | { value: string; type: import("@metamask/snaps-sdk").NodeType.Copyable; sensitive?: boolean | undefined; } | { type: import("@metamask/snaps-sdk").NodeType.Divider; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Heading; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Image; } | { type: import("@metamask/snaps-sdk").NodeType.Spinner; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Text; markdown?: boolean | undefined; } | { value: `0x${string}`; type: import("@metamask/snaps-sdk").NodeType.Address; } | { value: { value: string; type: import("@metamask/snaps-sdk").NodeType.Image; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Text; markdown?: boolean | undefined; } | { value: `0x${string}`; type: import("@metamask/snaps-sdk").NodeType.Address; }; type: import("@metamask/snaps-sdk").NodeType.Row; label: string; variant?: "default" | "critical" | "warning" | undefined; } | { name: string; type: import("@metamask/snaps-sdk").NodeType.Input; value?: string | undefined; label?: string | undefined; inputType?: "number" | "text" | "password" | undefined; placeholder?: string | undefined; error?: string | undefined; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Button; name?: string | undefined; variant?: "primary" | "secondary" | undefined; buttonType?: "button" | "submit" | undefined; } | { name: string; type: import("@metamask/snaps-sdk").NodeType.Form; children: ({ name: string; type: import("@metamask/snaps-sdk").NodeType.Input; value?: string | undefined; label?: string | undefined; inputType?: "number" | "text" | "password" | undefined; placeholder?: string | undefined; error?: string | undefined; } | { value: string; type: import("@metamask/snaps-sdk").NodeType.Button; name?: string | undefined; variant?: "primary" | "secondary" | undefined; buttonType?: "button" | "submit" | undefined; })[]; } | import("@metamask/snaps-sdk/jsx").SnapElement<{ src: string; alt?: string | undefined; borderRadius?: import("@metamask/snaps-sdk/jsx").BorderRadius; }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{ name: string; value?: string | undefined; children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{ value: string; children: string; disabled?: boolean | undefined; }, "Radio">>; disabled?: boolean | undefined; }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{ children: import("@metamask/snaps-sdk/jsx").StringElement; size?: "sm" | "md" | "lg" | undefined; }, "Heading">, null>; context: import("@metamask/superstruct").Struct<Record<string, import("@metamask/snaps-sdk").Json> | undefined, null>; }>; export type UpdateInterfaceParameters = InferMatching<typeof UpdateInterfaceParametersStruct, UpdateInterfaceParams>; export {}; //# sourceMappingURL=updateInterface.d.mts.map