@dfns/sdk 0.7.12 → 0.7.13-rc.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.
@@ -69,6 +69,9 @@ export declare class AuthClient {
69
69
  sendLoginCode(request: T.SendLoginCodeRequest): Promise<T.SendLoginCodeResponse>;
70
70
  sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
71
71
  socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
72
+ sSOLogin(request: T.SSOLoginRequest): Promise<T.SSOLoginResponse>;
73
+ sSOLoginInit(request: T.SSOLoginInitRequest): Promise<T.SSOLoginInitResponse>;
72
74
  updatePersonalAccessToken(request: T.UpdatePersonalAccessTokenRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
73
75
  updateServiceAccount(request: T.UpdateServiceAccountRequest): Promise<T.UpdateServiceAccountResponse>;
76
+ updateUser(request: T.UpdateUserRequest): Promise<T.UpdateUserResponse>;
74
77
  }
@@ -610,6 +610,30 @@ class AuthClient {
610
610
  });
611
611
  return response.json();
612
612
  }
613
+ async sSOLogin(request) {
614
+ const path = (0, url_1.buildPathAndQuery)('/auth/login/sso', {
615
+ path: request ?? {},
616
+ query: {},
617
+ });
618
+ const response = await (0, fetch_1.simpleFetch)(path, {
619
+ method: 'POST',
620
+ body: request.body,
621
+ apiOptions: this.apiOptions,
622
+ });
623
+ return response.json();
624
+ }
625
+ async sSOLoginInit(request) {
626
+ const path = (0, url_1.buildPathAndQuery)('/auth/login/sso/init', {
627
+ path: request ?? {},
628
+ query: {},
629
+ });
630
+ const response = await (0, fetch_1.simpleFetch)(path, {
631
+ method: 'POST',
632
+ body: request.body,
633
+ apiOptions: this.apiOptions,
634
+ });
635
+ return response.json();
636
+ }
613
637
  async updatePersonalAccessToken(request) {
614
638
  const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
615
639
  path: request ?? {},
@@ -634,5 +658,17 @@ class AuthClient {
634
658
  });
635
659
  return response.json();
636
660
  }
661
+ async updateUser(request) {
662
+ const path = (0, url_1.buildPathAndQuery)('/auth/users/:userId', {
663
+ path: request ?? {},
664
+ query: {},
665
+ });
666
+ const response = await (0, userActionFetch_1.userActionFetch)(path, {
667
+ method: 'PUT',
668
+ body: request.body,
669
+ apiOptions: this.apiOptions,
670
+ });
671
+ return response.json();
672
+ }
637
673
  }
638
674
  exports.AuthClient = AuthClient;
@@ -81,8 +81,12 @@ export declare class DelegatedAuthClient {
81
81
  sendLoginCode(request: T.SendLoginCodeRequest): Promise<T.SendLoginCodeResponse>;
82
82
  sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
83
83
  socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
84
+ sSOLogin(request: T.SSOLoginRequest): Promise<T.SSOLoginResponse>;
85
+ sSOLoginInit(request: T.SSOLoginInitRequest): Promise<T.SSOLoginInitResponse>;
84
86
  updatePersonalAccessTokenInit(request: T.UpdatePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
85
87
  updatePersonalAccessTokenComplete(request: T.UpdatePersonalAccessTokenRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
86
88
  updateServiceAccountInit(request: T.UpdateServiceAccountRequest): Promise<UserActionChallengeResponse>;
87
89
  updateServiceAccountComplete(request: T.UpdateServiceAccountRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdateServiceAccountResponse>;
90
+ updateUserInit(request: T.UpdateUserRequest): Promise<UserActionChallengeResponse>;
91
+ updateUserComplete(request: T.UpdateUserRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdateUserResponse>;
88
92
  }
@@ -878,6 +878,30 @@ class DelegatedAuthClient {
878
878
  });
879
879
  return response.json();
880
880
  }
881
+ async sSOLogin(request) {
882
+ const path = (0, url_1.buildPathAndQuery)('/auth/login/sso', {
883
+ path: request ?? {},
884
+ query: {},
885
+ });
886
+ const response = await (0, fetch_1.simpleFetch)(path, {
887
+ method: 'POST',
888
+ body: request.body,
889
+ apiOptions: this.apiOptions,
890
+ });
891
+ return response.json();
892
+ }
893
+ async sSOLoginInit(request) {
894
+ const path = (0, url_1.buildPathAndQuery)('/auth/login/sso/init', {
895
+ path: request ?? {},
896
+ query: {},
897
+ });
898
+ const response = await (0, fetch_1.simpleFetch)(path, {
899
+ method: 'POST',
900
+ body: request.body,
901
+ apiOptions: this.apiOptions,
902
+ });
903
+ return response.json();
904
+ }
881
905
  async updatePersonalAccessTokenInit(request) {
882
906
  const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
883
907
  path: request ?? {},
@@ -932,5 +956,32 @@ class DelegatedAuthClient {
932
956
  });
933
957
  return response.json();
934
958
  }
959
+ async updateUserInit(request) {
960
+ const path = (0, url_1.buildPathAndQuery)('/auth/users/:userId', {
961
+ path: request ?? {},
962
+ query: {},
963
+ });
964
+ const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
965
+ userActionHttpMethod: 'PUT',
966
+ userActionHttpPath: path,
967
+ userActionPayload: JSON.stringify(request.body),
968
+ userActionServerKind: 'Api',
969
+ }, this.apiOptions);
970
+ return challenge;
971
+ }
972
+ async updateUserComplete(request, signedChallenge) {
973
+ const path = (0, url_1.buildPathAndQuery)('/auth/users/:userId', {
974
+ path: request ?? {},
975
+ query: {},
976
+ });
977
+ const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
978
+ const response = await (0, fetch_1.simpleFetch)(path, {
979
+ method: 'PUT',
980
+ body: request.body,
981
+ headers: { 'x-dfns-useraction': userAction },
982
+ apiOptions: this.apiOptions,
983
+ });
984
+ return response.json();
985
+ }
935
986
  }
