@console-wallet/dapp-sdk 0.0.21 → 0.0.22

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 (110) hide show
  1. package/README.md +1 -0
  2. package/dist/cjs/helpers/handleResponce.helper.d.ts +1 -1
  3. package/dist/cjs/index.d.ts +2 -1
  4. package/dist/cjs/requests/connect.d.ts +13 -0
  5. package/dist/cjs/requests/connect.js +13 -0
  6. package/dist/cjs/requests/connect.js.map +1 -1
  7. package/dist/cjs/requests/disconnect.d.ts +7 -0
  8. package/dist/cjs/requests/disconnect.js +28 -0
  9. package/dist/cjs/requests/disconnect.js.map +1 -0
  10. package/dist/cjs/requests/getAccounts.d.ts +5 -0
  11. package/dist/cjs/requests/getAccounts.js +5 -0
  12. package/dist/cjs/requests/getAccounts.js.map +1 -1
  13. package/dist/cjs/requests/getActiveAccount.d.ts +5 -0
  14. package/dist/cjs/requests/getActiveAccount.js +5 -0
  15. package/dist/cjs/requests/getActiveAccount.js.map +1 -1
  16. package/dist/cjs/requests/getActiveNetwork.d.ts +5 -0
  17. package/dist/cjs/requests/getActiveNetwork.js +5 -0
  18. package/dist/cjs/requests/getActiveNetwork.js.map +1 -1
  19. package/dist/cjs/requests/getBalance.d.ts +11 -0
  20. package/dist/cjs/requests/getBalance.js +11 -0
  21. package/dist/cjs/requests/getBalance.js.map +1 -1
  22. package/dist/cjs/requests/getIsConnected.d.ts +5 -0
  23. package/dist/cjs/requests/getIsConnected.js +5 -0
  24. package/dist/cjs/requests/getIsConnected.js.map +1 -1
  25. package/dist/cjs/requests/getOffers.d.ts +13 -0
  26. package/dist/cjs/requests/getOffers.js +13 -0
  27. package/dist/cjs/requests/getOffers.js.map +1 -1
  28. package/dist/cjs/requests/getTransfer.d.ts +15 -2
  29. package/dist/cjs/requests/getTransfer.js +16 -3
  30. package/dist/cjs/requests/getTransfer.js.map +1 -1
  31. package/dist/cjs/requests/getTransfers.d.ts +13 -0
  32. package/dist/cjs/requests/getTransfers.js +13 -0
  33. package/dist/cjs/requests/getTransfers.js.map +1 -1
  34. package/dist/cjs/requests/index.d.ts +1 -0
  35. package/dist/cjs/requests/index.js +1 -0
  36. package/dist/cjs/requests/index.js.map +1 -1
  37. package/dist/cjs/requests/signMessage.d.ts +10 -0
  38. package/dist/cjs/requests/signMessage.js +10 -0
  39. package/dist/cjs/requests/signMessage.js.map +1 -1
  40. package/dist/cjs/requests/signSend.d.ts +19 -0
  41. package/dist/cjs/requests/signSend.js +19 -0
  42. package/dist/cjs/requests/signSend.js.map +1 -1
  43. package/dist/cjs/types/account.type.d.ts +15 -0
  44. package/dist/cjs/types/communication.types.d.ts +18 -0
  45. package/dist/cjs/types/communication.types.js +9 -0
  46. package/dist/cjs/types/communication.types.js.map +1 -1
  47. package/dist/cjs/types/connect.type.d.ts +11 -0
  48. package/dist/cjs/types/helpers.types.d.ts +3 -0
  49. package/dist/cjs/types/history.types.d.ts +6 -0
  50. package/dist/cjs/types/signed.type.d.ts +15 -0
  51. package/dist/cjs/types/signed.type.js +2 -0
  52. package/dist/cjs/types/signed.type.js.map +1 -1
  53. package/dist/cjs/types/token.types.d.ts +11 -1
  54. package/dist/cjs/types/token.types.js +3 -0
  55. package/dist/cjs/types/token.types.js.map +1 -1
  56. package/dist/esm/helpers/handleResponce.helper.d.ts +1 -1
  57. package/dist/esm/index.d.ts +2 -1
  58. package/dist/esm/requests/connect.d.ts +13 -0
  59. package/dist/esm/requests/connect.js +13 -0
  60. package/dist/esm/requests/connect.js.map +1 -1
  61. package/dist/esm/requests/disconnect.d.ts +7 -0
  62. package/dist/esm/requests/disconnect.js +24 -0
  63. package/dist/esm/requests/disconnect.js.map +1 -0
  64. package/dist/esm/requests/getAccounts.d.ts +5 -0
  65. package/dist/esm/requests/getAccounts.js +5 -0
  66. package/dist/esm/requests/getAccounts.js.map +1 -1
  67. package/dist/esm/requests/getActiveAccount.d.ts +5 -0
  68. package/dist/esm/requests/getActiveAccount.js +5 -0
  69. package/dist/esm/requests/getActiveAccount.js.map +1 -1
  70. package/dist/esm/requests/getActiveNetwork.d.ts +5 -0
  71. package/dist/esm/requests/getActiveNetwork.js +5 -0
  72. package/dist/esm/requests/getActiveNetwork.js.map +1 -1
  73. package/dist/esm/requests/getBalance.d.ts +11 -0
  74. package/dist/esm/requests/getBalance.js +11 -0
  75. package/dist/esm/requests/getBalance.js.map +1 -1
  76. package/dist/esm/requests/getIsConnected.d.ts +5 -0
  77. package/dist/esm/requests/getIsConnected.js +5 -0
  78. package/dist/esm/requests/getIsConnected.js.map +1 -1
  79. package/dist/esm/requests/getOffers.d.ts +13 -0
  80. package/dist/esm/requests/getOffers.js +13 -0
  81. package/dist/esm/requests/getOffers.js.map +1 -1
  82. package/dist/esm/requests/getTransfer.d.ts +15 -2
  83. package/dist/esm/requests/getTransfer.js +14 -1
  84. package/dist/esm/requests/getTransfer.js.map +1 -1
  85. package/dist/esm/requests/getTransfers.d.ts +13 -0
  86. package/dist/esm/requests/getTransfers.js +13 -0
  87. package/dist/esm/requests/getTransfers.js.map +1 -1
  88. package/dist/esm/requests/index.d.ts +1 -0
  89. package/dist/esm/requests/index.js +1 -0
  90. package/dist/esm/requests/index.js.map +1 -1
  91. package/dist/esm/requests/signMessage.d.ts +10 -0
  92. package/dist/esm/requests/signMessage.js +10 -0
  93. package/dist/esm/requests/signMessage.js.map +1 -1
  94. package/dist/esm/requests/signSend.d.ts +19 -0
  95. package/dist/esm/requests/signSend.js +19 -0
  96. package/dist/esm/requests/signSend.js.map +1 -1
  97. package/dist/esm/types/account.type.d.ts +15 -0
  98. package/dist/esm/types/communication.types.d.ts +18 -0
  99. package/dist/esm/types/communication.types.js +9 -0
  100. package/dist/esm/types/communication.types.js.map +1 -1
  101. package/dist/esm/types/connect.type.d.ts +11 -0
  102. package/dist/esm/types/helpers.types.d.ts +3 -0
  103. package/dist/esm/types/history.types.d.ts +6 -0
  104. package/dist/esm/types/signed.type.d.ts +15 -0
  105. package/dist/esm/types/signed.type.js +2 -0
  106. package/dist/esm/types/signed.type.js.map +1 -1
  107. package/dist/esm/types/token.types.d.ts +11 -1
  108. package/dist/esm/types/token.types.js +3 -0
  109. package/dist/esm/types/token.types.js.map +1 -1
  110. package/package.json +1 -1
