@oasisprotocol/sapphire-wagmi-v2
Version:
Wagmi & Viem support for the Oasis Sapphire ParaTime.
136 lines • 5.72 kB
JavaScript
/**
* @license Apache-2.0
*/
import { isWrappedEthereumProvider, wrapEthereumProvider, } from "@oasisprotocol/sapphire-paratime";
import { createConfig, injected, } from "@wagmi/core";
import { EIP6963_ANNOUNCE_PROVIDER_EVENT_NAME, SUPPORTED_RDNS, } from "./constants.js";
export * from "@oasisprotocol/sapphire-viem-v2";
const cachedProviders = new Map();
/**
* Wrap the `window.ethereum` with the Sapphire encryption layer.
* Used to provide encrypted transactions and calldata to Wagmi browser dApps.
*
* ```
* import { injectedWithSapphire } from '@oasisprotocol/sapphire-wagmi-v2';
*
* export const config = createConfig({
* connectors: [
* injectedWithSapphire()
* ],
* ...
* });
* ```
*
* @returns Same as injected()
*/
export function injectedWithSapphire(options) {
return injected({
target: () => {
return {
id: "injected-sapphire",
name: "Injected (Sapphire)",
provider(window) {
if (window?.ethereum) {
// Note: providers are cached as connectors are frequently retrieved
// it prevents sapphire wrapper being called multiple times
// which spams the RPC with oasis_callDataPublicKey requests
if (!cachedProviders.has(window.ethereum)) {
const wp = wrapEthereumProvider(window.ethereum, options);
cachedProviders.set(window.ethereum, wp);
return wp;
}
return cachedProviders.get(window.ethereum);
}
return undefined;
},
};
},
});
}
/**
* Creates a wagmi configuration with wrapped EIP-6963 Sapphire encryption layer.
*
* In case you are only using Sapphire chain:
*
* ```typescript
* import { createSapphireConfig } from '@oasisprotocol/sapphire-wagmi-v2';
*
* export const config = createSapphireConfig({
* sapphireConfig: {
* replaceProviders: true,
* }
* ...
* });
* ```
*
* In case your dApp is multichain, the below example will create duplicate connectors for Sapphire:
*
* ```typescript
* import { createSapphireConfig } from '@oasisprotocol/sapphire-wagmi-v2';
*
* export const config = createSapphireConfig({
* sapphireConfig: {
* replaceProviders: false,
* // Define which providers you want to wrap via RDNS
* wrappedProvidersFilter: (rdns) => ['io.metamask'].includes(rdns)
* }
* ...
* });
* ```
*
* @param {CreateConfigParameters<chains, transports, connectorFns> & CreateSapphireConfigParameters} parameters - Extended wagmi parameters,
* with sapphireConfig
* @return {Config<chains, transports, connectorFns>} Wagmi config
*/
export function createSapphireConfig(parameters) {
const { sapphireConfig, ...restParameters } = parameters;
const { replaceProviders = false, wrappedProvidersFilter = () => true, wrap: wrapOptions, } = sapphireConfig;
// SSR check
const _dispatchEvent = typeof window !== "undefined" ? window.dispatchEvent : undefined;
if (_dispatchEvent) {
Object.defineProperty(window, "dispatchEvent", {
value: function (event) {
if (event.type === EIP6963_ANNOUNCE_PROVIDER_EVENT_NAME) {
const announceProviderEvent = event;
// Check if this is a supported provider that's not already wrapped
if (SUPPORTED_RDNS.includes(announceProviderEvent.detail.info.rdns) &&
!isWrappedEthereumProvider(announceProviderEvent.detail.provider)) {
if (replaceProviders) {
const wrappedEvent = new CustomEvent(EIP6963_ANNOUNCE_PROVIDER_EVENT_NAME, {
detail: {
...announceProviderEvent.detail,
provider: wrapEthereumProvider(announceProviderEvent.detail.provider, wrapOptions),
},
});
return _dispatchEvent.call(this, wrappedEvent);
}
// Duplicate mode: dispatch original event, then dispatch a wrapped duplicate
if (wrappedProvidersFilter(announceProviderEvent.detail.info.rdns)) {
_dispatchEvent.call(this, event);
const { info: { name, rdns, icon, uuid }, provider, } = announceProviderEvent.detail;
const sapphireProviderEvent = new CustomEvent(EIP6963_ANNOUNCE_PROVIDER_EVENT_NAME, {
detail: Object.freeze({
info: {
uuid: `sapphire.${uuid}`,
rdns: `sapphire.${rdns}`,
name: `${name} (Sapphire)`,
icon,
},
provider: wrapEthereumProvider(provider, wrapOptions),
}),
});
return _dispatchEvent.call(this, sapphireProviderEvent);
}
}
}
return _dispatchEvent.call(this, event);
},
writable: true,
configurable: true,
});
}
return createConfig({
...restParameters,
});
}
//# sourceMappingURL=index.js.map