@settlemint/sdk-portal 2.5.10 → 2.5.11
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 +42 -42
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -601,7 +601,7 @@ console.log("Transaction hash:", result.StableCoinFactoryCreate?.transactionHash
|
|
|
601
601
|
|
|
602
602
|
> **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
|
|
603
603
|
|
|
604
|
-
Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.5.
|
|
604
|
+
Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L72)
|
|
605
605
|
|
|
606
606
|
Creates a Portal GraphQL client with the provided configuration.
|
|
607
607
|
|
|
@@ -629,8 +629,8 @@ An object containing the configured GraphQL client and graphql helper function
|
|
|
629
629
|
|
|
630
630
|
| Name | Type | Defined in |
|
|
631
631
|
| ------ | ------ | ------ |
|
|
632
|
-
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.5.
|
|
633
|
-
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.5.
|
|
632
|
+
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L76) |
|
|
633
|
+
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L77) |
|
|
634
634
|
|
|
635
635
|
##### Throws
|
|
636
636
|
|
|
@@ -682,7 +682,7 @@ const result = await portalClient.request(query);
|
|
|
682
682
|
|
|
683
683
|
> **getWebsocketClient**(`options`): `Client`
|
|
684
684
|
|
|
685
|
-
Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.5.
|
|
685
|
+
Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/websocket-client.ts#L30)
|
|
686
686
|
|
|
687
687
|
Creates a GraphQL WebSocket client for the Portal API
|
|
688
688
|
|
|
@@ -715,7 +715,7 @@ const client = getWebsocketClient({
|
|
|
715
715
|
|
|
716
716
|
> **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
|
|
717
717
|
|
|
718
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:103](https://github.com/settlemint/sdk/blob/v2.5.
|
|
718
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:103](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L103)
|
|
719
719
|
|
|
720
720
|
Handles a wallet verification challenge by generating an appropriate response
|
|
721
721
|
|
|
@@ -768,7 +768,7 @@ const result = await handleWalletVerificationChallenge({
|
|
|
768
768
|
|
|
769
769
|
> **waitForTransactionReceipt**(`transactionHash`, `options`): `Promise`\<[`Transaction`](#transaction)\>
|
|
770
770
|
|
|
771
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.5.
|
|
771
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L80)
|
|
772
772
|
|
|
773
773
|
Waits for a blockchain transaction receipt by subscribing to transaction updates via GraphQL.
|
|
774
774
|
This function polls until the transaction is confirmed or the timeout is reached.
|
|
@@ -806,7 +806,7 @@ const transaction = await waitForTransactionReceipt("0x123...", {
|
|
|
806
806
|
|
|
807
807
|
#### HandleWalletVerificationChallengeOptions\<Setup\>
|
|
808
808
|
|
|
809
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:64](https://github.com/settlemint/sdk/blob/v2.5.
|
|
809
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:64](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L64)
|
|
810
810
|
|
|
811
811
|
Options for handling a wallet verification challenge
|
|
812
812
|
|
|
@@ -820,18 +820,18 @@ Options for handling a wallet verification challenge
|
|
|
820
820
|
|
|
821
821
|
| Property | Type | Description | Defined in |
|
|
822
822
|
| ------ | ------ | ------ | ------ |
|
|
823
|
-
| <a id="code"></a> `code` | `string` \| `number` | The verification code provided by the user | [sdk/portal/src/utils/wallet-verification-challenge.ts:74](https://github.com/settlemint/sdk/blob/v2.5.
|
|
824
|
-
| <a id="portalclient"></a> `portalClient` | `GraphQLClient` | The portal client instance | [sdk/portal/src/utils/wallet-verification-challenge.ts:66](https://github.com/settlemint/sdk/blob/v2.5.
|
|
825
|
-
| <a id="portalgraphql"></a> `portalGraphql` | `initGraphQLTada`\<`Setup`\> | The GraphQL query builder | [sdk/portal/src/utils/wallet-verification-challenge.ts:68](https://github.com/settlemint/sdk/blob/v2.5.
|
|
826
|
-
| <a id="userwalletaddress"></a> `userWalletAddress` | `` `0x${string}` `` | The wallet address to verify | [sdk/portal/src/utils/wallet-verification-challenge.ts:72](https://github.com/settlemint/sdk/blob/v2.5.
|
|
827
|
-
| <a id="verificationid"></a> `verificationId` | `string` | The ID of the verification challenge | [sdk/portal/src/utils/wallet-verification-challenge.ts:70](https://github.com/settlemint/sdk/blob/v2.5.
|
|
828
|
-
| <a id="verificationtype"></a> `verificationType` | `"otp"` \| `"secret-code"` \| `"pincode"` | The type of verification being performed | [sdk/portal/src/utils/wallet-verification-challenge.ts:76](https://github.com/settlemint/sdk/blob/v2.5.
|
|
823
|
+
| <a id="code"></a> `code` | `string` \| `number` | The verification code provided by the user | [sdk/portal/src/utils/wallet-verification-challenge.ts:74](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L74) |
|
|
824
|
+
| <a id="portalclient"></a> `portalClient` | `GraphQLClient` | The portal client instance | [sdk/portal/src/utils/wallet-verification-challenge.ts:66](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L66) |
|
|
825
|
+
| <a id="portalgraphql"></a> `portalGraphql` | `initGraphQLTada`\<`Setup`\> | The GraphQL query builder | [sdk/portal/src/utils/wallet-verification-challenge.ts:68](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L68) |
|
|
826
|
+
| <a id="userwalletaddress"></a> `userWalletAddress` | `` `0x${string}` `` | The wallet address to verify | [sdk/portal/src/utils/wallet-verification-challenge.ts:72](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L72) |
|
|
827
|
+
| <a id="verificationid"></a> `verificationId` | `string` | The ID of the verification challenge | [sdk/portal/src/utils/wallet-verification-challenge.ts:70](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L70) |
|
|
828
|
+
| <a id="verificationtype"></a> `verificationType` | `"otp"` \| `"secret-code"` \| `"pincode"` | The type of verification being performed | [sdk/portal/src/utils/wallet-verification-challenge.ts:76](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wallet-verification-challenge.ts#L76) |
|
|
829
829
|
|
|
830
830
|
***
|
|
831
831
|
|
|
832
832
|
#### Transaction
|
|
833
833
|
|
|
834
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.5.
|
|
834
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L34)
|
|
835
835
|
|
|
836
836
|
Represents the structure of a blockchain transaction with its receipt
|
|
837
837
|
|
|
@@ -839,18 +839,18 @@ Represents the structure of a blockchain transaction with its receipt
|
|
|
839
839
|
|
|
840
840
|
| Property | Type | Description | Defined in |
|
|
841
841
|
| ------ | ------ | ------ | ------ |
|
|
842
|
-
| <a id="address"></a> `address` | `string` | The contract address involved in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:43](https://github.com/settlemint/sdk/blob/v2.5.
|
|
843
|
-
| <a id="createdat"></a> `createdAt` | `string` | Timestamp when the transaction was created | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:41](https://github.com/settlemint/sdk/blob/v2.5.
|
|
844
|
-
| <a id="from"></a> `from` | `string` | The sender address (duplicate of receipt.from) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:39](https://github.com/settlemint/sdk/blob/v2.5.
|
|
845
|
-
| <a id="functionname"></a> `functionName` | `string` | The name of the function called in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:45](https://github.com/settlemint/sdk/blob/v2.5.
|
|
846
|
-
| <a id="iscontract"></a> `isContract` | `boolean` | Whether the transaction is a contract deployment | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:47](https://github.com/settlemint/sdk/blob/v2.5.
|
|
847
|
-
| <a id="transactionhash"></a> `transactionHash` | `string` | The hash of the transaction (duplicate of receipt.transactionHash) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:37](https://github.com/settlemint/sdk/blob/v2.5.
|
|
842
|
+
| <a id="address"></a> `address` | `string` | The contract address involved in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:43](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L43) |
|
|
843
|
+
| <a id="createdat"></a> `createdAt` | `string` | Timestamp when the transaction was created | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:41](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L41) |
|
|
844
|
+
| <a id="from"></a> `from` | `string` | The sender address (duplicate of receipt.from) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:39](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L39) |
|
|
845
|
+
| <a id="functionname"></a> `functionName` | `string` | The name of the function called in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:45](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L45) |
|
|
846
|
+
| <a id="iscontract"></a> `isContract` | `boolean` | Whether the transaction is a contract deployment | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:47](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L47) |
|
|
847
|
+
| <a id="transactionhash"></a> `transactionHash` | `string` | The hash of the transaction (duplicate of receipt.transactionHash) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:37](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L37) |
|
|
848
848
|
|
|
849
849
|
***
|
|
850
850
|
|
|
851
851
|
#### TransactionEvent
|
|
852
852
|
|
|
853
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:8](https://github.com/settlemint/sdk/blob/v2.5.
|
|
853
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:8](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L8)
|
|
854
854
|
|
|
855
855
|
Represents an event emitted during a transaction execution
|
|
856
856
|
|
|
@@ -858,15 +858,15 @@ Represents an event emitted during a transaction execution
|
|
|
858
858
|
|
|
859
859
|
| Property | Type | Description | Defined in |
|
|
860
860
|
| ------ | ------ | ------ | ------ |
|
|
861
|
-
| <a id="args"></a> `args` | `Record`\<`string`, `unknown`\> | The arguments emitted by the event | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:12](https://github.com/settlemint/sdk/blob/v2.5.
|
|
862
|
-
| <a id="eventname"></a> `eventName` | `string` | The name of the event that was emitted | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:10](https://github.com/settlemint/sdk/blob/v2.5.
|
|
863
|
-
| <a id="topics"></a> `topics` | `` `0x${string}` ``[] | Indexed event parameters used for filtering and searching | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
861
|
+
| <a id="args"></a> `args` | `Record`\<`string`, `unknown`\> | The arguments emitted by the event | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:12](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L12) |
|
|
862
|
+
| <a id="eventname"></a> `eventName` | `string` | The name of the event that was emitted | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:10](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L10) |
|
|
863
|
+
| <a id="topics"></a> `topics` | `` `0x${string}` ``[] | Indexed event parameters used for filtering and searching | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:14](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L14) |
|
|
864
864
|
|
|
865
865
|
***
|
|
866
866
|
|
|
867
867
|
#### TransactionReceipt
|
|
868
868
|
|
|
869
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:20](https://github.com/settlemint/sdk/blob/v2.5.
|
|
869
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:20](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L20)
|
|
870
870
|
|
|
871
871
|
Represents the structure of a blockchain transaction receipt
|
|
872
872
|
|
|
@@ -878,16 +878,16 @@ Represents the structure of a blockchain transaction receipt
|
|
|
878
878
|
|
|
879
879
|
| Property | Type | Description | Overrides | Defined in |
|
|
880
880
|
| ------ | ------ | ------ | ------ | ------ |
|
|
881
|
-
| <a id="contractaddress"></a> `contractAddress` | `` `0x${string}` `` | The address of the contract deployed in the transaction | `TransactionReceiptViem.contractAddress` | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:28](https://github.com/settlemint/sdk/blob/v2.5.
|
|
882
|
-
| <a id="events"></a> `events` | [`TransactionEvent`](#transactionevent)[] | Array of events emitted during the transaction | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.5.
|
|
883
|
-
| <a id="revertreason"></a> `revertReason` | `string` | The raw reason for transaction reversion, if applicable | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:22](https://github.com/settlemint/sdk/blob/v2.5.
|
|
884
|
-
| <a id="revertreasondecoded"></a> `revertReasonDecoded` | `string` | Human-readable version of the revert reason | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:24](https://github.com/settlemint/sdk/blob/v2.5.
|
|
881
|
+
| <a id="contractaddress"></a> `contractAddress` | `` `0x${string}` `` | The address of the contract deployed in the transaction | `TransactionReceiptViem.contractAddress` | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:28](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L28) |
|
|
882
|
+
| <a id="events"></a> `events` | [`TransactionEvent`](#transactionevent)[] | Array of events emitted during the transaction | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L26) |
|
|
883
|
+
| <a id="revertreason"></a> `revertReason` | `string` | The raw reason for transaction reversion, if applicable | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:22](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L22) |
|
|
884
|
+
| <a id="revertreasondecoded"></a> `revertReasonDecoded` | `string` | Human-readable version of the revert reason | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:24](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L24) |
|
|
885
885
|
|
|
886
886
|
***
|
|
887
887
|
|
|
888
888
|
#### WaitForTransactionReceiptOptions
|
|
889
889
|
|
|
890
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.5.
|
|
890
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L57)
|
|
891
891
|
|
|
892
892
|
Options for waiting for a transaction receipt
|
|
893
893
|
|
|
@@ -899,15 +899,15 @@ Options for waiting for a transaction receipt
|
|
|
899
899
|
|
|
900
900
|
| Property | Type | Description | Inherited from | Defined in |
|
|
901
901
|
| ------ | ------ | ------ | ------ | ------ |
|
|
902
|
-
| <a id="accesstoken"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`accessToken`](#accesstoken-1) | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
903
|
-
| <a id="portalgraphqlendpoint"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`portalGraphqlEndpoint`](#portalgraphqlendpoint-1) | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.5.
|
|
904
|
-
| <a id="timeout"></a> `timeout?` | `number` | Optional timeout in milliseconds before the operation fails | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:59](https://github.com/settlemint/sdk/blob/v2.5.
|
|
902
|
+
| <a id="accesstoken"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`accessToken`](#accesstoken-1) | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/websocket-client.ts#L14) |
|
|
903
|
+
| <a id="portalgraphqlendpoint"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`portalGraphqlEndpoint`](#portalgraphqlendpoint-1) | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/websocket-client.ts#L10) |
|
|
904
|
+
| <a id="timeout"></a> `timeout?` | `number` | Optional timeout in milliseconds before the operation fails | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:59](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L59) |
|
|
905
905
|
|
|
906
906
|
***
|
|
907
907
|
|
|
908
908
|
#### WebsocketClientOptions
|
|
909
909
|
|
|
910
|
-
Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.5.
|
|
910
|
+
Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/websocket-client.ts#L6)
|
|
911
911
|
|
|
912
912
|
Options for the GraphQL WebSocket client
|
|
913
913
|
|
|
@@ -919,8 +919,8 @@ Options for the GraphQL WebSocket client
|
|
|
919
919
|
|
|
920
920
|
| Property | Type | Description | Defined in |
|
|
921
921
|
| ------ | ------ | ------ | ------ |
|
|
922
|
-
| <a id="accesstoken-1"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.5.
|
|
923
|
-
| <a id="portalgraphqlendpoint-1"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.5.
|
|
922
|
+
| <a id="accesstoken-1"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/websocket-client.ts#L14) |
|
|
923
|
+
| <a id="portalgraphqlendpoint-1"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/utils/websocket-client.ts#L10) |
|
|
924
924
|
|
|
925
925
|
### Type Aliases
|
|
926
926
|
|
|
@@ -928,7 +928,7 @@ Options for the GraphQL WebSocket client
|
|
|
928
928
|
|
|
929
929
|
> **ClientOptions** = `object`
|
|
930
930
|
|
|
931
|
-
Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.5.
|
|
931
|
+
Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L25)
|
|
932
932
|
|
|
933
933
|
Type representing the validated client options.
|
|
934
934
|
|
|
@@ -936,9 +936,9 @@ Type representing the validated client options.
|
|
|
936
936
|
|
|
937
937
|
| Name | Type | Default value | Defined in |
|
|
938
938
|
| ------ | ------ | ------ | ------ |
|
|
939
|
-
| <a id="accesstoken-2"></a> `accessToken?` | `string` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.5.
|
|
940
|
-
| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:19](https://github.com/settlemint/sdk/blob/v2.5.
|
|
941
|
-
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.5.
|
|
939
|
+
| <a id="accesstoken-2"></a> `accessToken?` | `string` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L18) |
|
|
940
|
+
| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:19](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L19) |
|
|
941
|
+
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L17) |
|
|
942
942
|
|
|
943
943
|
***
|
|
944
944
|
|
|
@@ -946,7 +946,7 @@ Type representing the validated client options.
|
|
|
946
946
|
|
|
947
947
|
> **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
|
|
948
948
|
|
|
949
|
-
Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.5.
|
|
949
|
+
Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L11)
|
|
950
950
|
|
|
951
951
|
Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
952
952
|
|
|
@@ -956,7 +956,7 @@ Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
|
956
956
|
|
|
957
957
|
> `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
|
|
958
958
|
|
|
959
|
-
Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.5.
|
|
959
|
+
Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.5.11/sdk/portal/src/portal.ts#L16)
|
|
960
960
|
|
|
961
961
|
Schema for validating Portal client configuration options.
|
|
962
962
|
|
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.5.
|
|
4
|
+
"version": "2.5.11",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
"dependencies": {
|
|
60
60
|
"gql.tada": "^1",
|
|
61
61
|
"graphql-ws": "^6",
|
|
62
|
-
"@settlemint/sdk-utils": "2.5.
|
|
62
|
+
"@settlemint/sdk-utils": "2.5.11",
|
|
63
63
|
"graphql-request": "^7",
|
|
64
64
|
"zod": "^4"
|
|
65
65
|
},
|