API Reference

FAQ

Which platforms are supported?

We currently support and test on all 4 major desktop browsers(Chrome, Firefox, Safari,Edge) and major mobile browsers(Chrome, iOS Safari, iPad Safari, Samsung internet).

šŸ“˜

Looking for a different platform?

Let us know if you want us to support a platform not listed above. We will happily add support for our customers :)

What is the release policy?

We release new package versions regularly with bug fixes and new features. Package version follows semantic versioning spec.

Any breaking changes will be announced in advance.

Getting CSP (content security policy) errors?

If you are using CSP(content security policy) in your frontend, adding SDK can cause CSP errors.

SDK adds a small style element for the UI which can interfere with your CSP. The error can be easily fixed by updating the frame-src and thestyle-src SHA (Note that the SHA can change with the SDK version). 

<meta 
      http-equiv="Content-Security-Policy"
      content="base-uri 'self'; 
               default-src 'self';
               script-src 'self';
               style-src 'self' 'sha256-Np9fiNIx3Vi0vG77Axn/voE8bTPqYGVca+hCaQcEJfs='; 
               frame-src https://consent.metakeep.xyz">

Is MetaKeep provider compatible with web3.js?

Yes, it is fully compatible with web3.js. You can use the provider to sign transactions and messages. You can also use the provider to interact with smart contracts. See web3 provider for more details.

Do we have to initialize the SDK on page load or it can be instantiated anytime?

The SDK prefetches data for better performance. So we recommend that you initialize the SDK as early as possible in your application. The prefetch is non-blocking and doesn't affect your website load time.

Are there type definitions for the SDK?

Yes, the SDK has type definitions that you can use with TypeScript or JavaScript.
They are automatically included when you install the SDK using npm.

The UI is automatically zooming in on mobile devices. How do I disable it?

iOS-based devices automatically zoom in on the UI when the user focuses on an input field and the font size is less than 16px. This is a known issue with iOS and to disable this behavior, you can add the following meta tag in the <head> section of your HTML page:

<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />

Note that the user will still be able to manually zoom in on the UI.

The promise is getting rejected with OPERATION_CANCELLED error.

The SDK only shows one modal at a time. If a new action is triggered before the existing action is completed, the SDK will close the existing modal and reject the old Promise with OPERATION_CANCELLED error before opening a new modal for the new action.

Ā© Copyright 2024, Passbird Research Inc.