Configurations

As seen before, to initialise Quirks it is necessary to pass an object with a valid configuration. Currently the library supports several configuration parameters to customise different layers (e.g. choose the storage type, the wallets to use, etc.).

Below is an in-depth look at all the elements that make up the Config type.

Usage

import { type Config, ssrPersistOptions } from "@quirks/store";
import {
  keplrExtension,
  leapExtension,
  xdefiExtension,
  cosmostationExtension,
  universalWalletConnect,
} from "@quirks/wallets";
import {
  chain as osmosis,
  assets as osmosisAssetList,
} from 'chain-registry/mainnet/osmosis';
 
const config: Config = {
  wallets: [
    keplrExtension,
    leapExtension,
    cosmostationExtension,
    xdefiExtension,
    universalWalletConnect,
  ],
  chains: [osmosis],
  assetsLists: [osmosisAssetList],
  persistOptions: ssrPersistOptions,
  walletConnectOptions: {
    providerOpts: {
      logger: "info",
      projectId: "<YOUR-PROJECT-ID>",
      metadata: {
        name: "React App",
        description: "React App for WalletConnect",
        url: "https://walletconnect.com/",
        icons: ["https://avatars.githubusercontent.com/u/37784886"],
      },
    },
  },
};

Types

Prop	Type	Default
`walletConnectOptions?`	`WalletConnectOptions`	-
`persistOptions?`	`PersistOptions<AppState>`	`defaultPersistOptions`
`signerOptions?`	`SignerOptions`	-
`signOptions?`	`SignOptions`	-
`autoSuggestions?`	`boolean`	`true`
`autoConnect?`	`boolean`	`true`
`assetsLists?`	`AssetLists[]`	`[]`
`chains?`	`Chain[]`	`[]`
`wallets?`	`Wallet[]`	`[]`

SignOptions

Prop	Type	Default
`disableBalanceCheck?`	`boolean`	`true`
`preferNoSetMemo?`	`boolean`	`true`
`preferNoSetFee?`	`boolean`	`false`

SignerOptions

Prop	Type	Default
`signingCosmwasm?`	`(chain: Chain) => Promise<SigningStargateClientOptions \| undefined>`	-
`signingStargate?`	`(chain: Chain) => Promise<SigningStargateClientOptions \| undefined>`	-
`stargate?`	`(chain: Chain) => Promise<StargateClientOptions \| undefined>`	-

WalletConnectOptions

Prop	Type	Default
`namespaces?`	`{ cosmos: Omit<Namespace, 'chains'> }`	`{ cosmos: { methods: ['cosmos_getAccounts', 'cosmos_signDirect', 'cosmos_signAmino'], chains: [], events: ['chainChanged', 'accountsChanged'], }, }`
`providerOpts?`	`UniversalProviderOpts`	-