Summary
Deprecate the following URL string arguments from wallet creation config in favour of explicit provider instances. These were the original API; the provider pattern (arkProvider, indexerProvider, etc.) is now preferred as it supports custom transports (Expo, gRPC, service workers, etc.) and removes ambiguous override precedence.
Arguments to deprecate:
arkServerUrl
indexerUrl
esploraUrl
delegatorUrl (ServiceWorker wallet only)
Code that relies on these arguments
arkServerUrl
src/wallet/index.ts:43 — defined in BaseWalletConfig
src/wallet/serviceWorker/wallet.ts:332 — defined in ServiceWorkerWalletOptions
src/wallet/serviceWorker/wallet.ts:454 — stored as protected property
src/wallet/wallet.ts:200-210 — extracted, validated, used to construct RestArkProvider
src/wallet/wallet.ts:218 — defaults indexerUrl when not set
src/worker/messageBus.ts:373 — forwarded to message bus init
indexerUrl
src/wallet/index.ts:45 — defined in BaseWalletConfig
src/wallet/serviceWorker/wallet.ts:334 — defined in ServiceWorkerWalletOptions
src/wallet/serviceWorker/wallet.ts:457 — stored as protected property
src/wallet/wallet.ts:217-220 — defaults to arkServerUrl; used to construct RestIndexerProvider
src/worker/messageBus.ts:375, 390 — forwarded through message bus config
esploraUrl
src/wallet/index.ts:47 — defined in BaseWalletConfig
src/wallet/serviceWorker/wallet.ts:336 — defined in ServiceWorkerWalletOptions
src/wallet/serviceWorker/wallet.ts:458 — stored as protected property
src/wallet/wallet.ts:250-255 — defaults to network-specific ESPLORA_URL; used to construct EsploraProvider
src/worker/messageBus.ts:376, 391 — forwarded through message bus config
delegatorUrl (ServiceWorker only)
src/wallet/serviceWorker/wallet.ts:345 — defined in ServiceWorkerWalletOptions
src/wallet/serviceWorker/wallet.ts:456 — stored as protected property
src/wallet/serviceWorker/wallet.ts:536, 554, 865, 1393, 1378, 1411 — conditional check, stored, and forwarded
src/worker/messageBus.ts:363-364 — used to instantiate RestDelegatorProvider
Proposed approach
- Mark each property
@deprecated in its interface/type (TypeDoc annotations to be handled separately).
- Keep runtime behaviour unchanged — URL args still construct the relevant provider internally — so existing integrations don't break.
- In a future major version, remove the properties entirely.
Out of scope
TypeDoc annotation updates — handled separately by @gringokiwi.
Summary
Deprecate the following URL string arguments from wallet creation config in favour of explicit provider instances. These were the original API; the provider pattern (
arkProvider,indexerProvider, etc.) is now preferred as it supports custom transports (Expo, gRPC, service workers, etc.) and removes ambiguous override precedence.Arguments to deprecate:
arkServerUrlindexerUrlesploraUrldelegatorUrl(ServiceWorker wallet only)Code that relies on these arguments
arkServerUrlsrc/wallet/index.ts:43— defined inBaseWalletConfigsrc/wallet/serviceWorker/wallet.ts:332— defined inServiceWorkerWalletOptionssrc/wallet/serviceWorker/wallet.ts:454— stored as protected propertysrc/wallet/wallet.ts:200-210— extracted, validated, used to constructRestArkProvidersrc/wallet/wallet.ts:218— defaultsindexerUrlwhen not setsrc/worker/messageBus.ts:373— forwarded to message bus initindexerUrlsrc/wallet/index.ts:45— defined inBaseWalletConfigsrc/wallet/serviceWorker/wallet.ts:334— defined inServiceWorkerWalletOptionssrc/wallet/serviceWorker/wallet.ts:457— stored as protected propertysrc/wallet/wallet.ts:217-220— defaults toarkServerUrl; used to constructRestIndexerProvidersrc/worker/messageBus.ts:375, 390— forwarded through message bus configesploraUrlsrc/wallet/index.ts:47— defined inBaseWalletConfigsrc/wallet/serviceWorker/wallet.ts:336— defined inServiceWorkerWalletOptionssrc/wallet/serviceWorker/wallet.ts:458— stored as protected propertysrc/wallet/wallet.ts:250-255— defaults to network-specificESPLORA_URL; used to constructEsploraProvidersrc/worker/messageBus.ts:376, 391— forwarded through message bus configdelegatorUrl(ServiceWorker only)src/wallet/serviceWorker/wallet.ts:345— defined inServiceWorkerWalletOptionssrc/wallet/serviceWorker/wallet.ts:456— stored as protected propertysrc/wallet/serviceWorker/wallet.ts:536, 554, 865, 1393, 1378, 1411— conditional check, stored, and forwardedsrc/worker/messageBus.ts:363-364— used to instantiateRestDelegatorProviderProposed approach
@deprecatedin its interface/type (TypeDoc annotations to be handled separately).Out of scope
TypeDoc annotation updates — handled separately by @gringokiwi.