@settlemint/sdk-portal 2.3.0 → 2.3.1-pr9c56c214
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 +16 -16
- package/dist/portal.mjs +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -368,7 +368,7 @@ console.log("Transaction hash:", result.StableCoinFactoryCreate?.transactionHash
|
|
|
368
368
|
|
|
369
369
|
> **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
|
|
370
370
|
|
|
371
|
-
Defined in: [sdk/portal/src/portal.ts:71](https://github.com/settlemint/sdk/blob/v2.3.
|
|
371
|
+
Defined in: [sdk/portal/src/portal.ts:71](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L71)
|
|
372
372
|
|
|
373
373
|
Creates a Portal GraphQL client with the provided configuration.
|
|
374
374
|
|
|
@@ -396,8 +396,8 @@ An object containing the configured GraphQL client and graphql helper function
|
|
|
396
396
|
|
|
397
397
|
| Name | Type | Defined in |
|
|
398
398
|
| ------ | ------ | ------ |
|
|
399
|
-
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:75](https://github.com/settlemint/sdk/blob/v2.3.
|
|
400
|
-
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.3.
|
|
399
|
+
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:75](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L75) |
|
|
400
|
+
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L76) |
|
|
401
401
|
|
|
402
402
|
##### Throws
|
|
403
403
|
|
|
@@ -449,7 +449,7 @@ const result = await portalClient.request(query);
|
|
|
449
449
|
|
|
450
450
|
> **getWebsocketClient**(`options`): `Client`
|
|
451
451
|
|
|
452
|
-
Defined in: [sdk/portal/src/utils/websocket-client.ts:23](https://github.com/settlemint/sdk/blob/v2.3.
|
|
452
|
+
Defined in: [sdk/portal/src/utils/websocket-client.ts:23](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/websocket-client.ts#L23)
|
|
453
453
|
|
|
454
454
|
Creates a GraphQL WebSocket client for the Portal API
|
|
455
455
|
|
|
@@ -471,7 +471,7 @@ The GraphQL WebSocket client
|
|
|
471
471
|
|
|
472
472
|
> **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
|
|
473
473
|
|
|
474
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:106](https://github.com/settlemint/sdk/blob/v2.3.
|
|
474
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:106](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/wallet-verification-challenge.ts#L106)
|
|
475
475
|
|
|
476
476
|
Handles a wallet verification challenge by generating an appropriate response
|
|
477
477
|
|
|
@@ -524,7 +524,7 @@ const result = await handleWalletVerificationChallenge({
|
|
|
524
524
|
|
|
525
525
|
> **waitForTransactionReceipt**(`transactionHash`, `options`): `Promise`\<[`Transaction`](#transaction)\>
|
|
526
526
|
|
|
527
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:79](https://github.com/settlemint/sdk/blob/v2.3.
|
|
527
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:79](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L79)
|
|
528
528
|
|
|
529
529
|
Waits for a blockchain transaction receipt by subscribing to transaction updates via GraphQL.
|
|
530
530
|
This function polls until the transaction is confirmed or the timeout is reached.
|
|
@@ -562,7 +562,7 @@ const transaction = await waitForTransactionReceipt("0x123...", {
|
|
|
562
562
|
|
|
563
563
|
#### HandleWalletVerificationChallengeOptions\<Setup\>
|
|
564
564
|
|
|
565
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:73](https://github.com/settlemint/sdk/blob/v2.3.
|
|
565
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:73](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/wallet-verification-challenge.ts#L73)
|
|
566
566
|
|
|
567
567
|
Options for handling a wallet verification challenge
|
|
568
568
|
|
|
@@ -576,7 +576,7 @@ Options for handling a wallet verification challenge
|
|
|
576
576
|
|
|
577
577
|
#### Transaction
|
|
578
578
|
|
|
579
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.3.
|
|
579
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L26)
|
|
580
580
|
|
|
581
581
|
Represents the structure of a blockchain transaction with its receipt
|
|
582
582
|
|
|
@@ -584,7 +584,7 @@ Represents the structure of a blockchain transaction with its receipt
|
|
|
584
584
|
|
|
585
585
|
#### WaitForTransactionReceiptOptions
|
|
586
586
|
|
|
587
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.3.
|
|
587
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L57)
|
|
588
588
|
|
|
589
589
|
Options for waiting for a transaction receipt
|
|
590
590
|
|
|
@@ -596,7 +596,7 @@ Options for waiting for a transaction receipt
|
|
|
596
596
|
|
|
597
597
|
#### WebsocketClientOptions
|
|
598
598
|
|
|
599
|
-
Defined in: [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.3.
|
|
599
|
+
Defined in: [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/utils/websocket-client.ts#L10)
|
|
600
600
|
|
|
601
601
|
Options for the GraphQL WebSocket client
|
|
602
602
|
|
|
@@ -610,7 +610,7 @@ Options for the GraphQL WebSocket client
|
|
|
610
610
|
|
|
611
611
|
> **ClientOptions** = `object`
|
|
612
612
|
|
|
613
|
-
Defined in: [sdk/portal/src/portal.ts:24](https://github.com/settlemint/sdk/blob/v2.3.
|
|
613
|
+
Defined in: [sdk/portal/src/portal.ts:24](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L24)
|
|
614
614
|
|
|
615
615
|
Type representing the validated client options.
|
|
616
616
|
|
|
@@ -618,9 +618,9 @@ Type representing the validated client options.
|
|
|
618
618
|
|
|
619
619
|
| Name | Type | Default value | Defined in |
|
|
620
620
|
| ------ | ------ | ------ | ------ |
|
|
621
|
-
| <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.3.
|
|
622
|
-
| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.3.
|
|
623
|
-
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.3.
|
|
621
|
+
| <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L17) |
|
|
622
|
+
| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L18) |
|
|
623
|
+
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L16) |
|
|
624
624
|
|
|
625
625
|
***
|
|
626
626
|
|
|
@@ -628,7 +628,7 @@ Type representing the validated client options.
|
|
|
628
628
|
|
|
629
629
|
> **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
|
|
630
630
|
|
|
631
|
-
Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v2.3.
|
|
631
|
+
Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L10)
|
|
632
632
|
|
|
633
633
|
Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
634
634
|
|
|
@@ -638,7 +638,7 @@ Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
|
638
638
|
|
|
639
639
|
> `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
|
|
640
640
|
|
|
641
|
-
Defined in: [sdk/portal/src/portal.ts:15](https://github.com/settlemint/sdk/blob/v2.3.
|
|
641
|
+
Defined in: [sdk/portal/src/portal.ts:15](https://github.com/settlemint/sdk/blob/v2.3.1/sdk/portal/src/portal.ts#L15)
|
|
642
642
|
|
|
643
643
|
Schema for validating Portal client configuration options.
|
|
644
644
|
|
package/dist/portal.mjs
CHANGED
|
@@ -6,7 +6,7 @@ import { GraphQLClient } from "graphql-request";
|
|
|
6
6
|
import { z } from "zod";
|
|
7
7
|
|
|
8
8
|
// src/utils/wallet-verification-challenge.ts
|
|
9
|
-
import { createHash } from "
|
|
9
|
+
import { createHash } from "crypto";
|
|
10
10
|
var ChallengeError = class extends Error {
|
|
11
11
|
code;
|
|
12
12
|
constructor(message, code) {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-portal",
|
|
3
3
|
"description": "Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs",
|
|
4
|
-
"version": "2.3.
|
|
4
|
+
"version": "2.3.1-pr9c56c214",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"dependencies": {
|
|
57
57
|
"gql.tada": "^1",
|
|
58
58
|
"graphql-ws": "^6",
|
|
59
|
-
"@settlemint/sdk-utils": "2.3.
|
|
59
|
+
"@settlemint/sdk-utils": "2.3.1-pr9c56c214",
|
|
60
60
|
"graphql-request": "^7",
|
|
61
61
|
"zod": "^3"
|
|
62
62
|
},
|