@faremeter/wallet-crossmint 0.16.0 → 0.17.0

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.
package/README.md CHANGED
@@ -25,10 +25,25 @@ pnpm install @faremeter/wallet-crossmint
25
25
 
26
26
  ### createCrossmintWallet
27
27
 
28
+ Creates a Crossmint custodial wallet for Solana.
29
+
30
+ Uses the Crossmint Wallets SDK to sign and send transactions via
31
+ API key authentication.
32
+
28
33
  | Function | Type |
29
34
  | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
30
35
  | `createCrossmintWallet` | `(network: string, crossmintApiKey: string, crossmintWalletAddress: string) => Promise<{ network: string; publicKey: PublicKey; sendTransaction: (tx: VersionedTransaction) => Promise<...>; }>` |
31
36
 
37
+ Parameters:
38
+
39
+ - `network`: - Solana network identifier.
40
+ - `crossmintApiKey`: - Crossmint API key for authentication.
41
+ - `crossmintWalletAddress`: - Address of the Crossmint-managed wallet.
42
+
43
+ Returns:
44
+
45
+ A wallet object that can send Solana transactions.
46
+
32
47
  <!-- TSDOC_END -->
33
48
 
34
49
  ## Related Packages
@@ -1,4 +1,21 @@
1
+ /**
2
+ * @title Crossmint Wallet Package
3
+ * @sidebarTitle Wallet Crossmint
4
+ * @description Crossmint custodial wallet integration for Solana
5
+ * @packageDocumentation
6
+ */
1
7
  import { PublicKey, VersionedTransaction } from "@solana/web3.js";
8
+ /**
9
+ * Creates a Crossmint custodial wallet for Solana.
10
+ *
11
+ * Uses the Crossmint Wallets SDK to sign and send transactions via
12
+ * API key authentication.
13
+ *
14
+ * @param network - Solana network identifier.
15
+ * @param crossmintApiKey - Crossmint API key for authentication.
16
+ * @param crossmintWalletAddress - Address of the Crossmint-managed wallet.
17
+ * @returns A wallet object that can send Solana transactions.
18
+ */
2
19
  export declare function createCrossmintWallet(network: string, crossmintApiKey: string, crossmintWalletAddress: string): Promise<{
3
20
  network: string;
4
21
  publicKey: PublicKey;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAOlE,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,EACvB,sBAAsB,EAAE,MAAM;;;0BAmBA,oBAAoB;GAQnD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAOlE;;;;;;;;;;GAUG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,EACvB,sBAAsB,EAAE,MAAM;;;0BAmBA,oBAAoB;GAQnD"}
package/dist/src/index.js CHANGED
@@ -1,5 +1,22 @@
1
+ /**
2
+ * @title Crossmint Wallet Package
3
+ * @sidebarTitle Wallet Crossmint
4
+ * @description Crossmint custodial wallet integration for Solana
5
+ * @packageDocumentation
6
+ */
1
7
  import { PublicKey, VersionedTransaction } from "@solana/web3.js";
2
8
  import { createCrossmint, CrossmintWallets, SolanaWallet, } from "@crossmint/wallets-sdk";
9
+ /**
10
+ * Creates a Crossmint custodial wallet for Solana.
11
+ *
12
+ * Uses the Crossmint Wallets SDK to sign and send transactions via
13
+ * API key authentication.
14
+ *
15
+ * @param network - Solana network identifier.
16
+ * @param crossmintApiKey - Crossmint API key for authentication.
17
+ * @param crossmintWalletAddress - Address of the Crossmint-managed wallet.
18
+ * @returns A wallet object that can send Solana transactions.
19
+ */
3
20
  export async function createCrossmintWallet(network, crossmintApiKey, crossmintWalletAddress) {
4
21
  const crossmint = createCrossmint({
5
22
  apiKey: crossmintApiKey,