-
Notifications
You must be signed in to change notification settings - Fork 3
/
contract_method_wrappers.ts
97 lines (86 loc) · 3.01 KB
/
contract_method_wrappers.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
/*
This file is part of web3.js.
web3.js is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
web3.js is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/
import { Web3PluginBase } from '@theqrl/web3-core';
import Contract from '@theqrl/web3-zond-contract';
import { Address, ContractAbi, DataFormat, DEFAULT_RETURN_FORMAT, Numbers } from '@theqrl/web3-types';
import { format, numberToHex } from '@theqrl/web3-utils';
// eslint-disable-next-line require-extensions/require-extensions
import { ERC20TokenAbi } from './ERC20Token';
// eslint-disable-next-line require-extensions/require-extensions
import { Web3Context } from './reexported_web3_context';
export class ContractMethodWrappersPlugin extends Web3PluginBase {
public pluginNamespace = 'contractMethodWrappersPlugin';
// This should be private, but it's public so _contract.requestManager.send can
// be mocked in contract_method_wrappers.test.ts
public readonly _contract: Contract<typeof ERC20TokenAbi>;
public constructor(abi: ContractAbi, address: Address) {
super();
this._contract = new Contract(abi, address);
}
/**
* This method overrides the inherited `link` method from `Web3PluginBase`
* to add to a configured `RequestManager` to our Contract instance
* when `Web3.registerPlugin` is called.
*
* @param parentContext - The context to be added to the instance of `ChainlinkPlugin`,
* and by extension, the instance of `Contract`.
*/
public link(parentContext: Web3Context) {
super.link(parentContext);
this._contract.link(parentContext);
}
public async getFormattedBalance<ReturnFormat extends DataFormat>(
address: Address,
returnFormat: ReturnFormat,
) {
return format(
{ format: 'unit' },
await this._contract.methods.balanceOf(address).call(),
returnFormat,
);
}
public async transferAndGetBalances<ReturnFormat extends DataFormat>(
sender: Address,
recipient: Address,
amount: Numbers,
returnFormat?: ReturnFormat,
) {
await this._contract.methods
.transfer(recipient, numberToHex(amount))
.send({ from: sender });
return {
sender: {
address: sender,
balance: await this.getFormattedBalance(
sender,
returnFormat ?? DEFAULT_RETURN_FORMAT,
),
},
recipient: {
address: recipient,
balance: await this.getFormattedBalance(
recipient,
returnFormat ?? DEFAULT_RETURN_FORMAT,
),
},
};
}
}
// Module Augmentation
declare module './reexported_web3_context' {
interface Web3Context {
contractMethodWrappersPlugin: ContractMethodWrappersPlugin;
}
}
export { Web3Context };