@settlemint/sdk-portal 2.6.2-prfff372b1 → 2.6.3
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 +47 -47
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
- [Classes](#classes)
|
|
42
42
|
- [WalletVerificationChallengeError](#walletverificationchallengeerror)
|
|
43
43
|
- [Interfaces](#interfaces)
|
|
44
|
-
- [HandleWalletVerificationChallengeOptions
|
|
44
|
+
- [HandleWalletVerificationChallengeOptions](#handlewalletverificationchallengeoptions)
|
|
45
45
|
- [Transaction](#transaction)
|
|
46
46
|
- [TransactionEvent](#transactionevent)
|
|
47
47
|
- [TransactionReceipt](#transactionreceipt)
|
|
@@ -613,7 +613,7 @@ console.log("Transaction hash:", result.CreateStableCoin?.transactionHash);
|
|
|
613
613
|
|
|
614
614
|
> **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
|
|
615
615
|
|
|
616
|
-
Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.6.
|
|
616
|
+
Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L72)
|
|
617
617
|
|
|
618
618
|
Creates a Portal GraphQL client with the provided configuration.
|
|
619
619
|
|
|
@@ -641,8 +641,8 @@ An object containing the configured GraphQL client and graphql helper function
|
|
|
641
641
|
|
|
642
642
|
| Name | Type | Defined in |
|
|
643
643
|
| ------ | ------ | ------ |
|
|
644
|
-
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.6.
|
|
645
|
-
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.6.
|
|
644
|
+
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L76) |
|
|
645
|
+
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L77) |
|
|
646
646
|
|
|
647
647
|
##### Throws
|
|
648
648
|
|
|
@@ -694,7 +694,7 @@ const result = await portalClient.request(query);
|
|
|
694
694
|
|
|
695
695
|
> **getWebsocketClient**(`options`): `Client`
|
|
696
696
|
|
|
697
|
-
Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.6.
|
|
697
|
+
Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/websocket-client.ts#L30)
|
|
698
698
|
|
|
699
699
|
Creates a GraphQL WebSocket client for the Portal API
|
|
700
700
|
|
|
@@ -727,7 +727,7 @@ const client = getWebsocketClient({
|
|
|
727
727
|
|
|
728
728
|
> **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeId`: `string`; `challengeResponse`: `string`; \}\>
|
|
729
729
|
|
|
730
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:111](https://github.com/settlemint/sdk/blob/v2.6.
|
|
730
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:111](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L111)
|
|
731
731
|
|
|
732
732
|
Handles a wallet verification challenge by generating an appropriate response
|
|
733
733
|
|
|
@@ -780,7 +780,7 @@ const result = await handleWalletVerificationChallenge({
|
|
|
780
780
|
|
|
781
781
|
> **waitForTransactionReceipt**(`transactionHash`, `options`): `Promise`\<[`Transaction`](#transaction)\>
|
|
782
782
|
|
|
783
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.6.
|
|
783
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L80)
|
|
784
784
|
|
|
785
785
|
Waits for a blockchain transaction receipt by subscribing to transaction updates via GraphQL.
|
|
786
786
|
This function polls until the transaction is confirmed or the timeout is reached.
|
|
@@ -818,7 +818,7 @@ const transaction = await waitForTransactionReceipt("0x123...", {
|
|
|
818
818
|
|
|
819
819
|
#### WalletVerificationChallengeError
|
|
820
820
|
|
|
821
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:14](https://github.com/settlemint/sdk/blob/v2.6.
|
|
821
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:14](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L14)
|
|
822
822
|
|
|
823
823
|
Custom error class for challenge-related errors
|
|
824
824
|
|
|
@@ -828,9 +828,9 @@ Custom error class for challenge-related errors
|
|
|
828
828
|
|
|
829
829
|
### Interfaces
|
|
830
830
|
|
|
831
|
-
#### HandleWalletVerificationChallengeOptions
|
|
831
|
+
#### HandleWalletVerificationChallengeOptions
|
|
832
832
|
|
|
833
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:70](https://github.com/settlemint/sdk/blob/v2.6.
|
|
833
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:70](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L70)
|
|
834
834
|
|
|
835
835
|
Options for handling a wallet verification challenge
|
|
836
836
|
|
|
@@ -844,19 +844,19 @@ Options for handling a wallet verification challenge
|
|
|
844
844
|
|
|
845
845
|
| Property | Type | Description | Defined in |
|
|
846
846
|
| ------ | ------ | ------ | ------ |
|
|
847
|
-
| <a id="code"></a> `code` | `string` \| `number` | The verification code provided by the user | [sdk/portal/src/utils/wallet-verification-challenge.ts:80](https://github.com/settlemint/sdk/blob/v2.6.
|
|
848
|
-
| <a id="portalclient"></a> `portalClient` | `GraphQLClient` | The portal client instance | [sdk/portal/src/utils/wallet-verification-challenge.ts:72](https://github.com/settlemint/sdk/blob/v2.6.
|
|
849
|
-
| <a id="portalgraphql"></a> `portalGraphql` | `initGraphQLTada`\<`Setup`\> | The GraphQL query builder | [sdk/portal/src/utils/wallet-verification-challenge.ts:74](https://github.com/settlemint/sdk/blob/v2.6.
|
|
850
|
-
| <a id="requestid"></a> `requestId?` | `string` | Request id which can be added for tracing purposes | [sdk/portal/src/utils/wallet-verification-challenge.ts:84](https://github.com/settlemint/sdk/blob/v2.6.
|
|
851
|
-
| <a id="userwalletaddress"></a> `userWalletAddress` | `` `0x${string}` `` | The wallet address to verify | [sdk/portal/src/utils/wallet-verification-challenge.ts:78](https://github.com/settlemint/sdk/blob/v2.6.
|
|
852
|
-
| <a id="verificationid"></a> `verificationId` | `string` | The ID of the verification challenge | [sdk/portal/src/utils/wallet-verification-challenge.ts:76](https://github.com/settlemint/sdk/blob/v2.6.
|
|
853
|
-
| <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification being performed | [sdk/portal/src/utils/wallet-verification-challenge.ts:82](https://github.com/settlemint/sdk/blob/v2.6.
|
|
847
|
+
| <a id="code"></a> `code` | `string` \| `number` | The verification code provided by the user | [sdk/portal/src/utils/wallet-verification-challenge.ts:80](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L80) |
|
|
848
|
+
| <a id="portalclient"></a> `portalClient` | `GraphQLClient` | The portal client instance | [sdk/portal/src/utils/wallet-verification-challenge.ts:72](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L72) |
|
|
849
|
+
| <a id="portalgraphql"></a> `portalGraphql` | `initGraphQLTada`\<`Setup`\> | The GraphQL query builder | [sdk/portal/src/utils/wallet-verification-challenge.ts:74](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L74) |
|
|
850
|
+
| <a id="requestid"></a> `requestId?` | `string` | Request id which can be added for tracing purposes | [sdk/portal/src/utils/wallet-verification-challenge.ts:84](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L84) |
|
|
851
|
+
| <a id="userwalletaddress"></a> `userWalletAddress` | `` `0x${string}` `` | The wallet address to verify | [sdk/portal/src/utils/wallet-verification-challenge.ts:78](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L78) |
|
|
852
|
+
| <a id="verificationid"></a> `verificationId` | `string` | The ID of the verification challenge | [sdk/portal/src/utils/wallet-verification-challenge.ts:76](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L76) |
|
|
853
|
+
| <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification being performed | [sdk/portal/src/utils/wallet-verification-challenge.ts:82](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L82) |
|
|
854
854
|
|
|
855
855
|
***
|
|
856
856
|
|
|
857
857
|
#### Transaction
|
|
858
858
|
|
|
859
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.6.
|
|
859
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L34)
|
|
860
860
|
|
|
861
861
|
Represents the structure of a blockchain transaction with its receipt
|
|
862
862
|
|
|
@@ -864,18 +864,18 @@ Represents the structure of a blockchain transaction with its receipt
|
|
|
864
864
|
|
|
865
865
|
| Property | Type | Description | Defined in |
|
|
866
866
|
| ------ | ------ | ------ | ------ |
|
|
867
|
-
| <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.6.
|
|
868
|
-
| <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.6.
|
|
869
|
-
| <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.6.
|
|
870
|
-
| <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.6.
|
|
871
|
-
| <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.6.
|
|
872
|
-
| <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.6.
|
|
867
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L43) |
|
|
868
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L41) |
|
|
869
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L39) |
|
|
870
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L45) |
|
|
871
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L47) |
|
|
872
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L37) |
|
|
873
873
|
|
|
874
874
|
***
|
|
875
875
|
|
|
876
876
|
#### TransactionEvent
|
|
877
877
|
|
|
878
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:8](https://github.com/settlemint/sdk/blob/v2.6.
|
|
878
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:8](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L8)
|
|
879
879
|
|
|
880
880
|
Represents an event emitted during a transaction execution
|
|
881
881
|
|
|
@@ -883,15 +883,15 @@ Represents an event emitted during a transaction execution
|
|
|
883
883
|
|
|
884
884
|
| Property | Type | Description | Defined in |
|
|
885
885
|
| ------ | ------ | ------ | ------ |
|
|
886
|
-
| <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.6.
|
|
887
|
-
| <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.6.
|
|
888
|
-
| <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.6.
|
|
886
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L12) |
|
|
887
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L10) |
|
|
888
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L14) |
|
|
889
889
|
|
|
890
890
|
***
|
|
891
891
|
|
|
892
892
|
#### TransactionReceipt
|
|
893
893
|
|
|
894
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:20](https://github.com/settlemint/sdk/blob/v2.6.
|
|
894
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:20](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L20)
|
|
895
895
|
|
|
896
896
|
Represents the structure of a blockchain transaction receipt
|
|
897
897
|
|
|
@@ -903,16 +903,16 @@ Represents the structure of a blockchain transaction receipt
|
|
|
903
903
|
|
|
904
904
|
| Property | Type | Description | Overrides | Defined in |
|
|
905
905
|
| ------ | ------ | ------ | ------ | ------ |
|
|
906
|
-
| <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.6.
|
|
907
|
-
| <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.6.
|
|
908
|
-
| <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.6.
|
|
909
|
-
| <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.6.
|
|
906
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L28) |
|
|
907
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L26) |
|
|
908
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L22) |
|
|
909
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L24) |
|
|
910
910
|
|
|
911
911
|
***
|
|
912
912
|
|
|
913
913
|
#### WaitForTransactionReceiptOptions
|
|
914
914
|
|
|
915
|
-
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.6.
|
|
915
|
+
Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L57)
|
|
916
916
|
|
|
917
917
|
Options for waiting for a transaction receipt
|
|
918
918
|
|
|
@@ -924,15 +924,15 @@ Options for waiting for a transaction receipt
|
|
|
924
924
|
|
|
925
925
|
| Property | Type | Description | Inherited from | Defined in |
|
|
926
926
|
| ------ | ------ | ------ | ------ | ------ |
|
|
927
|
-
| <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.6.
|
|
928
|
-
| <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.6.
|
|
929
|
-
| <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.6.
|
|
927
|
+
| <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.6.3/sdk/portal/src/utils/websocket-client.ts#L14) |
|
|
928
|
+
| <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.6.3/sdk/portal/src/utils/websocket-client.ts#L10) |
|
|
929
|
+
| <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.6.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L59) |
|
|
930
930
|
|
|
931
931
|
***
|
|
932
932
|
|
|
933
933
|
#### WebsocketClientOptions
|
|
934
934
|
|
|
935
|
-
Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.6.
|
|
935
|
+
Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/websocket-client.ts#L6)
|
|
936
936
|
|
|
937
937
|
Options for the GraphQL WebSocket client
|
|
938
938
|
|
|
@@ -944,8 +944,8 @@ Options for the GraphQL WebSocket client
|
|
|
944
944
|
|
|
945
945
|
| Property | Type | Description | Defined in |
|
|
946
946
|
| ------ | ------ | ------ | ------ |
|
|
947
|
-
| <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.6.
|
|
948
|
-
| <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.6.
|
|
947
|
+
| <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.6.3/sdk/portal/src/utils/websocket-client.ts#L14) |
|
|
948
|
+
| <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.6.3/sdk/portal/src/utils/websocket-client.ts#L10) |
|
|
949
949
|
|
|
950
950
|
### Type Aliases
|
|
951
951
|
|
|
@@ -953,7 +953,7 @@ Options for the GraphQL WebSocket client
|
|
|
953
953
|
|
|
954
954
|
> **ClientOptions** = `object`
|
|
955
955
|
|
|
956
|
-
Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.6.
|
|
956
|
+
Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L25)
|
|
957
957
|
|
|
958
958
|
Type representing the validated client options.
|
|
959
959
|
|
|
@@ -961,9 +961,9 @@ Type representing the validated client options.
|
|
|
961
961
|
|
|
962
962
|
| Name | Type | Default value | Defined in |
|
|
963
963
|
| ------ | ------ | ------ | ------ |
|
|
964
|
-
| <a id="accesstoken-2"></a> `accessToken?` | `string` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.6.
|
|
965
|
-
| <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.6.
|
|
966
|
-
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.6.
|
|
964
|
+
| <a id="accesstoken-2"></a> `accessToken?` | `string` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L18) |
|
|
965
|
+
| <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.6.3/sdk/portal/src/portal.ts#L19) |
|
|
966
|
+
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L17) |
|
|
967
967
|
|
|
968
968
|
***
|
|
969
969
|
|
|
@@ -971,7 +971,7 @@ Type representing the validated client options.
|
|
|
971
971
|
|
|
972
972
|
> **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
|
|
973
973
|
|
|
974
|
-
Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.6.
|
|
974
|
+
Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L11)
|
|
975
975
|
|
|
976
976
|
Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
977
977
|
|
|
@@ -981,7 +981,7 @@ Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
|
981
981
|
|
|
982
982
|
> **WalletVerificationType** = `"PINCODE"` \| `"OTP"` \| `"SECRET_CODES"`
|
|
983
983
|
|
|
984
|
-
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:9](https://github.com/settlemint/sdk/blob/v2.6.
|
|
984
|
+
Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:9](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L9)
|
|
985
985
|
|
|
986
986
|
Type representing the different types of wallet verification methods
|
|
987
987
|
|
|
@@ -991,7 +991,7 @@ Type representing the different types of wallet verification methods
|
|
|
991
991
|
|
|
992
992
|
> `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
|
|
993
993
|
|
|
994
|
-
Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.6.
|
|
994
|
+
Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.6.3/sdk/portal/src/portal.ts#L16)
|
|
995
995
|
|
|
996
996
|
Schema for validating Portal client configuration options.
|
|
997
997
|
|
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.6.
|
|
4
|
+
"version": "2.6.3",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
},
|
|
42
42
|
"scripts": {
|
|
43
43
|
"build": "tsdown",
|
|
44
|
-
"dev": "tsdown --watch",
|
|
44
|
+
"dev": "tsdown --watch ./src",
|
|
45
45
|
"publint": "publint run --strict",
|
|
46
46
|
"attw": "attw --pack .",
|
|
47
47
|
"test": "bun test",
|
|
@@ -53,13 +53,13 @@
|
|
|
53
53
|
"docs": "typedoc --options '../../typedoc.config.mjs' --entryPoints src/portal.ts --out ./docs"
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
|
-
"graphql": "16.
|
|
56
|
+
"graphql": "16.12.0",
|
|
57
57
|
"viem": "^2"
|
|
58
58
|
},
|
|
59
59
|
"dependencies": {
|
|
60
60
|
"gql.tada": "^1",
|
|
61
61
|
"graphql-ws": "^6",
|
|
62
|
-
"@settlemint/sdk-utils": "2.6.
|
|
62
|
+
"@settlemint/sdk-utils": "2.6.3",
|
|
63
63
|
"graphql-request": "^7",
|
|
64
64
|
"zod": "^4"
|
|
65
65
|
},
|