@@ -3,6 +3,7 @@ export * from './getActiveAccount';
3
3
  export * from './signMessage';
4
4
  export * from './signSend';
5
5
  export * from './connect';
6
+ export * from './disconnect';
6
7
  export * from './getIsConnected';
7
8
  export * from './getActiveNetwork';
8
9
  export * from './getBalance';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/requests/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,cAAc,CAAC;AAE7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/requests/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,cAAc,CAAC;AAE7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}
@@ -1,2 +1,12 @@
1
1
  import type { SignMessageRequest, SignedMessageResponse } from '../types';
2
+ /**
3
+ * Requests the wallet to sign an arbitrary message (hex or base64).
4
+ *
5
+ * @param {SignMessageRequest} message Request payload.
6
+ * @param {HexMessage|Base64Message} message.message Message content. Provide either `{ hex }` or `{ base64 }`.
7
+ * @return {Promise<SignedMessageResponse>} Resolves to signed message and signature.
8
+ * @example
9
+ * await signMessage({ message: { hex: "0x68656c6c6f" } });
10
+ * await signMessage({ message: { base64: "aGVsbG8=" } });
11
+ */
2
12
  export declare const signMessage: (message: SignMessageRequest) => Promise<SignedMessageResponse>;
@@ -1,6 +1,16 @@
1
1
  import { WALLET_TARGET } from '../constants';
