Skip to content

Commit 796d3f4

Browse files
yomarionyomarion
authored
chore: refactor payment network IDs for enforced typing (#977)
chore: enforce the typing of creation parameters with the type PaymentNetworkCreateParameters chore: deprecate the IPaymentNetworkCreateParameters interface chore: remove enum PaymentTypes.PAYMENT_NETWORK_ID chore: created enums ExtensionTypes.OTHER_ID and ExtensionTypes.PAYMENT_NETWORK_ID, ExtensionTypes.ID is defined by their union
1 parent abc53c7 commit 796d3f4

File tree

153 files changed

+1368
-1325
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

153 files changed

+1368
-1325
lines changed

‎packages/advanced-logic/src/advanced-logic.ts‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -106,30 +106,30 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
106106
const id: ExtensionTypes.ID = extensionAction.id;
107107
const extension: ExtensionTypes.IExtension | undefined = {
108108
[ExtensionTypes.ID.CONTENT_DATA]: this.extensions.contentData,
109-
[ExtensionTypes.ID.PAYMENT_NETWORK_BITCOIN_ADDRESS_BASED]: this.extensions.addressBasedBtc,
110-
[ExtensionTypes.ID.PAYMENT_NETWORK_TESTNET_BITCOIN_ADDRESS_BASED]:
109+
[ExtensionTypes.PAYMENT_NETWORK_ID.BITCOIN_ADDRESS_BASED]: this.extensions.addressBasedBtc,
110+
[ExtensionTypes.PAYMENT_NETWORK_ID.TESTNET_BITCOIN_ADDRESS_BASED]:
111111
this.extensions.addressBasedTestnetBtc,
112-
[ExtensionTypes.ID.PAYMENT_NETWORK_ANY_DECLARATIVE]: this.extensions.declarative,
113-
[ExtensionTypes.ID.PAYMENT_NETWORK_ERC20_ADDRESS_BASED]: this.extensions.addressBasedErc20,
114-
[ExtensionTypes.ID.PAYMENT_NETWORK_ERC20_PROXY_CONTRACT]: this.extensions.proxyContractErc20,
115-
[ExtensionTypes.ID.PAYMENT_NETWORK_ERC20_FEE_PROXY_CONTRACT]:
112+
[ExtensionTypes.PAYMENT_NETWORK_ID.ANY_DECLARATIVE]: this.extensions.declarative,
113+
[ExtensionTypes.PAYMENT_NETWORK_ID.ERC20_ADDRESS_BASED]: this.extensions.addressBasedErc20,
114+
[ExtensionTypes.PAYMENT_NETWORK_ID.ERC20_PROXY_CONTRACT]: this.extensions.proxyContractErc20,
115+
[ExtensionTypes.PAYMENT_NETWORK_ID.ERC20_FEE_PROXY_CONTRACT]:
116116
this.extensions.feeProxyContractErc20,
117-
[ExtensionTypes.ID.PAYMENT_NETWORK_ERC777_STREAM]: this.extensions.erc777Stream,
118-
[ExtensionTypes.ID.PAYMENT_NETWORK_ETH_INPUT_DATA]: this.extensions.ethereumInputData,
119-
[ExtensionTypes.ID.PAYMENT_NETWORK_NATIVE_TOKEN]:
117+
[ExtensionTypes.PAYMENT_NETWORK_ID.ERC777_STREAM]: this.extensions.erc777Stream,
118+
[ExtensionTypes.PAYMENT_NETWORK_ID.ETH_INPUT_DATA]: this.extensions.ethereumInputData,
119+
[ExtensionTypes.PAYMENT_NETWORK_ID.NATIVE_TOKEN]:
120120
this.getNativeTokenExtensionForActionAndState(extensionAction, requestState),
121-
[ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ERC20_PROXY]: this.extensions.anyToErc20Proxy,
122-
[ExtensionTypes.ID.PAYMENT_NETWORK_ETH_FEE_PROXY_CONTRACT]:
121+
[ExtensionTypes.PAYMENT_NETWORK_ID.ANY_TO_ERC20_PROXY]: this.extensions.anyToErc20Proxy,
122+
[ExtensionTypes.PAYMENT_NETWORK_ID.ETH_FEE_PROXY_CONTRACT]:
123123
this.extensions.feeProxyContractEth,
124-
[ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ETH_PROXY]: this.extensions.anyToEthProxy,
125-
[ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_NATIVE_TOKEN]:
124+
[ExtensionTypes.PAYMENT_NETWORK_ID.ANY_TO_ETH_PROXY]: this.extensions.anyToEthProxy,
125+
[ExtensionTypes.PAYMENT_NETWORK_ID.ANY_TO_NATIVE_TOKEN]:
126126
this.getAnyToNativeTokenExtensionForActionAndState(extensionAction, requestState),
127127
}[id];
128128

129129
if (!extension) {
130130
if (
131-
id === ExtensionTypes.ID.PAYMENT_NETWORK_NATIVE_TOKEN ||
132-
id === ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_NATIVE_TOKEN
131+
id === ExtensionTypes.PAYMENT_NETWORK_ID.NATIVE_TOKEN ||
132+
id === ExtensionTypes.PAYMENT_NETWORK_ID.ANY_TO_NATIVE_TOKEN
133133
) {
134134
const network =
135135
this.getNetwork(extensionAction, requestState) || requestState.currency.network;
@@ -189,7 +189,7 @@ export default class AdvancedLogic implements AdvancedLogicTypes.IAdvancedLogic
189189
const network =
190190
extensionAction.action === 'create'
191191
? extensionAction.parameters.network
192-
: requestState.extensions[ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_NATIVE_TOKEN]?.values
192+
: requestState.extensions[ExtensionTypes.PAYMENT_NETWORK_ID.ANY_TO_NATIVE_TOKEN]?.values
193193
?.network;
194194
return network;
195195
}

‎packages/advanced-logic/src/extensions/payment-network/address-based.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export default abstract class AddressBasedPaymentNetwork<
1111
TCreationParameters extends ExtensionTypes.PnAddressBased.ICreationParameters = ExtensionTypes.PnAddressBased.ICreationParameters,
1212
> extends DeclarativePaymentNetwork<TCreationParameters> {
1313
protected constructor(
14-
extensionId: ExtensionTypes.ID,
14+
extensionId: ExtensionTypes.PAYMENT_NETWORK_ID,
1515
currentVersion: string,
1616
public readonly supportedCurrencyType: RequestLogicTypes.CURRENCY,
1717
) {

‎packages/advanced-logic/src/extensions/payment-network/any-to-erc20-proxy.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ const CURRENT_VERSION = '0.1.0';
1111
export default class AnyToErc20ProxyPaymentNetwork extends Erc20FeeProxyPaymentNetwork {
1212
public constructor(
1313
private currencyManager: ICurrencyManager,
14-
extensionId: ExtensionTypes.ID = ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ERC20_PROXY,
14+
extensionId: ExtensionTypes.PAYMENT_NETWORK_ID = ExtensionTypes.PAYMENT_NETWORK_ID
15+
.ANY_TO_ERC20_PROXY,
1516
currentVersion: string = CURRENT_VERSION,
1617
) {
1718
super(extensionId, currentVersion);

‎packages/advanced-logic/src/extensions/payment-network/any-to-eth-proxy.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const CURRENT_VERSION = '0.2.0';
66

77
export default class AnyToEthProxyPaymentNetwork extends EthereumFeeProxyPaymentNetwork {
88
public constructor(private currencyManager: ICurrencyManager) {
9-
super(ExtensionTypes.ID.PAYMENT_NETWORK_ANY_TO_ETH_PROXY, CURRENT_VERSION);
9+
super(ExtensionTypes.PAYMENT_NETWORK_ID.ANY_TO_ETH_PROXY, CURRENT_VERSION);
1010
}
1111

1212
/**

‎packages/advanced-logic/src/extensions/payment-network/any-to-native.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { InvalidPaymentAddressError, UnsupportedNetworkError } from './address-b
44

55
export default abstract class AnyToNativeTokenPaymentNetwork extends FeeReferenceBasedPaymentNetwork {
66
protected constructor(
7-
extensionId: ExtensionTypes.ID,
7+
extensionId: ExtensionTypes.PAYMENT_NETWORK_ID,
88
currentVersion: string,
99
public readonly supportedNetworks: string[],
1010
) {

‎packages/advanced-logic/src/extensions/payment-network/bitcoin/mainnet-address-based.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ const BITCOIN_NETWORK = 'mainnet';
1212
*/
1313
export default class BitcoinAddressBasedPaymentNetwork extends AddressBasedPaymentNetwork {
1414
public constructor(
15-
extensionId: ExtensionTypes.ID = ExtensionTypes.ID.PAYMENT_NETWORK_BITCOIN_ADDRESS_BASED,
15+
extensionId: ExtensionTypes.PAYMENT_NETWORK_ID = ExtensionTypes.PAYMENT_NETWORK_ID
16+
.BITCOIN_ADDRESS_BASED,
1617
) {
1718
super(extensionId, CURRENT_VERSION, RequestLogicTypes.CURRENCY.BTC);
1819
}

‎packages/advanced-logic/src/extensions/payment-network/bitcoin/testnet-address-based.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const BITCOIN_NETWORK = 'testnet';
1212
*/
1313
export default class BitcoinTestnetAddressBasedPaymentNetwork extends BitcoinAddressBasedPaymentNetwork {
1414
public constructor() {
15-
super(ExtensionTypes.ID.PAYMENT_NETWORK_TESTNET_BITCOIN_ADDRESS_BASED);
15+
super(ExtensionTypes.PAYMENT_NETWORK_ID.TESTNET_BITCOIN_ADDRESS_BASED);
1616
}
1717

1818
protected isValidAddress(address: string): boolean {

‎packages/advanced-logic/src/extensions/payment-network/declarative.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ export default class DeclarativePaymentNetwork<
1111
TCreationParameters extends ExtensionTypes.PnAnyDeclarative.ICreationParameters = ExtensionTypes.PnAnyDeclarative.ICreationParameters,
1212
> extends AbstractExtension<TCreationParameters> {
1313
public constructor(
14-
public readonly extensionId: ExtensionTypes.ID = ExtensionTypes.ID
15-
.PAYMENT_NETWORK_ANY_DECLARATIVE,
14+
public readonly extensionId: ExtensionTypes.PAYMENT_NETWORK_ID = ExtensionTypes
15+
.PAYMENT_NETWORK_ID.ANY_DECLARATIVE,
1616
public readonly currentVersion: string = CURRENT_VERSION,
1717
) {
1818
super(ExtensionTypes.TYPE.PAYMENT_NETWORK, extensionId, currentVersion);

‎packages/advanced-logic/src/extensions/payment-network/erc20/address-based.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const CURRENT_VERSION = '0.1.0';
1212
export default class Erc20AddressBasedPaymentNetwork extends AddressBasedPaymentNetwork {
1313
public constructor() {
1414
super(
15-
ExtensionTypes.ID.PAYMENT_NETWORK_ERC20_ADDRESS_BASED,
15+
ExtensionTypes.PAYMENT_NETWORK_ID.ERC20_ADDRESS_BASED,
1616
CURRENT_VERSION,
1717
RequestLogicTypes.CURRENCY.ERC20,
1818
);

‎packages/advanced-logic/src/extensions/payment-network/erc20/fee-proxy-contract.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ export default class Erc20FeeProxyPaymentNetwork<
1010
TCreationParameters extends ExtensionTypes.PnFeeReferenceBased.ICreationParameters = ExtensionTypes.PnFeeReferenceBased.ICreationParameters,
1111
> extends FeeReferenceBasedPaymentNetwork<TCreationParameters> {
1212
public constructor(
13-
extensionId: ExtensionTypes.ID = ExtensionTypes.ID.PAYMENT_NETWORK_ERC20_FEE_PROXY_CONTRACT,
13+
extensionId: ExtensionTypes.PAYMENT_NETWORK_ID = ExtensionTypes.PAYMENT_NETWORK_ID
14+
.ERC20_FEE_PROXY_CONTRACT,
1415
currentVersion: string = CURRENT_VERSION,
1516
) {
1617
super(extensionId, currentVersion, RequestLogicTypes.CURRENCY.ERC20);

0 commit comments

Comments
 (0)