@openzeppelin/ui-renderer 1.1.1 → 2.0.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.
- package/README.md +69 -28
- package/dist/index.cjs +179 -104
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +45 -25
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +45 -25
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +177 -105
- package/dist/index.mjs.map +1 -1
- package/package.json +6 -6
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AddressBookWidgetProps,
|
|
1
|
+
import { AddressBookWidgetProps, AddressingCapability, ContractFunction, ContractSchema, ContractStateCapabilityProps, DynamicFormContextProps, Ecosystem, ExecutionConfig, ExecutionConfigCapabilityProps, FieldTransforms, FieldType, FormFieldType, FormValues, NetworkConfig, RelayerCapability, TransactionFormProps, TransactionSuccessPayload } from "@openzeppelin/ui-types";
|
|
2
2
|
import React$1, { JSX } from "react";
|
|
3
3
|
import { Control } from "react-hook-form";
|
|
4
4
|
import { ButtonProps } from "@openzeppelin/ui-components";
|
|
@@ -65,7 +65,8 @@ declare function TransactionForm({
|
|
|
65
65
|
contractSchema,
|
|
66
66
|
adapter,
|
|
67
67
|
isWalletConnected,
|
|
68
|
-
executionConfig
|
|
68
|
+
executionConfig,
|
|
69
|
+
onTransactionSuccess
|
|
69
70
|
}: TransactionFormProps): React.ReactElement;
|
|
70
71
|
//#endregion
|
|
71
72
|
//#region src/utils/formUtils.d.ts
|
|
@@ -92,10 +93,10 @@ declare function validateField(value: unknown, validation?: {
|
|
|
92
93
|
/**
|
|
93
94
|
* Creates a transform for address fields
|
|
94
95
|
*
|
|
95
|
-
* @param
|
|
96
|
+
* @param addressing The addressing capability to use for validation
|
|
96
97
|
* @returns Transform functions for address fields
|
|
97
98
|
*/
|
|
98
|
-
declare function createAddressTransform(
|
|
99
|
+
declare function createAddressTransform(addressing: AddressingCapability): FieldTransforms<string>;
|
|
99
100
|
/**
|
|
100
101
|
* Creates a transform for number fields
|
|
101
102
|
*
|
|
@@ -130,10 +131,10 @@ declare function createTextTransform(): FieldTransforms<string>;
|
|
|
130
131
|
* Creates a transform function based on field type
|
|
131
132
|
*
|
|
132
133
|
* @param fieldType The type of field to create transforms for
|
|
133
|
-
* @param
|
|
134
|
+
* @param addressing Optional addressing capability for address validation
|
|
134
135
|
* @returns Transform functions for the field type
|
|
135
136
|
*/
|
|
136
|
-
declare function createTransformForFieldType(fieldType: FieldType,
|
|
137
|
+
declare function createTransformForFieldType(fieldType: FieldType, addressing?: AddressingCapability): FieldTransforms<unknown>;
|
|
137
138
|
/**
|
|
138
139
|
* Generate a default value for a given field type based on parameter constraints
|
|
139
140
|
*/
|
|
@@ -170,11 +171,37 @@ declare function createObjectTransform(): FieldTransforms<Record<string, unknown
|
|
|
170
171
|
*/
|
|
171
172
|
declare function createArrayObjectTransform(): FieldTransforms<Record<string, unknown>[]>;
|
|
172
173
|
//#endregion
|
|
174
|
+
//#region src/utils/transactionSuccessCallback.d.ts
|
|
175
|
+
/**
|
|
176
|
+
* Normalizes adapter `txHash` for the success callback (non-empty trimmed string or omitted).
|
|
177
|
+
* Expects the `txHash` string from `signAndBroadcast`, not arbitrary values (avoids coercing objects).
|
|
178
|
+
*/
|
|
179
|
+
declare function normalizeTransactionSuccessHash(finalTxHash: string | null | undefined): string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* Builds the {@link TransactionSuccessPayload} passed to `onTransactionSuccess`.
|
|
182
|
+
*/
|
|
183
|
+
declare function buildTransactionSuccessPayload(options: {
|
|
184
|
+
networkId: TransactionSuccessPayload['network_id'];
|
|
185
|
+
ecosystem: Ecosystem;
|
|
186
|
+
executionMethod: ExecutionConfig['method'];
|
|
187
|
+
/** From `signAndBroadcast` result (`txHash: string`) */
|
|
188
|
+
finalTxHash: string | null | undefined;
|
|
189
|
+
}): TransactionSuccessPayload;
|
|
190
|
+
/** Minimal logger surface used by {@link invokeOnTransactionSuccess}. */
|
|
191
|
+
type TransactionSuccessLog = {
|
|
192
|
+
error(component: string, message: string, error?: unknown): void;
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* Invokes `onTransactionSuccess` with error containment: synchronous throws and async
|
|
196
|
+
* rejections are logged and never rethrown, so host callbacks cannot break transaction flow.
|
|
197
|
+
*/
|
|
198
|
+
declare function invokeOnTransactionSuccess(callback: ((payload: TransactionSuccessPayload) => void | Promise<void>) | undefined, payload: TransactionSuccessPayload, log: TransactionSuccessLog): void;
|
|
199
|
+
//#endregion
|
|
173
200
|
//#region src/components/DynamicFormField.d.ts
|
|
174
201
|
/**
|
|
175
202
|
* Props for the DynamicFormField component
|
|
176
203
|
*/
|
|
177
|
-
interface DynamicFormFieldProps {
|
|
204
|
+
interface DynamicFormFieldProps extends DynamicFormContextProps {
|
|
178
205
|
/**
|
|
179
206
|
* The field configuration to render
|
|
180
207
|
*/
|
|
@@ -183,14 +210,6 @@ interface DynamicFormFieldProps {
|
|
|
183
210
|
* The React Hook Form control
|
|
184
211
|
*/
|
|
185
212
|
control: Control<FormValues>;
|
|
186
|
-
/**
|
|
187
|
-
* The adapter for chain-specific validation and formatting
|
|
188
|
-
*/
|
|
189
|
-
adapter: ContractAdapter;
|
|
190
|
-
/**
|
|
191
|
-
* Optional contract schema for nested metadata lookups
|
|
192
|
-
*/
|
|
193
|
-
contractSchema?: ContractSchema;
|
|
194
213
|
/**
|
|
195
214
|
* The field error message, if any (Kept for potential direct use, though RHF handles it)
|
|
196
215
|
*/
|
|
@@ -213,7 +232,8 @@ interface DynamicFormFieldProps {
|
|
|
213
232
|
declare function DynamicFormField({
|
|
214
233
|
field,
|
|
215
234
|
control,
|
|
216
|
-
|
|
235
|
+
addressing,
|
|
236
|
+
typeMapping,
|
|
217
237
|
contractSchema
|
|
218
238
|
}: DynamicFormFieldProps): React$1.ReactElement | null;
|
|
219
239
|
//#endregion
|
|
@@ -277,8 +297,8 @@ declare function AddressBookWidget({
|
|
|
277
297
|
currentNetworkId,
|
|
278
298
|
resolveNetwork,
|
|
279
299
|
resolveExplorerUrl,
|
|
280
|
-
|
|
281
|
-
|
|
300
|
+
addressing,
|
|
301
|
+
resolveAddressing,
|
|
282
302
|
addressPlaceholder,
|
|
283
303
|
resolveAddressPlaceholder,
|
|
284
304
|
networks,
|
|
@@ -344,10 +364,9 @@ interface UseAliasEditStateReturn {
|
|
|
344
364
|
declare function useAliasEditState(defaultNetworkId?: string): UseAliasEditStateReturn;
|
|
345
365
|
//#endregion
|
|
346
366
|
//#region src/components/ContractStateWidget/ContractStateWidget.d.ts
|
|
347
|
-
interface ContractStateWidgetProps {
|
|
367
|
+
interface ContractStateWidgetProps extends ContractStateCapabilityProps {
|
|
348
368
|
contractSchema: ContractSchema | null;
|
|
349
369
|
contractAddress: string | null;
|
|
350
|
-
adapter: FullContractAdapter;
|
|
351
370
|
isVisible?: boolean;
|
|
352
371
|
onToggle?: () => void;
|
|
353
372
|
className?: string;
|
|
@@ -360,7 +379,8 @@ interface ContractStateWidgetProps {
|
|
|
360
379
|
declare function ContractStateWidget({
|
|
361
380
|
contractSchema,
|
|
362
381
|
contractAddress,
|
|
363
|
-
|
|
382
|
+
query,
|
|
383
|
+
schema,
|
|
364
384
|
isVisible,
|
|
365
385
|
onToggle,
|
|
366
386
|
className,
|
|
@@ -391,9 +411,8 @@ declare function ContractActionBar({
|
|
|
391
411
|
}: ContractActionBarProps): React$1.ReactElement | null;
|
|
392
412
|
//#endregion
|
|
393
413
|
//#region src/components/ExecutionConfigDisplay/ExecutionConfigDisplay.d.ts
|
|
394
|
-
interface ExecutionConfigDisplayProps {
|
|
414
|
+
interface ExecutionConfigDisplayProps extends ExecutionConfigCapabilityProps {
|
|
395
415
|
executionConfig: ExecutionConfig;
|
|
396
|
-
adapter?: ContractAdapter;
|
|
397
416
|
error?: string | null;
|
|
398
417
|
connectedWalletAddress?: string;
|
|
399
418
|
onRuntimeApiKeyChange?: (apiKey: string) => void;
|
|
@@ -408,7 +427,8 @@ interface Props {
|
|
|
408
427
|
id: string;
|
|
409
428
|
name: string;
|
|
410
429
|
} | null;
|
|
411
|
-
|
|
430
|
+
relayer: RelayerCapability | null;
|
|
431
|
+
onSettingsChanged?: () => void;
|
|
412
432
|
}
|
|
413
433
|
declare const NetworkSettingsDialog: React$1.FC<Props>;
|
|
414
434
|
//#endregion
|
|
@@ -419,5 +439,5 @@ declare const NetworkSettingsDialog: React$1.FC<Props>;
|
|
|
419
439
|
*/
|
|
420
440
|
declare const WalletConnectionWithSettings: React$1.FC;
|
|
421
441
|
//#endregion
|
|
422
|
-
export { AddressBookWidget, type AliasEditLookupResult, AliasEditPopover, type AliasEditPopoverProps, ContractActionBar, ContractStateWidget, DynamicFormField, ExecutionConfigDisplay, NetworkSettingsDialog, ParameterConstraints, type RendererConfig, TransactionExecuteButton, TransactionForm, type UseAliasEditStateReturn, WalletConnectionWithSettings, createAddressTransform, createArrayObjectTransform, createArrayTransform, createBigIntTransform, createBooleanTransform, createComplexTypeTransform, createDefaultFormValues, createNumberTransform, createObjectTransform, createTextTransform, createTransformForFieldType, generateDefaultValue, getDefaultValueByFieldType, rendererConfig, useAliasEditState, validateField };
|
|
442
|
+
export { AddressBookWidget, type AliasEditLookupResult, AliasEditPopover, type AliasEditPopoverProps, ContractActionBar, ContractStateWidget, DynamicFormField, ExecutionConfigDisplay, NetworkSettingsDialog, ParameterConstraints, type RendererConfig, TransactionExecuteButton, TransactionForm, TransactionSuccessLog, type UseAliasEditStateReturn, WalletConnectionWithSettings, buildTransactionSuccessPayload, createAddressTransform, createArrayObjectTransform, createArrayTransform, createBigIntTransform, createBooleanTransform, createComplexTypeTransform, createDefaultFormValues, createNumberTransform, createObjectTransform, createTextTransform, createTransformForFieldType, generateDefaultValue, getDefaultValueByFieldType, invokeOnTransactionSuccess, normalizeTransactionSuccessHash, rendererConfig, useAliasEditState, validateField };
|
|
423
443
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types/RendererConfig.ts","../src/config.ts","../src/components/TransactionForm.tsx","../src/utils/formUtils.ts","../src/components/DynamicFormField.tsx","../src/components/transaction/TransactionExecuteButton.tsx","../src/components/AddressBookWidget/AddressBookWidget.tsx","../src/components/AddressBookWidget/AliasEditPopover.tsx","../src/components/AddressBookWidget/useAliasEditState.ts","../src/components/ContractStateWidget/ContractStateWidget.tsx","../src/components/ContractActionBar/ContractActionBar.tsx","../src/components/ExecutionConfigDisplay/ExecutionConfigDisplay.tsx","../src/components/network/NetworkSettingsDialog.tsx","../src/components/WalletConnectionWithSettings.tsx"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;;AASA;AAIoB,UAJH,cAAA,CAIG;EAWO;;;EANA,gBAAA,EALP,MAKO,CAAA,MAAA,EAAA,MAAA,CAAA;;;;ECJd,iBA4EZ,EDxEoB,MCwEpB,CAAA,MA5E4B,EAAA;;;;
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types/RendererConfig.ts","../src/config.ts","../src/components/TransactionForm.tsx","../src/utils/formUtils.ts","../src/utils/transactionSuccessCallback.ts","../src/components/DynamicFormField.tsx","../src/components/transaction/TransactionExecuteButton.tsx","../src/components/AddressBookWidget/AddressBookWidget.tsx","../src/components/AddressBookWidget/AliasEditPopover.tsx","../src/components/AddressBookWidget/useAliasEditState.ts","../src/components/ContractStateWidget/ContractStateWidget.tsx","../src/components/ContractActionBar/ContractActionBar.tsx","../src/components/ExecutionConfigDisplay/ExecutionConfigDisplay.tsx","../src/components/network/NetworkSettingsDialog.tsx","../src/components/WalletConnectionWithSettings.tsx"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;;AASA;AAIoB,UAJH,cAAA,CAIG;EAWO;;;EANA,gBAAA,EALP,MAKO,CAAA,MAAA,EAAA,MAAA,CAAA;;;;ECJd,iBA4EZ,EDxEoB,MCwEpB,CAAA,MA5E4B,EAAA;;;;ICiCb,mBAAe,EFvBJ,MEuBI,CAAA,MAAA,EAAA,MAAA,CAAA;IAC7B;;;IAGA,eAAA,CAAA,EFtBsB,MEsBtB,CAAA,MAAA,EAAA,MAAA,CAAA;EACA,CAAA,CAAA;;;;;;;;cDtCW,gBAAgB;;;;;;;;;ADL7B;;;;;;;;;ACKA;;;iBCiCgB,eAAA;;;;;;;GAOb,uBAAuB,KAAA,CAAM;;;;;;AFpCX,UGLJ,oBAAA,CHKI;EAAM,QAAA,CAAA,EAAA,OAAA;;;;ECJd,SAAA,CAAA,EAAA,MA4EZ;;;;AC3CD;;AAEE,iBCxBc,aAAA,CDwBd,KAAA,EAAA,OAAA,EAAA,UAKC,CALD,EAAA;EACA,QAAA,CAAA,EAAA,OAAA;EACA,GAAA,CAAA,EAAA,MAAA;EACA,GAAA,CAAA,EAAA,MAAA;EACA,OAAA,CAAA,EAAA,MAAA;CACC,CAAA,EAAA,MAAA,GAAA,IAAA;;;;;;ACzCH;AAYgB,iBAiCA,sBAAA,CAjCa,UAAA,EAiCsB,oBAjCtB,CAAA,EAiC6C,eAjC7C,CAAA,MAAA,CAAA;AAiC7B;AAqBA;AAkBA;AAuBA;AAuBA;AA6BgB,iBA7FA,qBAAA,CAAA,CA6FuB,EA7FE,eA6Fa,CAAA,MAAA,CAAA;AAuBtD;;;;;AA+CgB,iBAjJA,qBAAA,CAAA,CAmJO,EAnJkB,eAmJ1B,CAAA,MAAO,CAAA;AAqBtB;AAmBA;;;;AAGa,iBAvKG,sBAAA,CAAA,CAuKH,EAvK6B,eAuK7B,CAAA,OAAA,CAAA;AAsBb;AAwCA;AAiDA;;;iBA/PgB,0BAAA,CAAA,GAA8B;ACzI9C;AAaA;;;;AAMI,iBDmJY,mBAAA,CAAA,CCnJZ,EDmJmC,eCnJnC,CAAA,MAAA,CAAA;;AAWJ;AAQA;;;;;AAG4B,iBDoJZ,2BAAA,CCpJY,SAAA,EDqJf,SCrJe,EAAA,UAAA,CAAA,EDsJb,oBCtJa,CAAA,EDuJzB,eCvJyB,CAAA,OAAA,CAAA;;;;AC5BlB,iBF+NM,oBAAA,CE/NgB,aAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EFiOjB,OEjOiB,CFiOT,oBEjOS,CAAA,CAAA,EAAA,OAAA;;;;AAAQ,iBFsPxB,0BAAA,CEtPwB,SAAA,EFsPc,SEtPd,CAAA,EAAA,MAAA,GAAA,OAAA,GAAA,MAAA;;AAiFxC;;;;;;;AAM2B,iBFkLX,uBAAA,CElLiB,MAAA,EFmLvB,aEnLuB,EAAA,GAAA,SAAA,EAAA,gBAAA,CAAA,EFoLb,MEpLa,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EFqL9B,UErL8B;;;;;ACvGjC;AA2CgB,iBHuQA,oBAAA,CAAA,CGvQwB,EHuQA,eGvQA,CAAA,OAAA,EAAA,CAAA;;;;;;AAMtC,iBHySc,qBAAA,CAAA,CGzSd,EHySuC,eGzSvC,CHySuD,MGzSvD,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;;;;;;iBH0Vc,0BAAA,CAAA,GAA8B,gBAAgB;;;;;;;iBCxY9C,+BAAA;;AJGhB;;AAe2B,iBILX,8BAAA,CJKW,OAAA,EAAA;EAKH,SAAA,EITX,yBJSW,CAAA,YAAA,CAAA;EAXH,SAAA,EIGR,SJHQ;EAAM,eAAA,EIIR,eJJQ,CAAA,QAAA,CAAA;;;IIOvB;AHXJ;KGsBY,qBAAA;;;AFWZ;;;;AAIE,iBEPc,0BAAA,CFOd,QAAA,EAAA,CAAA,CAAA,OAAA,EENqB,yBFMrB,EAAA,GAAA,IAAA,GEN0D,OFM1D,CAAA,IAAA,CAAA,CAAA,GAAA,SAAA,EAAA,OAAA,EELS,yBFKT,EAAA,GAAA,EEJK,qBFIL,CAAA,EAAA,IAAA;;;;;;AF1CF,UKUU,qBAAA,SAA8B,uBLVT,CAAA;EAIX;;;EAKC,KAAA,EKKZ,aLLY;EAAM;;;WKUhB,QAAQ;EJdN;;;;ACiCb;;;;;;;;;;;;;AClCA;AAYA;AAiCgB,iBE0CA,gBAAA,CF1CmC;EAAA,KAAA;EAAA,OAAA;EAAA,UAAuB;EAAA,WAAe;EAAA;AAAA,CAAA,EEgDtF,qBFhDsF,CAAA,EEgD9D,OAAA,CAAM,YFhDwD,GAAA,IAAA;;;UGvDxE,6BAAA;;;;;ENMA;;;EAoBO,YAAA,EAAA,OAAA;EAXH;;;;;ACJrB;;YKQY;;AJyBZ;;;EAGE,eAAA,CAAA,EItBkB,gBJsBlB;EACA;;;;EAGwB,iBAAM,CAAA,EAAA,OAAA;;;;;ACzChC;AAYA;AAiCA;AAqBA;AAkBA;AAuBA;AAuBgB,iBGjGA,wBAAA,CHiG8B;EAAA,iBAAe;EAAA,YAAA;EAAA,WAAA;EAAA,OAAA;EAAA,eAAA;EAAA;AAAA,CAAA,EG1F1D,6BH0F0D,CAAA,EG1F1B,KAAA,CAAM,YH0FoB;;;;iBIzH7C,iBAAA;;;;;;;;;;;;;;;;;;;;GAoBb,yBAAsB,kBAAA,CAAA,GAAA,CAAA;;;UC7BR,qBAAA;;;;UAKA,qBAAA;;;ERTA,UAAA,EQYH,ORZiB;EAIX,OAAA,EAAA,GAAA,GAAA,IAAA;EAWO;EAKH,QAAA,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,SAAA,CAAA,EAAA,MAAA,EAAA,GQL6B,ORK7B,CQLqC,qBRKrC,GAAA,SAAA,CAAA;EAXH;EAAM,MAAA,EAAA,CAAA,KAAA,EAAA;;;;ECJd,CAAA,EAAA,GOYgE,OPZhE,CAAA,MA4EZ,CAAA;;4BO9D2B;;ANmB5B;AACE,iBMhBc,gBAAA,CNgBd;EAAA,OAAA;EAAA,SAAA;EAAA,UAAA;EAAA,OAAA;EAAA,QAAA;EAAA,MAAA;EAAA;AAAA,CAAA,EMRC,qBNQD,CAAA,EMRsB,kBAAA,CAAA,GAAA,CAAA,ONQtB;;;UOrCQ,YAAA;;;cAGI;;;UAIG,uBAAA;ETTA;EAIG,OAAA,ESOT,YTPS,GAAA,IAAA;EAWO;EAKH,WAAA,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,SAAA,CAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EAXH;EAAM,WAAA,EAAA,GAAA,GAAA,IAAA;;gBSQX,KAAA,CAAM;;IRZT,CAAA,EAAA,MAAA;;;;ACiCG,iBOjBA,iBAAA,CPiBe,gBAAA,CAAA,EAAA,MAAA,CAAA,EOjB+B,uBPiB/B;;;UQlCrB,wBAAA,SAAiC;kBACzB;;;;EVLD,SAAA,CAAA,EAAA,MAAc;EAIX,KAAA,CAAA,EUMV,KVNU,GAAA,IAAA;;;;;;iBUaJ,mBAAA;;;;;;;;;GASb,2BAA2B,GAAA,CAAI;;;UC9BxB,sBAAA;iBACO;;;;EXGA,QAAA,CAAA,EWCJ,OAAA,CAAM,SXDY;EAIX,SAAA,CAAA,EAAA,MAAA;;;;;;;iBWMJ,iBAAA;;;;;;;GAOb,yBAAyB,OAAA,CAAM;;;UCGxB,2BAAA,SAAoC;mBAC3B;;;;AZrBnB;AAIoB,cY2BP,sBZ3BO,EY2BiB,OAAA,CAAM,EZ3BvB,CY2B0B,2BZ3B1B,CAAA;;;UaKV,KAAA;;;;;IbTO,IAAA,EAAA,MAAA;EAIG,CAAA,GAAA,IAAA;EAWO,OAAA,EaFhB,iBbEgB,GAAA,IAAA;EAKH,iBAAA,CAAA,EAAA,GAAA,GAAA,IAAA;;AAXG,caQd,qBbRc,EaQS,OAAA,CAAM,EbRf,CaQkB,KbRlB,CAAA;;;;;;;ccJd,8BAA8B,OAAA,CAAM"}
|
package/dist/index.d.mts
CHANGED
|
@@ -2,7 +2,7 @@ import React$1, { JSX } from "react";
|
|
|
2
2
|
import { Control } from "react-hook-form";
|
|
3
3
|
import { ButtonProps } from "@openzeppelin/ui-components";
|
|
4
4
|
import * as react_jsx_runtime0 from "react/jsx-runtime";
|
|
5
|
-
import { AddressBookWidgetProps,
|
|
5
|
+
import { AddressBookWidgetProps, AddressingCapability, ContractFunction, ContractSchema, ContractStateCapabilityProps, DynamicFormContextProps, Ecosystem, ExecutionConfig, ExecutionConfigCapabilityProps, FieldTransforms, FieldType, FormFieldType, FormValues, NetworkConfig, RelayerCapability, TransactionFormProps, TransactionSuccessPayload } from "@openzeppelin/ui-types";
|
|
6
6
|
|
|
7
7
|
//#region src/types/RendererConfig.d.ts
|
|
8
8
|
|
|
@@ -65,7 +65,8 @@ declare function TransactionForm({
|
|
|
65
65
|
contractSchema,
|
|
66
66
|
adapter,
|
|
67
67
|
isWalletConnected,
|
|
68
|
-
executionConfig
|
|
68
|
+
executionConfig,
|
|
69
|
+
onTransactionSuccess
|
|
69
70
|
}: TransactionFormProps): React.ReactElement;
|
|
70
71
|
//#endregion
|
|
71
72
|
//#region src/utils/formUtils.d.ts
|
|
@@ -92,10 +93,10 @@ declare function validateField(value: unknown, validation?: {
|
|
|
92
93
|
/**
|
|
93
94
|
* Creates a transform for address fields
|
|
94
95
|
*
|
|
95
|
-
* @param
|
|
96
|
+
* @param addressing The addressing capability to use for validation
|
|
96
97
|
* @returns Transform functions for address fields
|
|
97
98
|
*/
|
|
98
|
-
declare function createAddressTransform(
|
|
99
|
+
declare function createAddressTransform(addressing: AddressingCapability): FieldTransforms<string>;
|
|
99
100
|
/**
|
|
100
101
|
* Creates a transform for number fields
|
|
101
102
|
*
|
|
@@ -130,10 +131,10 @@ declare function createTextTransform(): FieldTransforms<string>;
|
|
|
130
131
|
* Creates a transform function based on field type
|
|
131
132
|
*
|
|
132
133
|
* @param fieldType The type of field to create transforms for
|
|
133
|
-
* @param
|
|
134
|
+
* @param addressing Optional addressing capability for address validation
|
|
134
135
|
* @returns Transform functions for the field type
|
|
135
136
|
*/
|
|
136
|
-
declare function createTransformForFieldType(fieldType: FieldType,
|
|
137
|
+
declare function createTransformForFieldType(fieldType: FieldType, addressing?: AddressingCapability): FieldTransforms<unknown>;
|
|
137
138
|
/**
|
|
138
139
|
* Generate a default value for a given field type based on parameter constraints
|
|
139
140
|
*/
|
|
@@ -170,11 +171,37 @@ declare function createObjectTransform(): FieldTransforms<Record<string, unknown
|
|
|
170
171
|
*/
|
|
171
172
|
declare function createArrayObjectTransform(): FieldTransforms<Record<string, unknown>[]>;
|
|
172
173
|
//#endregion
|
|
174
|
+
//#region src/utils/transactionSuccessCallback.d.ts
|
|
175
|
+
/**
|
|
176
|
+
* Normalizes adapter `txHash` for the success callback (non-empty trimmed string or omitted).
|
|
177
|
+
* Expects the `txHash` string from `signAndBroadcast`, not arbitrary values (avoids coercing objects).
|
|
178
|
+
*/
|
|
179
|
+
declare function normalizeTransactionSuccessHash(finalTxHash: string | null | undefined): string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* Builds the {@link TransactionSuccessPayload} passed to `onTransactionSuccess`.
|
|
182
|
+
*/
|
|
183
|
+
declare function buildTransactionSuccessPayload(options: {
|
|
184
|
+
networkId: TransactionSuccessPayload['network_id'];
|
|
185
|
+
ecosystem: Ecosystem;
|
|
186
|
+
executionMethod: ExecutionConfig['method'];
|
|
187
|
+
/** From `signAndBroadcast` result (`txHash: string`) */
|
|
188
|
+
finalTxHash: string | null | undefined;
|
|
189
|
+
}): TransactionSuccessPayload;
|
|
190
|
+
/** Minimal logger surface used by {@link invokeOnTransactionSuccess}. */
|
|
191
|
+
type TransactionSuccessLog = {
|
|
192
|
+
error(component: string, message: string, error?: unknown): void;
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* Invokes `onTransactionSuccess` with error containment: synchronous throws and async
|
|
196
|
+
* rejections are logged and never rethrown, so host callbacks cannot break transaction flow.
|
|
197
|
+
*/
|
|
198
|
+
declare function invokeOnTransactionSuccess(callback: ((payload: TransactionSuccessPayload) => void | Promise<void>) | undefined, payload: TransactionSuccessPayload, log: TransactionSuccessLog): void;
|
|
199
|
+
//#endregion
|
|
173
200
|
//#region src/components/DynamicFormField.d.ts
|
|
174
201
|
/**
|
|
175
202
|
* Props for the DynamicFormField component
|
|
176
203
|
*/
|
|
177
|
-
interface DynamicFormFieldProps {
|
|
204
|
+
interface DynamicFormFieldProps extends DynamicFormContextProps {
|
|
178
205
|
/**
|
|
179
206
|
* The field configuration to render
|
|
180
207
|
*/
|
|
@@ -183,14 +210,6 @@ interface DynamicFormFieldProps {
|
|
|
183
210
|
* The React Hook Form control
|
|
184
211
|
*/
|
|
185
212
|
control: Control<FormValues>;
|
|
186
|
-
/**
|
|
187
|
-
* The adapter for chain-specific validation and formatting
|
|
188
|
-
*/
|
|
189
|
-
adapter: ContractAdapter;
|
|
190
|
-
/**
|
|
191
|
-
* Optional contract schema for nested metadata lookups
|
|
192
|
-
*/
|
|
193
|
-
contractSchema?: ContractSchema;
|
|
194
213
|
/**
|
|
195
214
|
* The field error message, if any (Kept for potential direct use, though RHF handles it)
|
|
196
215
|
*/
|
|
@@ -213,7 +232,8 @@ interface DynamicFormFieldProps {
|
|
|
213
232
|
declare function DynamicFormField({
|
|
214
233
|
field,
|
|
215
234
|
control,
|
|
216
|
-
|
|
235
|
+
addressing,
|
|
236
|
+
typeMapping,
|
|
217
237
|
contractSchema
|
|
218
238
|
}: DynamicFormFieldProps): React$1.ReactElement | null;
|
|
219
239
|
//#endregion
|
|
@@ -277,8 +297,8 @@ declare function AddressBookWidget({
|
|
|
277
297
|
currentNetworkId,
|
|
278
298
|
resolveNetwork,
|
|
279
299
|
resolveExplorerUrl,
|
|
280
|
-
|
|
281
|
-
|
|
300
|
+
addressing,
|
|
301
|
+
resolveAddressing,
|
|
282
302
|
addressPlaceholder,
|
|
283
303
|
resolveAddressPlaceholder,
|
|
284
304
|
networks,
|
|
@@ -344,10 +364,9 @@ interface UseAliasEditStateReturn {
|
|
|
344
364
|
declare function useAliasEditState(defaultNetworkId?: string): UseAliasEditStateReturn;
|
|
345
365
|
//#endregion
|
|
346
366
|
//#region src/components/ContractStateWidget/ContractStateWidget.d.ts
|
|
347
|
-
interface ContractStateWidgetProps {
|
|
367
|
+
interface ContractStateWidgetProps extends ContractStateCapabilityProps {
|
|
348
368
|
contractSchema: ContractSchema | null;
|
|
349
369
|
contractAddress: string | null;
|
|
350
|
-
adapter: FullContractAdapter;
|
|
351
370
|
isVisible?: boolean;
|
|
352
371
|
onToggle?: () => void;
|
|
353
372
|
className?: string;
|
|
@@ -360,7 +379,8 @@ interface ContractStateWidgetProps {
|
|
|
360
379
|
declare function ContractStateWidget({
|
|
361
380
|
contractSchema,
|
|
362
381
|
contractAddress,
|
|
363
|
-
|
|
382
|
+
query,
|
|
383
|
+
schema,
|
|
364
384
|
isVisible,
|
|
365
385
|
onToggle,
|
|
366
386
|
className,
|
|
@@ -391,9 +411,8 @@ declare function ContractActionBar({
|
|
|
391
411
|
}: ContractActionBarProps): React$1.ReactElement | null;
|
|
392
412
|
//#endregion
|
|
393
413
|
//#region src/components/ExecutionConfigDisplay/ExecutionConfigDisplay.d.ts
|
|
394
|
-
interface ExecutionConfigDisplayProps {
|
|
414
|
+
interface ExecutionConfigDisplayProps extends ExecutionConfigCapabilityProps {
|
|
395
415
|
executionConfig: ExecutionConfig;
|
|
396
|
-
adapter?: ContractAdapter;
|
|
397
416
|
error?: string | null;
|
|
398
417
|
connectedWalletAddress?: string;
|
|
399
418
|
onRuntimeApiKeyChange?: (apiKey: string) => void;
|
|
@@ -408,7 +427,8 @@ interface Props {
|
|
|
408
427
|
id: string;
|
|
409
428
|
name: string;
|
|
410
429
|
} | null;
|
|
411
|
-
|
|
430
|
+
relayer: RelayerCapability | null;
|
|
431
|
+
onSettingsChanged?: () => void;
|
|
412
432
|
}
|
|
413
433
|
declare const NetworkSettingsDialog: React$1.FC<Props>;
|
|
414
434
|
//#endregion
|
|
@@ -419,5 +439,5 @@ declare const NetworkSettingsDialog: React$1.FC<Props>;
|
|
|
419
439
|
*/
|
|
420
440
|
declare const WalletConnectionWithSettings: React$1.FC;
|
|
421
441
|
//#endregion
|
|
422
|
-
export { AddressBookWidget, type AliasEditLookupResult, AliasEditPopover, type AliasEditPopoverProps, ContractActionBar, ContractStateWidget, DynamicFormField, ExecutionConfigDisplay, NetworkSettingsDialog, ParameterConstraints, type RendererConfig, TransactionExecuteButton, TransactionForm, type UseAliasEditStateReturn, WalletConnectionWithSettings, createAddressTransform, createArrayObjectTransform, createArrayTransform, createBigIntTransform, createBooleanTransform, createComplexTypeTransform, createDefaultFormValues, createNumberTransform, createObjectTransform, createTextTransform, createTransformForFieldType, generateDefaultValue, getDefaultValueByFieldType, rendererConfig, useAliasEditState, validateField };
|
|
442
|
+
export { AddressBookWidget, type AliasEditLookupResult, AliasEditPopover, type AliasEditPopoverProps, ContractActionBar, ContractStateWidget, DynamicFormField, ExecutionConfigDisplay, NetworkSettingsDialog, ParameterConstraints, type RendererConfig, TransactionExecuteButton, TransactionForm, TransactionSuccessLog, type UseAliasEditStateReturn, WalletConnectionWithSettings, buildTransactionSuccessPayload, createAddressTransform, createArrayObjectTransform, createArrayTransform, createBigIntTransform, createBooleanTransform, createComplexTypeTransform, createDefaultFormValues, createNumberTransform, createObjectTransform, createTextTransform, createTransformForFieldType, generateDefaultValue, getDefaultValueByFieldType, invokeOnTransactionSuccess, normalizeTransactionSuccessHash, rendererConfig, useAliasEditState, validateField };
|
|
423
443
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types/RendererConfig.ts","../src/config.ts","../src/components/TransactionForm.tsx","../src/utils/formUtils.ts","../src/components/DynamicFormField.tsx","../src/components/transaction/TransactionExecuteButton.tsx","../src/components/AddressBookWidget/AddressBookWidget.tsx","../src/components/AddressBookWidget/AliasEditPopover.tsx","../src/components/AddressBookWidget/useAliasEditState.ts","../src/components/ContractStateWidget/ContractStateWidget.tsx","../src/components/ContractActionBar/ContractActionBar.tsx","../src/components/ExecutionConfigDisplay/ExecutionConfigDisplay.tsx","../src/components/network/NetworkSettingsDialog.tsx","../src/components/WalletConnectionWithSettings.tsx"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;;AASA;AAIoB,UAJH,cAAA,CAIG;EAWO;;;EANA,gBAAA,EALP,MAKO,CAAA,MAAA,EAAA,MAAA,CAAA;;;;ECJd,iBA4EZ,EDxEoB,MCwEpB,CAAA,MA5E4B,EAAA;;;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types/RendererConfig.ts","../src/config.ts","../src/components/TransactionForm.tsx","../src/utils/formUtils.ts","../src/utils/transactionSuccessCallback.ts","../src/components/DynamicFormField.tsx","../src/components/transaction/TransactionExecuteButton.tsx","../src/components/AddressBookWidget/AddressBookWidget.tsx","../src/components/AddressBookWidget/AliasEditPopover.tsx","../src/components/AddressBookWidget/useAliasEditState.ts","../src/components/ContractStateWidget/ContractStateWidget.tsx","../src/components/ContractActionBar/ContractActionBar.tsx","../src/components/ExecutionConfigDisplay/ExecutionConfigDisplay.tsx","../src/components/network/NetworkSettingsDialog.tsx","../src/components/WalletConnectionWithSettings.tsx"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;;AASA;AAIoB,UAJH,cAAA,CAIG;EAWO;;;EANA,gBAAA,EALP,MAKO,CAAA,MAAA,EAAA,MAAA,CAAA;;;;ECJd,iBA4EZ,EDxEoB,MCwEpB,CAAA,MA5E4B,EAAA;;;;ICiCb,mBAAe,EFvBJ,MEuBI,CAAA,MAAA,EAAA,MAAA,CAAA;IAC7B;;;IAGA,eAAA,CAAA,EFtBsB,MEsBtB,CAAA,MAAA,EAAA,MAAA,CAAA;EACA,CAAA,CAAA;;;;;;;;cDtCW,gBAAgB;;;;;;;;;ADL7B;;;;;;;;;ACKA;;;iBCiCgB,eAAA;;;;;;;GAOb,uBAAuB,KAAA,CAAM;;;;;;AFpCX,UGLJ,oBAAA,CHKI;EAAM,QAAA,CAAA,EAAA,OAAA;;;;ECJd,SAAA,CAAA,EAAA,MA4EZ;;;;AC3CD;;AAEE,iBCxBc,aAAA,CDwBd,KAAA,EAAA,OAAA,EAAA,UAKC,CALD,EAAA;EACA,QAAA,CAAA,EAAA,OAAA;EACA,GAAA,CAAA,EAAA,MAAA;EACA,GAAA,CAAA,EAAA,MAAA;EACA,OAAA,CAAA,EAAA,MAAA;CACC,CAAA,EAAA,MAAA,GAAA,IAAA;;;;;;ACzCH;AAYgB,iBAiCA,sBAAA,CAjCa,UAAA,EAiCsB,oBAjCtB,CAAA,EAiC6C,eAjC7C,CAAA,MAAA,CAAA;AAiC7B;AAqBA;AAkBA;AAuBA;AAuBA;AA6BgB,iBA7FA,qBAAA,CAAA,CA6FuB,EA7FE,eA6Fa,CAAA,MAAA,CAAA;AAuBtD;;;;;AA+CgB,iBAjJA,qBAAA,CAAA,CAmJO,EAnJkB,eAmJ1B,CAAA,MAAO,CAAA;AAqBtB;AAmBA;;;;AAGa,iBAvKG,sBAAA,CAAA,CAuKH,EAvK6B,eAuK7B,CAAA,OAAA,CAAA;AAsBb;AAwCA;AAiDA;;;iBA/PgB,0BAAA,CAAA,GAA8B;ACzI9C;AAaA;;;;AAMI,iBDmJY,mBAAA,CAAA,CCnJZ,EDmJmC,eCnJnC,CAAA,MAAA,CAAA;;AAWJ;AAQA;;;;;AAG4B,iBDoJZ,2BAAA,CCpJY,SAAA,EDqJf,SCrJe,EAAA,UAAA,CAAA,EDsJb,oBCtJa,CAAA,EDuJzB,eCvJyB,CAAA,OAAA,CAAA;;;;AC5BlB,iBF+NM,oBAAA,CE/NgB,aAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EFiOjB,OEjOiB,CFiOT,oBEjOS,CAAA,CAAA,EAAA,OAAA;;;;AAAQ,iBFsPxB,0BAAA,CEtPwB,SAAA,EFsPc,SEtPd,CAAA,EAAA,MAAA,GAAA,OAAA,GAAA,MAAA;;AAiFxC;;;;;;;AAM2B,iBFkLX,uBAAA,CElLiB,MAAA,EFmLvB,aEnLuB,EAAA,GAAA,SAAA,EAAA,gBAAA,CAAA,EFoLb,MEpLa,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EFqL9B,UErL8B;;;;;ACvGjC;AA2CgB,iBHuQA,oBAAA,CAAA,CGvQwB,EHuQA,eGvQA,CAAA,OAAA,EAAA,CAAA;;;;;;AAMtC,iBHySc,qBAAA,CAAA,CGzSd,EHySuC,eGzSvC,CHySuD,MGzSvD,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;;;;;;iBH0Vc,0BAAA,CAAA,GAA8B,gBAAgB;;;;;;;iBCxY9C,+BAAA;;AJGhB;;AAe2B,iBILX,8BAAA,CJKW,OAAA,EAAA;EAKH,SAAA,EITX,yBJSW,CAAA,YAAA,CAAA;EAXH,SAAA,EIGR,SJHQ;EAAM,eAAA,EIIR,eJJQ,CAAA,QAAA,CAAA;;;IIOvB;AHXJ;KGsBY,qBAAA;;;AFWZ;;;;AAIE,iBEPc,0BAAA,CFOd,QAAA,EAAA,CAAA,CAAA,OAAA,EENqB,yBFMrB,EAAA,GAAA,IAAA,GEN0D,OFM1D,CAAA,IAAA,CAAA,CAAA,GAAA,SAAA,EAAA,OAAA,EELS,yBFKT,EAAA,GAAA,EEJK,qBFIL,CAAA,EAAA,IAAA;;;;;;AF1CF,UKUU,qBAAA,SAA8B,uBLVT,CAAA;EAIX;;;EAKC,KAAA,EKKZ,aLLY;EAAM;;;WKUhB,QAAQ;EJdN;;;;ACiCb;;;;;;;;;;;;;AClCA;AAYA;AAiCgB,iBE0CA,gBAAA,CF1CmC;EAAA,KAAA;EAAA,OAAA;EAAA,UAAuB;EAAA,WAAe;EAAA;AAAA,CAAA,EEgDtF,qBFhDsF,CAAA,EEgD9D,OAAA,CAAM,YFhDwD,GAAA,IAAA;;;UGvDxE,6BAAA;;;;;ENMA;;;EAoBO,YAAA,EAAA,OAAA;EAXH;;;;;ACJrB;;YKQY;;AJyBZ;;;EAGE,eAAA,CAAA,EItBkB,gBJsBlB;EACA;;;;EAGwB,iBAAM,CAAA,EAAA,OAAA;;;;;ACzChC;AAYA;AAiCA;AAqBA;AAkBA;AAuBA;AAuBgB,iBGjGA,wBAAA,CHiG8B;EAAA,iBAAe;EAAA,YAAA;EAAA,WAAA;EAAA,OAAA;EAAA,eAAA;EAAA;AAAA,CAAA,EG1F1D,6BH0F0D,CAAA,EG1F1B,KAAA,CAAM,YH0FoB;;;;iBIzH7C,iBAAA;;;;;;;;;;;;;;;;;;;;GAoBb,yBAAsB,kBAAA,CAAA,GAAA,CAAA;;;UC7BR,qBAAA;;;;UAKA,qBAAA;;;ERTA,UAAA,EQYH,ORZiB;EAIX,OAAA,EAAA,GAAA,GAAA,IAAA;EAWO;EAKH,QAAA,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,SAAA,CAAA,EAAA,MAAA,EAAA,GQL6B,ORK7B,CQLqC,qBRKrC,GAAA,SAAA,CAAA;EAXH;EAAM,MAAA,EAAA,CAAA,KAAA,EAAA;;;;ECJd,CAAA,EAAA,GOYgE,OPZhE,CAAA,MA4EZ,CAAA;;4BO9D2B;;ANmB5B;AACE,iBMhBc,gBAAA,CNgBd;EAAA,OAAA;EAAA,SAAA;EAAA,UAAA;EAAA,OAAA;EAAA,QAAA;EAAA,MAAA;EAAA;AAAA,CAAA,EMRC,qBNQD,CAAA,EMRsB,kBAAA,CAAA,GAAA,CAAA,ONQtB;;;UOrCQ,YAAA;;;cAGI;;;UAIG,uBAAA;ETTA;EAIG,OAAA,ESOT,YTPS,GAAA,IAAA;EAWO;EAKH,WAAA,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,SAAA,CAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EAXH;EAAM,WAAA,EAAA,GAAA,GAAA,IAAA;;gBSQX,KAAA,CAAM;;IRZT,CAAA,EAAA,MAAA;;;;ACiCG,iBOjBA,iBAAA,CPiBe,gBAAA,CAAA,EAAA,MAAA,CAAA,EOjB+B,uBPiB/B;;;UQlCrB,wBAAA,SAAiC;kBACzB;;;;EVLD,SAAA,CAAA,EAAA,MAAc;EAIX,KAAA,CAAA,EUMV,KVNU,GAAA,IAAA;;;;;;iBUaJ,mBAAA;;;;;;;;;GASb,2BAA2B,GAAA,CAAI;;;UC9BxB,sBAAA;iBACO;;;;EXGA,QAAA,CAAA,EWCJ,OAAA,CAAM,SXDY;EAIX,SAAA,CAAA,EAAA,MAAA;;;;;;;iBWMJ,iBAAA;;;;;;;GAOb,yBAAyB,OAAA,CAAM;;;UCGxB,2BAAA,SAAoC;mBAC3B;;;;AZrBnB;AAIoB,cY2BP,sBZ3BO,EY2BiB,OAAA,CAAM,EZ3BvB,CY2B0B,2BZ3B1B,CAAA;;;UaKV,KAAA;;;;;IbTO,IAAA,EAAA,MAAA;EAIG,CAAA,GAAA,IAAA;EAWO,OAAA,EaFhB,iBbEgB,GAAA,IAAA;EAKH,iBAAA,CAAA,EAAA,GAAA,GAAA,IAAA;;AAXG,caQd,qBbRc,EaQS,OAAA,CAAM,EbRf,CaQkB,KbRlB,CAAA;;;;;;;ccJd,8BAA8B,OAAA,CAAM"}
|