2
2
  import { isExpectedResponse } from '../helpers/handleResponce.helper';
3
3
  import { PUBLIC_REQUESTS } from '../types';
4
+ /**
5
+ * Requests the wallet to sign an arbitrary message (hex or base64).
6
+ *
7
+ * @param {SignMessageRequest} message Request payload.
8
+ * @param {HexMessage|Base64Message} message.message Message content. Provide either `{ hex }` or `{ base64 }`.
9
+ * @return {Promise<SignedMessageResponse>} Resolves to signed message and signature.
10
+ * @example
11
+ * await signMessage({ message: { hex: "0x68656c6c6f" } });
12
+ * await signMessage({ message: { base64: "aGVsbG8=" } });
13
+ */
4
14
  export const signMessage = async (message) => new Promise((resolve) => {
5
15
  const id = crypto.randomUUID();
6
16
  window.postMessage({
@@ -1 +1 @@
1
- {"version":3,"file":"signMessage.js","sourceRoot":"","sources":["../../../src/requests/signMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C,MAAM,CAAC,MAAM,WAAW,GAAoE,KAAK,EAC/F,OAAO,EACP,EAAE,CACF,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;IACtB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAE/B,MAAM,CAAC,WAAW,CAChB;QACE,IAAI,EAAE,eAAe,CAAC,YAAY;QAClC,MAAM,EAAE,aAAa;QACrB,EAAE;QACF,GAAG,OAAO;KACX,EACD,GAAG,CACJ,CAAC;IAEF,SAAS,cAAc,CAAC,KAAmB;QACzC,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC,YAAY,WAAW,CAAC,EAAE;YAC7E,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"signMessage.js","sourceRoot":"","sources":["../../../src/requests/signMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,WAAW,GAAoE,KAAK,EAC/F,OAAO,EACP,EAAE,CACF,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;IACtB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAE/B,MAAM,CAAC,WAAW,CAChB;QACE,IAAI,EAAE,eAAe,CAAC,YAAY;QAClC,MAAM,EAAE,aAAa;QACrB,EAAE;QACF,GAAG,OAAO;KACX,EACD,GAAG,CACJ,CAAC;IAEF,SAAS,cAAc,CAAC,KAAmB;QACzC,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC,YAAY,WAAW,CAAC,EAAE;YAC7E,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC"}
@@ -1,2 +1,21 @@
1
1
  import type { SignSendRequest, SignSendResponse } from '../types';
2
+ /**
3
+ * Requests the wallet to create and sign a token transfer and optionally wait.
4
+ *
5
+ * @param {SignSendRequest} data Request payload.
6
+ * @param {string} data.from Sender party identifier.
7
+ * @param {string} data.to Recipient party identifier.
8
+ * @param {string} data.amount Transfer amount as a string (decimal).
9
+ * @param {string} data.expireDate ISO date string after which the offer expires.
10
+ * @param {number} [data.waitForFinalization] Optional wait time in ms; between MIN_WAITING and MAX_WAITING.
11
+ * @return {Promise<SignSendResponse>} Resolves to status, optional signature, and confirmation data.
12
+ * @example
13
+ * await signSend({
14
+ * from: "AlicePartyId",
15
+ * to: "BobPartyId",
16
+ * amount: "100.00",
17
+ * expireDate: "2025-12-31T23:59:59Z",
18
+ * waitForFinalization: 5000,
19
+ * });
20
+ */
2
21
  export declare const signSend: (data: SignSendRequest) => Promise<SignSendResponse>;
@@ -1,6 +1,25 @@
1
1
  import { WALLET_TARGET } from '../constants';
2
2
  import { isExpectedResponse } from '../helpers/handleResponce.helper';
3
3
  import { PUBLIC_REQUESTS } from '../types';
4
+ /**
5
+ * Requests the wallet to create and sign a token transfer and optionally wait.
6
+ *
7
+ * @param {SignSendRequest} data Request payload.
8
+ * @param {string} data.from Sender party identifier.
9
+ * @param {string} data.to Recipient party identifier.
10
+ * @param {string} data.amount Transfer amount as a string (decimal).
11
+ * @param {string} data.expireDate ISO date string after which the offer expires.
12
+ * @param {number} [data.waitForFinalization] Optional wait time in ms; between MIN_WAITING and MAX_WAITING.
13
+ * @return {Promise<SignSendResponse>} Resolves to status, optional signature, and confirmation data.
14
+ * @example
15
+ * await signSend({
16
+ * from: "AlicePartyId",
17
+ * to: "BobPartyId",
18
+ * amount: "100.00",
19
+ * expireDate: "2025-12-31T23:59:59Z",
20
+ * waitForFinalization: 5000,
21
+ * });
22
+ */
4
23
  export const signSend = async (data) => new Promise((resolve) => {
5
24
  const id = crypto.randomUUID();
6
25
  window.postMessage({
@@ -1 +1 @@
1
- {"version":3,"file":"signSend.js","sourceRoot":"","sources":["../../../src/requests/signSend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C,MAAM,CAAC,MAAM,QAAQ,GAAyD,KAAK,EAAE,IAAI,EAAE,EAAE,CAC3F,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;IACtB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAE/B,MAAM,CAAC,WAAW,CAChB;QACE,IAAI,EAAE,eAAe,CAAC,SAAS;QAC/B,MAAM,EAAE,aAAa;QACrB,EAAE;QACF,GAAG,IAAI;KACR,EACD,GAAG,CACJ,CAAC;IAEF,SAAS,cAAc,CAAC,KAAmB;QACzC,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC,SAAS,WAAW,CAAC,EAAE;YAC1E,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"signSend.js","sourceRoot":"","sources":["../../../src/requests/signSend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAyD,KAAK,EAAE,IAAI,EAAE,EAAE,CAC3F,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;IACtB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAE/B,MAAM,CAAC,WAAW,CAChB;QACE,IAAI,EAAE,eAAe,CAAC,SAAS;QAC/B,MAAM,EAAE,aAAa;QACrB,EAAE;QACF,GAAG,IAAI;KACR,EACD,GAAG,CACJ,CAAC;IAEF,SAAS,cAAc,CAAC,KAAmB;QACzC,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC,SAAS,WAAW,CAAC,EAAE;YAC1E,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC"}
@@ -1,10 +1,25 @@
1
1
  import { CANTON_NETWORK_VARIANTS } from './token.types';
2
+ /**
3
+ * Template-literal type representing a party identifier with namespace.
4
+ * Example: "partHint::generatedPart".
5
+ */
2
6
  export type Party = `${string}::${string}`;
7
+ /**
8
+ * Wallet account information tied to a specific Canton network.
9
+ *
10
+ * Fields:
11
+ * - `public_key`: Public key string associated with the account.
12
+ * - `party`: Party identifier.
13
+ * - `name`: Human-readable account name.
14
+ * - `network`: Canton network variant this account belongs to.
15
+ */
3
16
  export type Account = {
4
17
  public_key: string;
5
18
  party: string;
6
19
  name: string;
7
20
  network: CANTON_NETWORK_VARIANTS;
8
21
  };
22
+ /** Array of accounts or undefined when no accounts are available. */
9
23
  export type GetAccountsResponse = Account[] | undefined;
24
+ /** Single account or undefined when no active account is set. */
10
25
  export type GetAccountResponse = Account | undefined;
@@ -1,3 +1,7 @@
1
+ /**
2
+ * Internal message types used for extension background/offscreen communication.
3
+ * Not exposed to dApps directly.
4
+ */
1
5
  export declare enum INTERNAL_REQUESTS {
2
6
  SAVE_SESSION_DATA = "SAVE_SESSION_DATA",
3
7
  GET_SESSION_DATA = "GET_SESSION_DATA",
@@ -6,8 +10,13 @@ export declare enum INTERNAL_REQUESTS {
6
10
  GET_PAGE_DATA = "GET_PAGE_DATA",
7
11
  RESET_PAGE_DATA = "RESET_PAGE_DATA"
8
12
  }
13
+ /**
14
+ * Public request types that a dApp can post to the wallet.
15
+ * Each request has a corresponding `${REQUEST}_RESPONSE` message.
16
+ */
9
17
  export declare enum PUBLIC_REQUESTS {
10
18
  CONNECT = "CONNECT",
19
+ DISCONNECT = "DISCONNECT",
11
20
  GET_IS_CONNECTED = "GET_IS_CONNECTED",
12
21
  GET_ACTIVE_NETWORK = "GET_ACTIVE_NETWORK",
13
22
  SIGN_MESSAGE = "SIGN_MESSAGE",
@@ -19,7 +28,16 @@ export declare enum PUBLIC_REQUESTS {
19
28
  GET_TRANSFER_DETAILS = "GET_TRANSFER_DETAILS",
20
29
  GET_OFFERS_HISTORY = "GET_OFFERS_HISTORY"
21
30
  }
31
+ /** Template-literal form for deriving a `${REQUEST}_RESPONSE` message type. */
22
32
  export type POSSIBLE_RESPONSE_TYPE = `${PUBLIC_REQUESTS}_RESPONSE`;
33
+ /**
34
+ * Common fields included in every request message posted to the wallet.
35
+ *
36
+ * Fields:
37
+ * - `type`: The message type, one of PUBLIC_REQUESTS.
38
+ * - `target`: Target identifier to scope messages to the wallet.
39
+ * - `id`: Correlation ID used to match responses.
40
+ */
23
41
  export type CommonDataFieldsRequest = {
24
42
  type: string;
25
43
  target: string;
@@ -1,3 +1,7 @@
1
+ /**
2
+ * Internal message types used for extension background/offscreen communication.
3
+ * Not exposed to dApps directly.
4
+ */
1
5
  export var INTERNAL_REQUESTS;
2
6
  (function (INTERNAL_REQUESTS) {
3
7
  INTERNAL_REQUESTS["SAVE_SESSION_DATA"] = "SAVE_SESSION_DATA";
@@ -7,9 +11,14 @@ export var INTERNAL_REQUESTS;
7
11
  INTERNAL_REQUESTS["GET_PAGE_DATA"] = "GET_PAGE_DATA";
8
12
  INTERNAL_REQUESTS["RESET_PAGE_DATA"] = "RESET_PAGE_DATA";
9
13
  })(INTERNAL_REQUESTS || (INTERNAL_REQUESTS = {}));
14
+ /**
15
+ * Public request types that a dApp can post to the wallet.
16
+ * Each request has a corresponding `${REQUEST}_RESPONSE` message.
17
+ */
10
18
  export var PUBLIC_REQUESTS;
11
19
  (function (PUBLIC_REQUESTS) {
12
20
  PUBLIC_REQUESTS["CONNECT"] = "CONNECT";
21
+ PUBLIC_REQUESTS["DISCONNECT"] = "DISCONNECT";
13
22
  PUBLIC_REQUESTS["GET_IS_CONNECTED"] = "GET_IS_CONNECTED";
14
23
  PUBLIC_REQUESTS["GET_ACTIVE_NETWORK"] = "GET_ACTIVE_NETWORK";
15
24
  PUBLIC_REQUESTS["SIGN_MESSAGE"] = "SIGN_MESSAGE";
@@ -1 +1 @@
1
- {"version":3,"file":"communication.types.js","sourceRoot":"","sources":["../../../src/types/communication.types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,4DAAuC,CAAA;IACvC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,oDAA+B,CAAA;IAC/B,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;AACrC,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAED,MAAM,CAAN,IAAY,eAiBX;AAjBD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,wDAAqC,CAAA;IACrC,4DAAyC,CAAA;IAEzC,gDAA6B,CAAA;IAC7B,0CAAuB,CAAA;IAEvB,gDAA6B,CAAA;IAC7B,4DAAyC,CAAA;IAEzC,8CAA2B,CAAA;IAE3B,kEAA+C,CAAA;IAC/C,gEAA6C,CAAA;IAE7C,4DAAyC,CAAA;AAC3C,CAAC,EAjBW,eAAe,KAAf,eAAe,QAiB1B"}
1
+ {"version":3,"file":"communication.types.js","sourceRoot":"","sources":["../../../src/types/communication.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,4DAAuC,CAAA;IACvC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,oDAA+B,CAAA;IAC/B,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;AACrC,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,eAkBX;AAlBD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,wDAAqC,CAAA;IACrC,4DAAyC,CAAA;IAEzC,gDAA6B,CAAA;IAC7B,0CAAuB,CAAA;IAEvB,gDAA6B,CAAA;IAC7B,4DAAyC,CAAA;IAEzC,8CAA2B,CAAA;IAE3B,kEAA+C,CAAA;IAC/C,gEAA6C,CAAA;IAE7C,4DAAyC,CAAA;AAC3C,CAAC,EAlBW,eAAe,KAAf,eAAe,QAkB1B"}
@@ -1,8 +1,19 @@
1
+ /**
2
+ * Optional metadata provided by a dApp when initiating a connection.
3
+ * Used by the wallet UI to present context to the user.
4
+ */
1
5
  export type ConnectRequest = {
2
6
  icon?: string;
3
7
  name?: string;
4
8
  };
9
+ /** Boolean response indicating whether the user approved the connection. */
5
10
  export type ConnectResponse = boolean;
11
+ /** Boolean response */
12
+ export type DisconnectResponse = boolean;
13
+ /**
14
+ * Internal-only fields included by the wallet during connection flow.
15
+ * Not provided by the dApp.
16
+ */
6
17
  export type ConnectRequestInternal = {
7
18
  referer: `http://${string}` | `https://${string}`;
8
19
  };
@@ -1,3 +1,6 @@
1
+ /** Keys available on an object type; narrows to keys when T extends object. */
1
2
  export type DiscriminantKeys<T> = T extends object ? keyof T : never;
3
+ /** Extracts the type of property `K` from type `T` when present. */
2
4
  export type ChildOf<T, K extends PropertyKey> = Extract<T, Record<K, unknown>>[K];
5
+ /** Element type of an array; resolves `U` from `T extends U[]`. */
3
6
  export type ElementType<T> = T extends (infer U)[] ? U : never;
@@ -1,20 +1,26 @@
1
1
  import { api } from '../api';
2
2
  import { PagedAnsResponseTokenTransferSummary, PagedByIDResponseOffer } from '../api/generated-indexer-api';
3
3
  import { CANTON_NETWORK_VARIANTS } from './token.types';
4
+ /** Query parameters accepted by the indexer for party token transfers. */
4
5
  export type TokenTransfersQuery = Parameters<typeof api.indexer.tokenTransferByPartyId>[0];
5
6
  export type TokenTransfersRequest = {
6
7
  query: TokenTransfersQuery;
7
8
  network: CANTON_NETWORK_VARIANTS;
8
9
  };
10
+ /** Paged token transfer summaries or null if no data exists. */
9
11
  export type TokenTransfersResponse = PagedAnsResponseTokenTransferSummary | null;
12
+ /** Query parameters accepted by the indexer for offers by sender. */
10
13
  export type OffersQuery = Parameters<typeof api.indexer.offerBySenderParty>[0];
11
14
  export type OffersRequest = {
12
15
  query: OffersQuery;
13
16
  network: CANTON_NETWORK_VARIANTS;
14
17
  };
18
+ /** Paged offers response or null if no data exists. */
15
19
  export type OffersResponse = PagedByIDResponseOffer | null;
20
+ /** Request parameters for retrieving a single transfer by event ID. */
16
21
  export type TransferRequest = {
17
22
  eventId: string;
18
23
  network: CANTON_NETWORK_VARIANTS;
19
24
  };
25
+ /** Detailed transfer response or null if event is not found. */
20
26
  export type TransferResponse = Awaited<ReturnType<typeof api.indexer.tokenTransferByEventId>> | null;
@@ -1,20 +1,31 @@
1
1
  import { PagedByIDResponseOffer } from '../api/generated-indexer-api';
2
2
  import { ElementType } from './helpers.types';
3
+ /** Maximum wait time in ms when waiting for finalization. */
3
4
  export declare const MAX_WAITING = 10000;
5
+ /** Minimum wait time in ms when waiting for finalization. */
4
6
  export declare const MIN_WAITING = 2000;
7
+ /** Result payload from signing an arbitrary message. */
5
8
  export type SignedMessageResponse = {
6
9
  message: string;
7
10
  signature: string;
8
11
  };
12
+ /** Message body encoded as hexadecimal string. */
9
13
  export type HexMessage = {
10
14
  hex: string;
11
15
  };
16
+ /** Message body encoded as base64 string. */
12
17
  export type Base64Message = {
13
18
  base64: string;
14
19
  };
20
+ /**
21
+ * Request to sign a message; provide either a hex or base64 payload.
22
+ */
15
23
  export type SignMessageRequest = {
16
24
  message: HexMessage | Base64Message;
17
25
  };
26
+ /**
27
+ * Request to sign and send a token transfer.
28
+ */
18
29
  export type SignSendRequest = {
19
30
  from: string;
20
31
  to: string;
@@ -22,7 +33,11 @@ export type SignSendRequest = {
22
33
  expireDate: string;
23
34
  waitForFinalization?: number;
24
35
  };
36
+ /**
37
+ * Element type of the confirmation data returned by the indexer wait function.
38
+ */
25
39
  export type SendConfirmationDataType = ElementType<PagedByIDResponseOffer['data']>;
40
+ /** Result of the sign-and-send operation, including optional confirmation. */
26
41
  export type SignSendResponse = {
27
42
  status: true | false;
28
43
  signature?: string;
@@ -1,3 +1,5 @@
1
+ /** Maximum wait time in ms when waiting for finalization. */
1
2
  export const MAX_WAITING = 10_000;
3
+ /** Minimum wait time in ms when waiting for finalization. */
2
4
  export const MIN_WAITING = 2_000;
3
5
  //# sourceMappingURL=signed.type.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"signed.type.js","sourceRoot":"","sources":["../../../src/types/signed.type.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;AAClC,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAC"}
1
+ {"version":3,"file":"signed.type.js","sourceRoot":"","sources":["../../../src/types/signed.type.ts"],"names":[],"mappings":"AAGA,6DAA6D;AAC7D,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;AAClC,6DAA6D;AAC7D,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAC"}
@@ -1,8 +1,14 @@
1
+ /**
2
+ * Supported Canton network variants the wallet can operate against.
3
+ */
1
4
  export declare enum CANTON_NETWORK_VARIANTS {
2
5
  CANTON_NETWORK_DEV = "CANTON_NETWORK_DEV",
3
6
  CANTON_NETWORK_TEST = "CANTON_NETWORK_TEST",
4
7
  CANTON_NETWORK = "CANTON_NETWORK"
5
8
  }
9
+ /**
10
+ * Network metadata for display and routing to indexer/backends.
11
+ */
6
12
  export interface NetworkType {
7
13
  baseUrl: string;
8
14
  id: CANTON_NETWORK_VARIANTS;
@@ -12,6 +18,9 @@ export interface NetworkType {
12
18
  explorer: string;
13
19
  nativeTokenId: string;
14
20
  }
21
+ /**
22
+ * Token balance data for a specific network.
23
+ */
15
24
  export type TokenData = {
16
25
  id: string;
17
26
  symbol: string;
@@ -21,14 +30,15 @@ export type TokenData = {
21
30
  name: string;
22
31
  price: string;
23
32
  balanceUsd?: string;
24
- totalUsd?: string;
25
33
  network: NetworkType;
26
34
  imageSrc: string;
27
35
  };
36
+ /** Party/network pair used to request balances from the wallet/indexer. */
28
37
  export type GetBalanceRequest = {
29
38
  party: string;
30
39
  network: CANTON_NETWORK_VARIANTS;
31
40
  };
41
+ /** Token list, split-balance flag (multi-network party), and aggregated price. */
32
42
  export type GetBalanceResponse = {
33
43
  tokens: TokenData[];
34
44
  isSplitedBalance: boolean;
@@ -1,3 +1,6 @@
1
+ /**
2
+ * Supported Canton network variants the wallet can operate against.
3
+ */
1
4
  export var CANTON_NETWORK_VARIANTS;
2
5
  (function (CANTON_NETWORK_VARIANTS) {
3
6
  CANTON_NETWORK_VARIANTS["CANTON_NETWORK_DEV"] = "CANTON_NETWORK_DEV";
@@ -1 +1 @@
1
- {"version":3,"file":"token.types.js","sourceRoot":"","sources":["../../../src/types/token.types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,oEAAyC,CAAA;IACzC,sEAA2C,CAAA;IAC3C,4DAAiC,CAAA;AACnC,CAAC,EAJW,uBAAuB,KAAvB,uBAAuB,QAIlC"}
1
+ {"version":3,"file":"token.types.js","sourceRoot":"","sources":["../../../src/types/token.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,oEAAyC,CAAA;IACzC,sEAA2C,CAAA;IAC3C,4DAAiC,CAAA;AACnC,CAAC,EAJW,uBAAuB,KAAvB,uBAAuB,QAIlC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@console-wallet/dapp-sdk",
3
- "version": "0.0.21",
3
+ "version": "0.0.22",
4
4
  "description": "",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",