@mezo-org/passport 0.1.0 → 0.2.0-dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +30 -2
  2. package/dist/src/config.d.ts +3 -0
  3. package/dist/src/config.d.ts.map +1 -1
  4. package/dist/src/config.js +10 -12
  5. package/dist/src/config.js.map +1 -1
  6. package/dist/src/constants.d.ts +1 -1
  7. package/dist/src/constants.d.ts.map +1 -1
  8. package/dist/src/constants.js +4 -4
  9. package/dist/src/constants.js.map +1 -1
  10. package/package.json +2 -2
  11. package/src/config.ts +11 -13
  12. package/src/constants.ts +4 -4
package/README.md CHANGED
@@ -101,7 +101,7 @@ import { RainbowKitProvider } from "@rainbow-me/rainbowkit"
101
101
  import { QueryClient, QueryClientProvider } from "@tanstack/react-query"
102
102
  import { WagmiProvider } from "wagmi"
103
103
  import "@rainbow-me/rainbowkit/styles.css"
104
- import { getConfig, matsnetTestnetChain } from "@mezo-org/passport"
104
+ import { getConfig, mezoMatsnetTestnetChain } from "@mezo-org/passport"
105
105
 
106
106
  const queryClient = new QueryClient()
107
107
 
@@ -109,7 +109,7 @@ ReactDOM.createRoot(document.getElementById("root")!).render(
109
109
  <React.StrictMode>
110
110
  <WagmiProvider config={getConfig({ appName: "Your app name" })}>
111
111
  <QueryClientProvider client={queryClient}>
112
- <RainbowKitProvider initialChain={matsnetTestnetChain}>
112
+ <RainbowKitProvider initialChain={mezoMatsnetTestnetChain}>
113
113
  {/* Your App component */}
114
114
  </RainbowKitProvider>
115
115
  </QueryClientProvider>
@@ -122,6 +122,34 @@ You can pass the same configuration options to `getConfig` as you would to
122
122
  `createDefaultConfig` from RainbowKit. For default config you only need to
123
123
  provide the `appName`.
124
124
 
125
+ Additionally, you can specify what bitcoin wallet from Mezo Passport you want to
126
+ support. By default, the lib supports Unisat, OKX and Xverse wallets. If you
127
+ want to include Unisat wallet only, you can pass it through `bitcoinWallet`
128
+ property to `getConfig` function:
129
+
130
+ ```
131
+ import { getConfig, unisatWallet } from "@mezo-org/passport"
132
+
133
+ const customBitcoinWallets = [
134
+ {
135
+ groupName: "Bitcoin wallets",
136
+ wallets: [unisatWallet],
137
+ },
138
+ ]
139
+
140
+ // and later pass it
141
+ <WagmiProvider
142
+ config={
143
+ getConfig({
144
+ appName: "Your app name",
145
+ bitcoinWallets: customBitcoinWallets,
146
+ })
147
+ }
148
+ >
149
+ (...)
150
+ </WagmiProvider>
151
+ ```
152
+
125
153
  #### Final steps
126
154
 
127
155
  That's pretty much it when it comes to configuration! As stated earlier, we
package/dist/src/config.d.ts CHANGED
@@ -8,6 +8,9 @@ export declare const defaultConfig: {
8
8
  chains: [Chain, ...Chain[]];
9
9
  multiInjectedProviderDiscovery: boolean;
10
10
  };
11
+ export declare const unisatWallet: import("@mezo-org/orangekit/dist/src/wallet/bitcoin-wallet-provider").CreateWalletFn;
12
+ export declare const okxWallet: import("@mezo-org/orangekit/dist/src/wallet/bitcoin-wallet-provider").CreateWalletFn;
13
+ export declare const xverseWallet: import("@mezo-org/orangekit/dist/src/wallet/bitcoin-wallet-provider").CreateWalletFn;
11
14
  export declare function getDefaultWallets(): WalletList;
12
15
  type WagmiConfigParameters = Omit<CreateConfigParameters, "client" | "connectors" | "chains" | "wallets" | "transports">;
13
16
  type GetDefaultConfigParameters = WagmiConfigParameters & {
package/dist/src/config.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAoB,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC5E,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAQtD,eAAO,MAAM,aAAa;;;;;;;CAKzB,CAAA;AAED,wBAAgB,iBAAiB,IAAI,UAAU,CAkB9C;AAED,KAAK,qBAAqB,GAAG,IAAI,CAC/B,sBAAsB,EACtB,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,CAC9D,CAAA;AACD,KAAK,0BAA0B,GAAG,qBAAqB,GAAG;IACxD,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,UAAU,CAAA;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;CAC7B,CAAA;AAED,wBAAgB,SAAS,CAAC,EACxB,OAAO,EACP,cAAc,EACd,sBAAsB,EACtB,GAAG,cAAc,EAClB,EAAE,0BAA0B,GAAG,MAAM,CAQrC"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAoB,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC5E,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAQtD,eAAO,MAAM,aAAa;;;;;;;CAKzB,CAAA;AAOD,eAAO,MAAM,YAAY,sFAAuC,CAAA;AAChE,eAAO,MAAM,SAAS,sFAAoC,CAAA;AAC1D,eAAO,MAAM,YAAY,sFAAuC,CAAA;AAEhE,wBAAgB,iBAAiB,IAAI,UAAU,CAO9C;AAED,KAAK,qBAAqB,GAAG,IAAI,CAC/B,sBAAsB,EACtB,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,CAC9D,CAAA;AACD,KAAK,0BAA0B,GAAG,qBAAqB,GAAG;IACxD,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,UAAU,CAAA;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;CAC7B,CAAA;AAED,wBAAgB,SAAS,CAAC,EACxB,OAAO,EACP,cAAc,EACd,sBAAsB,EACtB,GAAG,cAAc,EAClB,EAAE,0BAA0B,GAAG,MAAM,CAQrC"}
package/dist/src/config.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import { http } from "viem";
2
2
  import { getDefaultConfig } from "@rainbow-me/rainbowkit";
3
- import { CHAIN_ID, matsnetTestnetChain, RPC_BY_NETWORK } from "./constants";
3
+ import { CHAIN_ID, mezoMatsnetTestnetChain, RPC_BY_NETWORK } from "./constants";
4
4
  import { getOKXWallet, getUnisatWallet, getXverseWallet } from "./wallet";
5
5
  const transports = {
6
6
  [CHAIN_ID.testnet]: http(RPC_BY_NETWORK.testnet),
@@ -8,19 +8,17 @@ const transports = {
8
8
  export const defaultConfig = {
9
9
  transports,
10
10
  walletConnectProjectId: "",
11
- chains: [matsnetTestnetChain],
11
+ chains: [mezoMatsnetTestnetChain],
12
12
  multiInjectedProviderDiscovery: true,
13
13
  };
14
+ const bitcoinWalletConfig = {
15
+ rpcUrl: RPC_BY_NETWORK.testnet,
16
+ chainId: CHAIN_ID.testnet,
17
+ };
18
+ export const unisatWallet = getUnisatWallet(bitcoinWalletConfig);
19
+ export const okxWallet = getOKXWallet(bitcoinWalletConfig);
20
+ export const xverseWallet = getXverseWallet(bitcoinWalletConfig);
14
21
  export function getDefaultWallets() {
15
- const bitcoinWalletConfig = {
16
- rpcUrl: RPC_BY_NETWORK.testnet,
17
- chainId: CHAIN_ID.testnet,
18
- // TODO: This will be removed once we merge passport relay worked is merged
19
- relayApiKey: "",
20
- };
21
- const unisatWallet = getUnisatWallet(bitcoinWalletConfig);
22
- const okxWallet = getOKXWallet(bitcoinWalletConfig);
23
- const xverseWallet = getXverseWallet(bitcoinWalletConfig);
24
22
  return [
25
23
  {
26
24
  groupName: "Bitcoin",
@@ -32,7 +30,7 @@ export function getConfig({ appName, bitcoinWallets, walletConnectProjectId, ...
32
30
  return getDefaultConfig({
33
31
  ...defaultConfig,
34
32
  appName,
35
- wallets: [...getDefaultWallets(), ...(bitcoinWallets ?? [])],
33
+ wallets: [...(bitcoinWallets ?? getDefaultWallets())],
36
34
  projectId: walletConnectProjectId ?? defaultConfig.walletConnectProjectId,
37
35
  ...restParameters,
38
36
  });
package/dist/src/config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAS,gBAAgB,EAAc,MAAM,wBAAwB,CAAA;AAE5E,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC3E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAEzE,MAAM,UAAU,GAAG;IACjB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;CACjD,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,UAAU;IACV,sBAAsB,EAAE,EAAE;IAC1B,MAAM,EAAE,CAAC,mBAAmB,CAAwB;IACpD,8BAA8B,EAAE,IAAI;CACrC,CAAA;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,mBAAmB,GAAG;QAC1B,MAAM,EAAE,cAAc,CAAC,OAAO;QAC9B,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,2EAA2E;QAC3E,WAAW,EAAE,EAAE;KAChB,CAAA;IAED,MAAM,YAAY,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAA;IACzD,MAAM,SAAS,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAA;IACnD,MAAM,YAAY,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAA;IAEzD,OAAO;QACL;YACE,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,YAAY,CAAC;SACjD;KACF,CAAA;AACH,CAAC;AAgBD,MAAM,UAAU,SAAS,CAAC,EACxB,OAAO,EACP,cAAc,EACd,sBAAsB,EACtB,GAAG,cAAc,EACU;IAC3B,OAAO,gBAAgB,CAAC;QACtB,GAAG,aAAa;QAChB,OAAO;QACP,OAAO,EAAE,CAAC,GAAG,iBAAiB,EAAE,EAAE,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;QAC5D,SAAS,EAAE,sBAAsB,IAAI,aAAa,CAAC,sBAAsB;QACzE,GAAG,cAAc;KAClB,CAAC,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAS,gBAAgB,EAAc,MAAM,wBAAwB,CAAA;AAE5E,OAAO,EAAE,QAAQ,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC/E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAEzE,MAAM,UAAU,GAAG;IACjB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;CACjD,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,UAAU;IACV,sBAAsB,EAAE,EAAE;IAC1B,MAAM,EAAE,CAAC,uBAAuB,CAAwB;IACxD,8BAA8B,EAAE,IAAI;CACrC,CAAA;AAED,MAAM,mBAAmB,GAAG;IAC1B,MAAM,EAAE,cAAc,CAAC,OAAO;IAC9B,OAAO,EAAE,QAAQ,CAAC,OAAO;CAC1B,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAA;AAChE,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAC1D,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAA;AAEhE,MAAM,UAAU,iBAAiB;IAC/B,OAAO;QACL;YACE,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,YAAY,CAAC;SACjD;KACF,CAAA;AACH,CAAC;AAgBD,MAAM,UAAU,SAAS,CAAC,EACxB,OAAO,EACP,cAAc,EACd,sBAAsB,EACtB,GAAG,cAAc,EACU;IAC3B,OAAO,gBAAgB,CAAC;QACtB,GAAG,aAAa;QAChB,OAAO;QACP,OAAO,EAAE,CAAC,GAAG,CAAC,cAAc,IAAI,iBAAiB,EAAE,CAAC,CAAC;QACrD,SAAS,EAAE,sBAAsB,IAAI,aAAa,CAAC,sBAAsB;QACzE,GAAG,cAAc;KAClB,CAAC,CAAA;AACJ,CAAC"}
package/dist/src/constants.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { matsnetTestnetChain } from "@mezo-org/orangekit";
1
+ export { mezoMatsnetTestnetChain } from "@mezo-org/orangekit";
2
2
  export declare const CHAIN_ID: {
3
3
  testnet: 31611;
4
4
  };
package/dist/src/constants.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD,eAAO,MAAM,QAAQ;;CAEpB,CAAA;AAED,eAAO,MAAM,cAAc;;CAE1B,CAAA"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,eAAO,MAAM,QAAQ;;CAEpB,CAAA;AAED,eAAO,MAAM,cAAc;;CAE1B,CAAA"}
package/dist/src/constants.js CHANGED
@@ -1,9 +1,9 @@
1
- import { matsnetTestnetChain } from "@mezo-org/orangekit";
2
- export { matsnetTestnetChain } from "@mezo-org/orangekit";
1
+ import { mezoMatsnetTestnetChain } from "@mezo-org/orangekit";
2
+ export { mezoMatsnetTestnetChain } from "@mezo-org/orangekit";
3
3
  export const CHAIN_ID = {
4
- testnet: matsnetTestnetChain.id,
4
+ testnet: mezoMatsnetTestnetChain.id,
5
5
  };
6
6
  export const RPC_BY_NETWORK = {
7
- testnet: matsnetTestnetChain.rpcUrls.default.http[0],
7
+ testnet: mezoMatsnetTestnetChain.rpcUrls.default.http[0],
8
8
  };
9
9
  //# sourceMappingURL=constants.js.map
package/dist/src/constants.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,mBAAmB,CAAC,EAAE;CAChC,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;CACrD,CAAA"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,uBAAuB,CAAC,EAAE;CACpC,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;CACzD,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mezo-org/passport",
3
- "version": "0.1.0",
3
+ "version": "0.2.0-dev.1",
4
4
  "main": "dist/src/index.js",
5
5
  "license": "GPL-3.0-only",
6
6
  "scripts": {
@@ -36,7 +36,7 @@
36
36
  "typescript": "^5.4.3"
37
37
  },
38
38
  "dependencies": {
39
- "@mezo-org/orangekit": "1.0.0-beta.36",
39
+ "@mezo-org/orangekit": "1.0.0-beta.38-dev.0",
40
40
  "@rainbow-me/rainbowkit": "2.0.2",
41
41
  "react": "^18.2.0",
42
42
  "viem": "2.8.16",
package/src/config.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { http } from "viem"
2
2
  import { Chain, getDefaultConfig, WalletList } from "@rainbow-me/rainbowkit"
3
3
  import { Config, CreateConfigParameters } from "wagmi"
4
- import { CHAIN_ID, matsnetTestnetChain, RPC_BY_NETWORK } from "./constants"
4
+ import { CHAIN_ID, mezoMatsnetTestnetChain, RPC_BY_NETWORK } from "./constants"
5
5
  import { getOKXWallet, getUnisatWallet, getXverseWallet } from "./wallet"
6
6
 
7
7
  const transports = {
@@ -11,22 +11,20 @@ const transports = {
11
11
  export const defaultConfig = {
12
12
  transports,
13
13
  walletConnectProjectId: "",
14
- chains: [matsnetTestnetChain] as [Chain, ...Chain[]],
14
+ chains: [mezoMatsnetTestnetChain] as [Chain, ...Chain[]],
15
15
  multiInjectedProviderDiscovery: true,
16
16
  }
17
17
 
18
- export function getDefaultWallets(): WalletList {
19
- const bitcoinWalletConfig = {
20
- rpcUrl: RPC_BY_NETWORK.testnet,
21
- chainId: CHAIN_ID.testnet,
22
- // TODO: This will be removed once we merge passport relay worked is merged
23
- relayApiKey: "",
24
- }
18
+ const bitcoinWalletConfig = {
19
+ rpcUrl: RPC_BY_NETWORK.testnet,
20
+ chainId: CHAIN_ID.testnet,
21
+ }
25
22
 
26
- const unisatWallet = getUnisatWallet(bitcoinWalletConfig)
27
- const okxWallet = getOKXWallet(bitcoinWalletConfig)
28
- const xverseWallet = getXverseWallet(bitcoinWalletConfig)
23
+ export const unisatWallet = getUnisatWallet(bitcoinWalletConfig)
24
+ export const okxWallet = getOKXWallet(bitcoinWalletConfig)
25
+ export const xverseWallet = getXverseWallet(bitcoinWalletConfig)
29
26
 
27
+ export function getDefaultWallets(): WalletList {
30
28
  return [
31
29
  {
32
30
  groupName: "Bitcoin",
@@ -58,7 +56,7 @@ export function getConfig({
58
56
  return getDefaultConfig({
59
57
  ...defaultConfig,
60
58
  appName,
61
- wallets: [...getDefaultWallets(), ...(bitcoinWallets ?? [])],
59
+ wallets: [...(bitcoinWallets ?? getDefaultWallets())],
62
60
  projectId: walletConnectProjectId ?? defaultConfig.walletConnectProjectId,
63
61
  ...restParameters,
64
62
  })
package/src/constants.ts CHANGED
@@ -1,11 +1,11 @@
1
- import { matsnetTestnetChain } from "@mezo-org/orangekit"
1
+ import { mezoMatsnetTestnetChain } from "@mezo-org/orangekit"
2
2
 
3
- export { matsnetTestnetChain } from "@mezo-org/orangekit"
3
+ export { mezoMatsnetTestnetChain } from "@mezo-org/orangekit"
4
4
 
5
5
  export const CHAIN_ID = {
6
- testnet: matsnetTestnetChain.id,
6
+ testnet: mezoMatsnetTestnetChain.id,
7
7
  }
8
8
 
9
9
  export const RPC_BY_NETWORK = {
10
- testnet: matsnetTestnetChain.rpcUrls.default.http[0],
10
+ testnet: mezoMatsnetTestnetChain.rpcUrls.default.http[0],
11
11
  }