-
Notifications
You must be signed in to change notification settings - Fork 114
/
tatum.ts
206 lines (170 loc) Β· 6.77 KB
/
tatum.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
import { Container, Service } from 'typedi'
import { Network, isLoadBalancerNetwork } from '../../dto'
import { CONFIG, Constant, EnvUtils, LOGGER, LoggerUtils, Utils } from '../../util'
import {
ExtensionConstructor,
ExtensionConstructorOrConfig,
ITatumSdkContainer,
TatumSdkContainer,
TatumSdkExtension,
} from '../extensions'
import { LoadBalancer, TronLoadBalancer } from '../rpc/generic/LoadBalancer'
import { MetaMask, WalletProvider } from '../walletProvider'
import { ApiVersion, TatumConfig } from './tatum.dto'
/**
* Works as an entrypoint to interact with extension of choice.
* @param type - Extension type imported to the SDK instance
*/
export interface ITatumSdkChain {
extension<T extends TatumSdkExtension>(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type: new (tatumSdkContainer: ITatumSdkContainer, ...args: any[]) => T,
): T
}
export abstract class TatumSdkChain implements ITatumSdkChain {
walletProvider: WalletProvider
protected constructor(readonly id: string) {
this.walletProvider = Container.of(id).get(WalletProvider)
}
extension<T extends TatumSdkExtension>(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type: new (tatumSdkContainer: ITatumSdkContainer, ...args: any[]) => T,
): T {
return Container.of(this.id).get(type)
}
async destroy(): Promise<void> {
const config = Container.of(this.id).get(CONFIG)
for (const extensionConfig of config?.configureExtensions ?? []) {
await this.destroyExtension(extensionConfig, this.id)
}
for (const walletProviderConfig of config?.configureWalletProviders ?? []) {
await this.destroyExtension(walletProviderConfig, this.id)
}
// calls destroy on load balancer
Container.of(this.id).remove(config.network === Network.TRON ? TronLoadBalancer : LoadBalancer)
}
private async destroyExtension(extensionConfig: ExtensionConstructorOrConfig, id: string) {
let type: new (container: ITatumSdkContainer, ...args: unknown[]) => TatumSdkExtension
if ('type' in extensionConfig) {
type = extensionConfig.type
} else {
type = extensionConfig
}
await Container.of(id).get(type)?.destroy()
}
}
@Service({ transient: true })
export class TatumSDK {
/**
* Initialize Tatum SDK. This method must be called before any other method.
* Default configuration is used if no configuration is provided.
* @param config
*/
public static async init<T extends ITatumSdkChain>(config: TatumConfig): Promise<T> {
const defaultConfig: Partial<TatumConfig> = {
version: ApiVersion.V4,
retryCount: 1,
retryDelay: 1000,
rpc: {
oneTimeLoadBalancing: false,
allowedBlocksBehind: Constant.OPEN_RPC.ALLOWED_BLOCKS_BEHIND,
},
}
const mergedConfig = Utils.deepMerge(defaultConfig, config) as TatumConfig
if (mergedConfig.rpc && this.shouldEvictNodesOnFailure(mergedConfig)) {
mergedConfig.rpc.evictNodesOnFailure = true
}
LoggerUtils.setLoggerForEnv(mergedConfig, EnvUtils.isDevelopment(), EnvUtils.isBrowser())
// TODO: check when rpc is customized if there is allowedBlocksBehind if not throw error or set default
// TODO: Check if rpc works for other chains and all configurations are set correctly
const id = TatumSDK.generateRandomString()
Container.of(id).set(CONFIG, mergedConfig)
Container.of(id).set(LOGGER, mergedConfig.logger)
if (
!mergedConfig.apiKey ||
(typeof mergedConfig.apiKey !== 'string' && !mergedConfig.apiKey.v3 && !mergedConfig.apiKey.v4)
) {
mergedConfig.logger?.warn(
'API key not provided - only a subset of SDK features will be enabled. Generate an API Key by accessing your Dashboard: https://co.tatum.io/signup',
)
}
if (isLoadBalancerNetwork(mergedConfig.network)) {
const loadBalancer = Container.of(id).get(
mergedConfig.network === Network.TRON ? TronLoadBalancer : LoadBalancer,
)
await loadBalancer.init()
}
const containerInstance = new TatumSdkContainer(Container.of(id))
await this.configureExtensions(config, id, containerInstance)
await this.addBuiltInExtensions(id, containerInstance)
return Utils.getClient<T>(id, mergedConfig.network)
}
private static builtInExtensions: ExtensionConstructor[] = [MetaMask]
private static async addBuiltInExtensions(id: string, containerInstance: TatumSdkContainer) {
for (const extension of this.builtInExtensions) {
const instance = new extension(containerInstance)
if (instance.supportedNetworks.includes(Container.of(id).get(CONFIG).network)) {
await instance.init()
Container.of(id).set(extension, instance)
}
}
}
private static async configureExtensions(
config: TatumConfig,
id: string,
containerInstance: TatumSdkContainer,
) {
for (const extensionConfig of config?.configureExtensions ?? []) {
await this.addExtension(extensionConfig, id, containerInstance)
}
for (const walletProviderConfig of config?.configureWalletProviders ?? []) {
await this.addExtension(walletProviderConfig, id, containerInstance)
}
}
private static async addExtension(
extensionConfig: ExtensionConstructorOrConfig,
id: string,
containerInstance: TatumSdkContainer,
) {
let type: new (container: ITatumSdkContainer, ...args: unknown[]) => TatumSdkExtension
const args: unknown[] = []
if ('type' in extensionConfig) {
type = extensionConfig.type
args.push(extensionConfig.config)
} else {
type = extensionConfig
}
const instance = new type(containerInstance, ...args)
this.checkIfNetworkSupportedInExtension(instance, id, type)
await instance.init()
Container.of(id).set(type, instance)
}
private static checkIfNetworkSupportedInExtension(
instance: TatumSdkExtension,
id: string,
type: { new (container: ITatumSdkContainer, ...args: unknown[]): TatumSdkExtension },
) {
if (!instance.supportedNetworks.includes(Container.of(id).get(CONFIG).network)) {
throw new Error(
`Extension ${type.name} is not supported on ${Container.of(id).get(CONFIG).network} network.`,
)
}
}
private static generateRandomString() {
const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
let result = ''
for (let i = 0; i < 60; i++) {
result += characters.charAt(Math.floor(Math.random() * characters.length))
}
return result
}
private static shouldEvictNodesOnFailure(config: TatumConfig): boolean | undefined {
if (config.rpc?.evictNodesOnFailure !== undefined && config.rpc?.oneTimeLoadBalancing !== null) {
return config.rpc.evictNodesOnFailure
}
if (!config.rpc?.nodes) {
return false
}
return !config.rpc?.oneTimeLoadBalancing
}
}