936
987
  exports.DelegatedAuthClient = DelegatedAuthClient;
@@ -15,6 +15,7 @@ export type ActivatePersonalAccessTokenResponse = {
15
15
  dateCreated: string;
16
16
  credId: string;
17
17
  isActive: boolean;
18
+ /** Access token kind */
18
19
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
19
20
  linkedUserId: string;
20
21
  linkedAppId: string;
@@ -57,6 +58,7 @@ export type ActivateServiceAccountResponse = {
57
58
  dateCreated: string;
58
59
  credId: string;
59
60
  isActive: boolean;
61
+ /** Access token kind */
60
62
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
61
63
  linkedUserId: string;
62
64
  linkedAppId: string;
@@ -87,6 +89,7 @@ export type ActivateUserResponse = {
87
89
  isActive: boolean;
88
90
  isServiceAccount: boolean;
89
91
  isRegistered: boolean;
92
+ isSSORequired: boolean;
90
93
  permissionAssignments: {
91
94
  permissionName: string;
92
95
  permissionId: string;
@@ -103,6 +106,7 @@ export type ArchivePersonalAccessTokenResponse = {
103
106
  dateCreated: string;
104
107
  credId: string;
105
108
  isActive: boolean;
109
+ /** Access token kind */
106
110
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
107
111
  linkedUserId: string;
108
112
  linkedAppId: string;
@@ -145,6 +149,7 @@ export type ArchiveServiceAccountResponse = {
145
149
  dateCreated: string;
146
150
  credId: string;
147
151
  isActive: boolean;
152
+ /** Access token kind */
148
153
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
149
154
  linkedUserId: string;
150
155
  linkedAppId: string;
@@ -175,6 +180,7 @@ export type ArchiveUserResponse = {
175
180
  isActive: boolean;
176
181
  isServiceAccount: boolean;
177
182
  isRegistered: boolean;
183
+ isSSORequired: boolean;
178
184
  permissionAssignments: {
179
185
  permissionName: string;
180
186
  permissionId: string;
@@ -853,6 +859,7 @@ export type CreateServiceAccountResponse = {
853
859
  dateCreated: string;
854
860
  credId: string;
855
861
  isActive: boolean;
862
+ /** Access token kind */
856
863
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
857
864
  linkedUserId: string;
858
865
  linkedAppId: string;
@@ -921,6 +928,8 @@ export type CreateUserBody = {
921
928
  publicKey?: string | undefined;
922
929
  /** Value that can be used to correlate the entity with an external system. */
923
930
  externalId?: string | undefined;
931
+ /** If set to true, the user will have to authenticate via SSO */
932
+ isSSORequired?: boolean;
924
933
  };
925
934
  export type CreateUserResponse = {
926
935
  username: string;
@@ -933,6 +942,7 @@ export type CreateUserResponse = {
933
942
  isActive: boolean;
934
943
  isServiceAccount: boolean;
935
944
  isRegistered: boolean;
945
+ isSSORequired: boolean;
936
946
  permissionAssignments: {
937
947
  permissionName: string;
938
948
  permissionId: string;
@@ -1072,6 +1082,7 @@ export type DeactivatePersonalAccessTokenResponse = {
1072
1082
  dateCreated: string;
1073
1083
  credId: string;
1074
1084
  isActive: boolean;
1085
+ /** Access token kind */
1075
1086
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1076
1087
  linkedUserId: string;
1077
1088
  linkedAppId: string;
@@ -1114,6 +1125,7 @@ export type DeactivateServiceAccountResponse = {
1114
1125
  dateCreated: string;
1115
1126
  credId: string;
1116
1127
  isActive: boolean;
1128
+ /** Access token kind */
1117
1129
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1118
1130
  linkedUserId: string;
1119
1131
  linkedAppId: string;
@@ -1144,6 +1156,7 @@ export type DeactivateUserResponse = {
1144
1156
  isActive: boolean;
1145
1157
  isServiceAccount: boolean;
1146
1158
  isRegistered: boolean;
1159
+ isSSORequired: boolean;
1147
1160
  permissionAssignments: {
1148
1161
  permissionName: string;
1149
1162
  permissionId: string;
@@ -1183,6 +1196,7 @@ export type GetApplicationResponse = {
1183
1196
  dateCreated: string;
1184
1197
  credId: string;
1185
1198
  isActive: boolean;
1199
+ /** Access token kind */
1186
1200
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1187
1201
  linkedUserId: string;
1188
1202
  linkedAppId: string;
@@ -1229,6 +1243,7 @@ export type GetPersonalAccessTokenResponse = {
1229
1243
  dateCreated: string;
1230
1244
  credId: string;
1231
1245
  isActive: boolean;
1246
+ /** Access token kind */
1232
1247
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1233
1248
  linkedUserId: string;
1234
1249
  linkedAppId: string;
@@ -1271,6 +1286,7 @@ export type GetServiceAccountResponse = {
1271
1286
  dateCreated: string;
1272
1287
  credId: string;
1273
1288
  isActive: boolean;
1289
+ /** Access token kind */
1274
1290
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1275
1291
  linkedUserId: string;
1276
1292
  linkedAppId: string;
@@ -1301,6 +1317,7 @@ export type GetUserResponse = {
1301
1317
  isActive: boolean;
1302
1318
  isServiceAccount: boolean;
1303
1319
  isRegistered: boolean;
1320
+ isSSORequired: boolean;
1304
1321
  permissionAssignments: {
1305
1322
  permissionName: string;
1306
1323
  permissionId: string;
@@ -1329,6 +1346,7 @@ export type ListApplicationsResponse = {
1329
1346
  dateCreated: string;
1330
1347
  credId: string;
1331
1348
  isActive: boolean;
1349
+ /** Access token kind */
1332
1350
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1333
1351
  linkedUserId: string;
1334
1352
  linkedAppId: string;
@@ -1373,6 +1391,7 @@ export type ListPersonalAccessTokensResponse = {
1373
1391
  dateCreated: string;
1374
1392
  credId: string;
1375
1393
  isActive: boolean;
1394
+ /** Access token kind */
1376
1395
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1377
1396
  linkedUserId: string;
1378
1397
  linkedAppId: string;
@@ -1413,6 +1432,7 @@ export type ListServiceAccountsResponse = {
1413
1432
  dateCreated: string;
1414
1433
  credId: string;
1415
1434
  isActive: boolean;
1435
+ /** Access token kind */
1416
1436
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1417
1437
  linkedUserId: string;
1418
1438
  linkedAppId: string;
@@ -1446,6 +1466,7 @@ export type ListUsersResponse = {
1446
1466
  isActive: boolean;
1447
1467
  isServiceAccount: boolean;
1448
1468
  isRegistered: boolean;
1469
+ isSSORequired: boolean;
1449
1470
  permissionAssignments: {
1450
1471
  permissionName: string;
1451
1472
  permissionId: string;
@@ -1526,6 +1547,8 @@ export type LoginBody = {
1526
1547
  };
1527
1548
  export type LoginResponse = {
1528
1549
  token: string;
1550
+ } | {
1551
+ ssoClientId: string;
1529
1552
  };
1530
1553
  export type LoginRequest = {
1531
1554
  body: LoginBody;
@@ -1830,21 +1853,34 @@ export type RegisterEndUserResponse = {
1830
1853
  token: string;
1831
1854
  };
1832
1855
  wallets: {
1856
+ /** ID of the wallet. */
1833
1857
  id: string;
1858
+ /** Network this wallet is bound to. */
1834
1859
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
1860
+ /** Wallet address on its corresponding network. */
1835
1861
  address?: string | undefined;
1862
+ /** Details about the key underlying the wallet. */
1836
1863
  signingKey: {
1837
1864
  id: string;
1865
+ /** Key scheme. */
1838
1866
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
1839
1867
  curve: "ed25519" | "secp256k1" | "stark";
1868
+ /** Hex-encoded value of the public key. */
1840
1869
  publicKey: string;
1870
+ /** The end user ID the key (and wallet) is delegated to. */
1841
1871
  delegatedTo?: string | undefined;
1842
1872
  };
1873
+ /** Wallet status. */
1843
1874
  status: "Active" | "Archived";
1875
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
1844
1876
  dateCreated: string;
1877
+ /** Wallet nickname. */
1845
1878
  name?: string | undefined;
1879
+ /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
1846
1880
  custodial: boolean;
1881
+ /** User-defined value that can be used to correlate the entity with an external system. */
1847
1882
  externalId?: string | undefined;
1883
+ /** List of tags. */
1848
1884
  tags: string[];
1849
1885
  /** Id of the validator on which the wallet is created for Canton networks */
1850
1886
  validatorId?: string | undefined;
@@ -1894,6 +1930,32 @@ export type SocialLoginResponse = {
1894
1930
  export type SocialLoginRequest = {
1895
1931
  body: SocialLoginBody;
1896
1932
  };
1933
+ export type SSOLoginBody = {
1934
+ /** Authorization code obtained from the IdP */
1935
+ code: string;
1936
+ /** State forwarded by the IdP */
1937
+ state: string;
1938
+ };
1939
+ export type SSOLoginResponse = {
1940
+ token: string;
1941
+ };
1942
+ export type SSOLoginRequest = {
1943
+ body: SSOLoginBody;
1944
+ };
1945
+ export type SSOLoginInitBody = {
1946
+ orgId: string;
1947
+ /** Client Id obtained from the IdP */
1948
+ clientId: string;
1949
+ /** Redirect URI used for the authentication flow */
1950
+ redirectUri: string;
1951
+ };
1952
+ export type SSOLoginInitResponse = {
1953
+ /** The URL to redirect the user to authenticate with the IdP */
1954
+ ssoRedirectUrl: string;
1955
+ };
1956
+ export type SSOLoginInitRequest = {
1957
+ body: SSOLoginInitBody;
1958
+ };
1897
1959
  export type UpdatePersonalAccessTokenBody = {
1898
1960
  name?: string | undefined;
1899
1961
  externalId?: string | undefined;
@@ -1906,6 +1968,7 @@ export type UpdatePersonalAccessTokenResponse = {
1906
1968
  dateCreated: string;
1907
1969
  credId: string;
1908
1970
  isActive: boolean;
1971
+ /** Access token kind */
1909
1972
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1910
1973
  linkedUserId: string;
1911
1974
  linkedAppId: string;
@@ -1954,6 +2017,7 @@ export type UpdateServiceAccountResponse = {
1954
2017
  dateCreated: string;
1955
2018
  credId: string;
1956
2019
  isActive: boolean;
2020
+ /** Access token kind */
1957
2021
  kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
1958
2022
  linkedUserId: string;
1959
2023
  linkedAppId: string;
@@ -1972,3 +2036,31 @@ export type UpdateServiceAccountResponse = {
1972
2036
  export type UpdateServiceAccountRequest = UpdateServiceAccountParams & {
1973
2037
  body: UpdateServiceAccountBody;
1974
2038
  };
2039
+ export type UpdateUserBody = {
2040
+ isSSORequired: boolean;
2041
+ };
2042
+ export type UpdateUserParams = {
2043
+ userId: string;
2044
+ };
2045
+ export type UpdateUserResponse = {
2046
+ username: string;
2047
+ name: string;
2048
+ userId: string;
2049
+ kind: "CustomerEmployee" | "DfnsStaff" | "EndUser";
2050
+ credentialUuid: string;
2051
+ orgId: string;
2052
+ permissions?: string[] | undefined;
2053
+ isActive: boolean;
2054
+ isServiceAccount: boolean;
2055
+ isRegistered: boolean;
2056
+ isSSORequired: boolean;
2057
+ permissionAssignments: {
2058
+ permissionName: string;
2059
+ permissionId: string;
2060
+ assignmentId: string;
2061
+ operations?: string[] | undefined;
2062
+ }[];
2063
+ };
2064
+ export type UpdateUserRequest = UpdateUserParams & {
2065
+ body: UpdateUserBody;
2066
+ };
@@ -47,9 +47,7 @@ export type CreateCantonValidatorParams = {
47
47
  network: "canton" | "canton-devnet" | "canton-testnet";
48
48
  };
49
49
  export type CreateCantonValidatorResponse = {
50
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
51
50
  id: string;
52
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
53
51
  orgId: string;
54
52
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
55
53
  name?: string | undefined;
@@ -62,13 +60,10 @@ export type CreateCantonValidatorRequest = CreateCantonValidatorParams & {
62
60
  };
63
61
  export type DeleteCantonValidatorParams = {
64
62
  network: "canton" | "canton-devnet" | "canton-testnet";
65
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
66
63
  validatorId: string;
67
64
  };
68
65
  export type DeleteCantonValidatorResponse = {
69
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
70
66
  id: string;
71
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
72
67
  orgId: string;
73
68
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
74
69
  name?: string | undefined;
@@ -79,13 +74,10 @@ export type DeleteCantonValidatorResponse = {
79
74
  export type DeleteCantonValidatorRequest = DeleteCantonValidatorParams;
80
75
  export type GetCantonValidatorParams = {
81
76
  network: "canton" | "canton-devnet" | "canton-testnet";
82
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
83
77
  validatorId: string;
84
78
  };
85
79
  export type GetCantonValidatorResponse = {
86
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
87
80
  id: string;
88
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
89
81
  orgId: string;
90
82
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
91
83
  name?: string | undefined;
@@ -143,9 +135,7 @@ export type ListCantonValidatorsQuery = {
143
135
  };
144
136
  export type ListCantonValidatorsResponse = {
145
137
  items: {
146
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
147
138
  id: string;
148
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
149
139
  orgId: string;
150
140
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
151
141
  name?: string | undefined;
@@ -214,13 +204,10 @@ export type UpdateCantonValidatorBody = {
214
204
  };
215
205
  export type UpdateCantonValidatorParams = {
216
206
  network: "canton" | "canton-devnet" | "canton-testnet";
217
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
218
207
  validatorId: string;
219
208
  };
220
209
  export type UpdateCantonValidatorResponse = {
221
- /** e.g. 'cv-7jeof-m584r-p35ucm37ko3cqgts' */
222
210
  id: string;
223
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
224
211
  orgId: string;
225
212
  network: "Canton" | "CantonDevnet" | "CantonTestnet";
226
213
  name?: string | undefined;
@@ -36,7 +36,7 @@ export type CreateAssignmentRequest = CreateAssignmentParams & {
36
36
  };
37
37
  export type CreatePermissionBody = {
38
38
  name: string;
39
- operations: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "Auth:Users:Update" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[];
39
+ operations: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[];
40
40
  };
41
41
  export type CreatePermissionResponse = {
42
42
  id: string;
@@ -183,7 +183,7 @@ export type ListPermissionsRequest = {
183
183
  };
184
184
  export type UpdatePermissionBody = {
185
185
  name?: string | undefined;
186
- operations?: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "Auth:Users:Update" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[] | undefined;
186
+ operations?: (("Alias:Create" | "Alias:Delete" | "Alias:Read" | "Alias:Update" | "Auth:Logs:Read" | "Auth:Users:Create" | "Auth:Users:Read" | "Auth:Users:Update" | "Auth:Users:Activate" | "Auth:Users:Deactivate" | "Auth:Users:Delete" | "Auth:ServiceAccounts:Create" | "Auth:ServiceAccounts:Read" | "Auth:ServiceAccounts:Update" | "Auth:ServiceAccounts:Deactivate" | "Auth:ServiceAccounts:Activate" | "Auth:ServiceAccounts:Delete" | "Auth:Pats:Create" | "Auth:Register:Delegated" | "Auth:Login:Delegated" | "Auth:Recover:Delegated" | "Agreements:Acceptance:Create" | "Agreements:Acceptance:Read" | "Exchanges:Create" | "Exchanges:Read" | "Exchanges:Delete" | "Exchanges:Deposits:Create" | "Exchanges:Withdrawals:Create" | "FeeSponsors:Create" | "FeeSponsors:Read" | "FeeSponsors:Update" | "FeeSponsors:Delete" | "Orgs:Read" | "Orgs:Update" | "Orgs:Settings:Read" | "Orgs:Settings:Update" | "Permissions:Archive" | "Permissions:Create" | "Permissions:Read" | "Permissions:Update" | "Permissions:Assign" | "Permissions:Revoke" | "Permissions:Assignments:Read" | "Policies:Archive" | "Policies:Create" | "Policies:Read" | "Policies:Update" | "Policies:Approvals:Read" | "Policies:Approvals:Approve" | "Signers:ListSigners" | "Stakes:Create" | "Stakes:Read" | "Stakes:Update" | "Swaps:Create" | "Swaps:Read" | "Keys:Create" | "Keys:Delete" | "Keys:Read" | "Keys:Update" | "Keys:Reuse" | "Keys:Delegate" | "Keys:Import" | "Keys:Export" | "Keys:Derive" | "Keys:Signatures:Create" | "Keys:Signatures:Read" | "Networks:CantonValidators:Create" | "Networks:CantonValidators:Read" | "Networks:CantonValidators:Update" | "Networks:CantonValidators:Delete" | "Wallets:Create" | "Wallets:Read" | "Wallets:Update" | "Wallets:Tags:Add" | "Wallets:Tags:Delete" | "Wallets:Transactions:Create" | "Wallets:Transactions:Read" | "Wallets:Transfers:Create" | "Wallets:Transfers:Read" | "Wallets:Offers:Read" | "Wallets:Offers:Settle" | "Webhooks:Create" | "Webhooks:Read" | "Webhooks:Update" | "Webhooks:Delete" | "Webhooks:Ping" | "Webhooks:Events:Read" | "Billing:Read" | "Billing:Write" | "Analytics:Read") | ("Wallets:GenerateSignature" | "Wallets:BroadcastTransaction" | "Auth:Action:Sign" | "Auth:Apps:Read" | "Auth:Apps:Create" | "Auth:Apps:Update" | "Auth:Creds:Create" | "Auth:Creds:Read" | "Auth:Creds:Update" | "Auth:Creds:Code:Create" | "Auth:Types:Application" | "Auth:Types:Employee" | "Auth:Types:EndUser" | "Auth:Types:Pat" | "Auth:Types:ServiceAccount" | "Internal:Auth:Types:Staff" | "Auth:Users:Delegate" | "PermissionAssignments:Create" | "PermissionAssignments:Read" | "PermissionAssignments:Revoke"))[] | undefined;
187
187
  };
188
188
  export type UpdatePermissionParams = {
189
189
  permissionId: string;
@@ -1,15 +1,10 @@
1
1
  export type AcceptOfferParams = {
2
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
3
2
  walletId: string;
4
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
5
3
  offerId: string;
6
4
  };
7
5
  export type AcceptOfferResponse = {
8
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
9
6
  id: string;
10
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
11
7
  orgId: string;
12
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
13
8
  walletId: string;
14
9
  network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
15
10
  kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
@@ -186,36 +181,59 @@ export type BroadcastTransactionRequest = BroadcastTransactionParams & {
186
181
  body: BroadcastTransactionBody;
187
182
  };
188
183
  export type CreateWalletBody = {
184
+ /** Network used for the wallet. */
189
185
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
186
+ /** Wallet nickname. */
190
187
  name?: string | undefined;
188
+ /** Options for the wallet's underlying key */
191
189
  signingKey?: {
190
+ /** Use this parameter to create a wallet from an existing key. This enables one key to be used across multiple networks and have the same address if networks share the same address format, ex. `Ethereum` and `Polygon`. If specified, requires the `Keys:Reuse` permission. If the key is delegated to an end user, then the new wallet will be automatically delegated to the same end user. */
192
191
  id?: string | undefined;
193
- scheme?: ("ECDSA" | "EdDSA" | "Schnorr") | undefined;
192
+ /** Use this to specify the new key scheme for networks that support multiple key formats. ex. use `Schnorr` to create a `Bitcoin Taproot` wallet. */
193
+ scheme?: ("DH" | "ECDSA" | "EdDSA" | "Schnorr") | undefined;
194
+ /** Use this to specify the new key curve for networks that support multiple key formats. */
194
195
  curve?: ("ed25519" | "secp256k1" | "stark") | undefined;
195
196
  } | undefined;
197
+ /** ID of the end user to delegate this wallet to. The wallet will only be usable by the end user. More info [here](https://docs.dfns.co/advanced/delegated-signing). */
196
198
  delegateTo?: string | undefined;
199
+ /** Specify if you want to create the wallet from a service account and later [delegate it](/api-reference/keys/delegate-key) to an end user. */
197
200
  delayDelegation?: boolean | undefined;
201
+ /** User-defined value that can be used to correlate the entity with an external system */
198
202
  externalId?: string | undefined;
203
+ /** List of tags to be created for this wallet. If specified, requires the `Wallets:Tags:Add` permission, like the [Tag Wallet](https://docs.dfns.co/api-reference/wallets/tag-wallet) endpoint. */
199
204
  tags?: string[] | undefined;
200
205
  /** Id of the validator on which the wallet is created for Canton networks */
201
206
  validatorId?: string | undefined;
202
207
  };
203
208
  export type CreateWalletResponse = {
209
+ /** ID of the wallet. */
204
210
  id: string;
211
+ /** Network this wallet is bound to. */
205
212
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
213
+ /** Wallet address on its corresponding network. */
206
214
  address?: string | undefined;
215
+ /** Details about the key underlying the wallet. */
207
216
  signingKey: {
208
217
  id: string;
218
+ /** Key scheme. */
209
219
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
210
220
  curve: "ed25519" | "secp256k1" | "stark";
221
+ /** Hex-encoded value of the public key. */
211
222
  publicKey: string;
223
+ /** The end user ID the key (and wallet) is delegated to. */
212
224
  delegatedTo?: string | undefined;
213
225
  };
226
+ /** Wallet status. */
214
227
  status: "Active" | "Archived";
228
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
215
229
  dateCreated: string;
230
+ /** Wallet nickname. */
216
231
  name?: string | undefined;
232
+ /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
217
233
  custodial: boolean;
234
+ /** User-defined value that can be used to correlate the entity with an external system. */
218
235
  externalId?: string | undefined;
236
+ /** List of tags. */
219
237
  tags: string[];
220
238
  /** Id of the validator on which the wallet is created for Canton networks */
221
239
  validatorId?: string | undefined;
@@ -629,17 +647,12 @@ export type GenerateSignatureRequest = GenerateSignatureParams & {
629
647
  body: GenerateSignatureBody;
630
648
  };
631
649
  export type GetOfferParams = {
632
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
633
650
  walletId: string;
634
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
635
651
  offerId: string;
636
652
  };
637
653
  export type GetOfferResponse = {
638
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
639
654
  id: string;
640
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
641
655
  orgId: string;
642
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
643
656
  walletId: string;
644
657
  network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
645
658
  kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
@@ -1401,21 +1414,34 @@ export type GetWalletParams = {
1401
1414
  walletId: string;
1402
1415
  };
1403
1416
  export type GetWalletResponse = {
1417
+ /** ID of the wallet. */
1404
1418
  id: string;
1419
+ /** Network this wallet is bound to. */
1405
1420
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
1421
+ /** Wallet address on its corresponding network. */
1406
1422
  address?: string | undefined;
1423
+ /** Details about the key underlying the wallet. */
1407
1424
  signingKey: {
1408
1425
  id: string;
1426
+ /** Key scheme. */
1409
1427
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
1410
1428
  curve: "ed25519" | "secp256k1" | "stark";
1429
+ /** Hex-encoded value of the public key. */
1411
1430
  publicKey: string;
1431
+ /** The end user ID the key (and wallet) is delegated to. */
1412
1432
  delegatedTo?: string | undefined;
1413
1433
  };
1434
+ /** Wallet status. */
1414
1435
  status: "Active" | "Archived";
1436
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
1415
1437
  dateCreated: string;
1438
+ /** Wallet nickname. */
1416
1439
  name?: string | undefined;
1440
+ /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
1417
1441
  custodial: boolean;
1442
+ /** User-defined value that can be used to correlate the entity with an external system. */
1418
1443
  externalId?: string | undefined;
1444
+ /** List of tags. */
1419
1445
  tags: string[];
1420
1446
  /** Id of the validator on which the wallet is created for Canton networks */
1421
1447
  validatorId?: string | undefined;
@@ -2152,21 +2178,34 @@ export type ImportWalletBody = {
2152
2178
  validatorId?: string | undefined;
2153
2179
  };
2154
2180
  export type ImportWalletResponse = {
2181
+ /** ID of the wallet. */
2155
2182
  id: string;
2183
+ /** Network this wallet is bound to. */
2156
2184
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
2185
+ /** Wallet address on its corresponding network. */
2157
2186
  address?: string | undefined;
2187
+ /** Details about the key underlying the wallet. */
2158
2188
  signingKey: {
2159
2189
  id: string;
2190
+ /** Key scheme. */
2160
2191
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
2161
2192
  curve: "ed25519" | "secp256k1" | "stark";
2193
+ /** Hex-encoded value of the public key. */
2162
2194
  publicKey: string;
2195
+ /** The end user ID the key (and wallet) is delegated to. */
2163
2196
  delegatedTo?: string | undefined;
2164
2197
  };
2198
+ /** Wallet status. */
2165
2199
  status: "Active" | "Archived";
2200
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
2166
2201
  dateCreated: string;
2202
+ /** Wallet nickname. */
2167
2203
  name?: string | undefined;
2204
+ /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
2168
2205
  custodial: boolean;
2206
+ /** User-defined value that can be used to correlate the entity with an external system. */
2169
2207
  externalId?: string | undefined;
2208
+ /** List of tags. */
2170
2209
  tags: string[];
2171
2210
  /** Id of the validator on which the wallet is created for Canton networks */
2172
2211
  validatorId?: string | undefined;
@@ -2175,7 +2214,6 @@ export type ImportWalletRequest = {
2175
2214
  body: ImportWalletBody;
2176
2215
  };
2177
2216
  export type ListOffersParams = {
2178
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
2179
2217
  walletId: string;
2180
2218
  };
2181
2219
  export type ListOffersQuery = {
@@ -2184,11 +2222,8 @@ export type ListOffersQuery = {
2184
2222
  };
2185
2223
  export type ListOffersResponse = {
2186
2224
  items: {
2187
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
2188
2225
  id: string;
2189
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
2190
2226
  orgId: string;
2191
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
2192
2227
  walletId: string;
2193
2228
  network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
2194
2229
  kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
@@ -3018,21 +3053,34 @@ export type ListWalletsQuery = {
3018
3053
  };
3019
3054
  export type ListWalletsResponse = {
3020
3055
  items: {
3056
+ /** ID of the wallet. */
3021
3057
  id: string;
3058
+ /** Network this wallet is bound to. */
3022
3059
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
3060
+ /** Wallet address on its corresponding network. */
3023
3061
  address?: string | undefined;
3062
+ /** Details about the key underlying the wallet. */
3024
3063
  signingKey: {
3025
3064
  id: string;
3065
+ /** Key scheme. */
3026
3066
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
3027
3067
  curve: "ed25519" | "secp256k1" | "stark";
3068
+ /** Hex-encoded value of the public key. */
3028
3069
  publicKey: string;
3070
+ /** The end user ID the key (and wallet) is delegated to. */
3029
3071
  delegatedTo?: string | undefined;
3030
3072
  };
3073
+ /** Wallet status. */
3031
3074
  status: "Active" | "Archived";
3075
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
3032
3076
  dateCreated: string;
3077
+ /** Wallet nickname. */
3033
3078
  name?: string | undefined;
3079
+ /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
3034
3080
  custodial: boolean;
3081
+ /** User-defined value that can be used to correlate the entity with an external system. */
3035
3082
  externalId?: string | undefined;
3083
+ /** List of tags. */
3036
3084
  tags: string[];
3037
3085
  /** Id of the validator on which the wallet is created for Canton networks */
3038
3086
  validatorId?: string | undefined;
@@ -3043,17 +3091,12 @@ export type ListWalletsRequest = {
3043
3091
  query?: ListWalletsQuery;
3044
3092
  };
3045
3093
  export type RejectOfferParams = {
3046
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
3047
3094
  walletId: string;
3048
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
3049
3095
  offerId: string;
3050
3096
  };
3051
3097
  export type RejectOfferResponse = {
3052
- /** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
3053
3098
  id: string;
3054
- /** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
3055
3099
  orgId: string;
3056
- /** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
3057
3100
  walletId: string;
3058
3101
  network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
3059
3102
  kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
@@ -3948,6 +3991,7 @@ export type TransferAssetRequest = TransferAssetParams & {
3948
3991
  body: TransferAssetBody;
3949
3992
  };
3950
3993
  export type UntagWalletBody = {
3994
+ /** List of tags. */
3951
3995
  tags: string[];
3952
3996
  };
3953
3997
  export type UntagWalletParams = {
@@ -3965,21 +4009,34 @@ export type UpdateWalletParams = {
3965
4009
  walletId: string;
3966
4010
  };
3967
4011
  export type UpdateWalletResponse = {
4012
+ /** ID of the wallet. */
3968
4013
  id: string;
4014
+ /** Network this wallet is bound to. */
3969
4015
  network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
4016
+ /** Wallet address on its corresponding network. */
3970
4017
  address?: string | undefined;
4018
+ /** Details about the key underlying the wallet. */
3971
4019
  signingKey: {
3972
4020
  id: string;
4021
+ /** Key scheme. */
3973
4022
  scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
3974
4023
  curve: "ed25519" | "secp256k1" | "stark";
4024
+ /** Hex-encoded value of the public key. */
3975
4025
  publicKey: string;
4026
+ /** The end user ID the key (and wallet) is delegated to. */
3976
4027
  delegatedTo?: string | undefined;
3977
4028
  };
4029
+ /** Wallet status. */
3978
4030
  status: "Active" | "Archived";
4031
+ /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
3979
4032
  dateCreated: string;
4033
+ /** Wallet nickname. */
3980
4034
  name?: string | undefined;
4035
+ /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
3981
4036
  custodial: boolean;
4037
+ /** User-defined value that can be used to correlate the entity with an external system. */
3982
4038
  externalId?: string | undefined;
4039
+ /** List of tags. */
3983
4040
  tags: string[];
3984
4041
  /** Id of the validator on which the wallet is created for Canton networks */
3985
4042
  validatorId?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dfns/sdk",
3
- "version": "0.7.12",
3
+ "version": "0.7.13-rc.0",
4
4
  "dependencies": {
5
5
  "buffer": "^6.0.3",
6
6
  "cross-fetch": "^3.1.6"