-
Notifications
You must be signed in to change notification settings - Fork 173
/
common.ts
151 lines (130 loc) · 5.54 KB
/
common.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
import { getRetryProvider } from "@uma/common";
import { ERC20Ethers } from "@uma/contracts-node";
import { delay } from "@uma/financial-templates-lib";
import { utils } from "ethers";
import { getContractInstanceWithProvider } from "../utils/contracts";
import { OptimisticGovernorEthers } from "./common";
import type { Provider } from "@ethersproject/abstract-provider";
export { OptimisticGovernorEthers } from "@uma/contracts-node";
export { Logger } from "@uma/financial-templates-lib";
export { getContractInstanceWithProvider } from "../utils/contracts";
export interface BotModes {
transactionsProposedEnabled: boolean;
transactionsExecutedEnabled: boolean;
proposalExecutedEnabled: boolean;
proposalDeletedEnabled: boolean;
setCollateralAndBondEnabled: boolean;
setRulesEnabled: boolean;
setLivenessEnabled: boolean;
setIdentifierEnabled: boolean;
setEscalationManagerEnabled: boolean;
}
export interface BlockRange {
start: number;
end: number;
}
export interface MonitoringParams {
ogAddress: string;
provider: Provider;
chainId: number;
blockRange: BlockRange;
pollingDelay: number;
botModes: BotModes;
}
export const initMonitoringParams = async (env: NodeJS.ProcessEnv): Promise<MonitoringParams> => {
if (!env.OG_ADDRESS) throw new Error("OG_ADDRESS must be defined in env");
const ogAddress = String(env.OG_ADDRESS);
if (!env.CHAIN_ID) throw new Error("CHAIN_ID must be defined in env");
const chainId = Number(env.CHAIN_ID);
const STARTING_BLOCK_KEY = `STARTING_BLOCK_NUMBER_${chainId}`;
const ENDING_BLOCK_KEY = `ENDING_BLOCK_NUMBER_${chainId}`;
// Creating provider will check for other chainId specific env variables.
const provider = getRetryProvider(chainId) as Provider;
// Default to 1 minute polling delay.
const pollingDelay = env.POLLING_DELAY ? Number(env.POLLING_DELAY) : 60;
if (pollingDelay === 0 && (!env[STARTING_BLOCK_KEY] || !env[ENDING_BLOCK_KEY])) {
throw new Error(`Must provide ${STARTING_BLOCK_KEY} and ${ENDING_BLOCK_KEY} if running serverless`);
}
// If no block numbers are provided, default to the latest block.
const latestBlockNumber: number = await provider.getBlockNumber();
const startingBlock = env[STARTING_BLOCK_KEY] ? Number(env[STARTING_BLOCK_KEY]) : latestBlockNumber;
const endingBlock = env[ENDING_BLOCK_KEY] ? Number(env[ENDING_BLOCK_KEY]) : latestBlockNumber;
// In serverless it is possible for start block to be larger than end block if no new blocks were mined since last run.
if (startingBlock > endingBlock && pollingDelay !== 0) {
throw new Error(`${STARTING_BLOCK_KEY} must be less than or equal to ${ENDING_BLOCK_KEY}`);
}
const botModes = {
transactionsProposedEnabled: env.TRANSACTIONS_PROPOSED_ENABLED === "true",
transactionsExecutedEnabled: env.TRANSACTIONS_EXECUTED_ENABLED === "true",
proposalExecutedEnabled: env.PROPOSAL_EXECUTED_ENABLED === "true",
proposalDeletedEnabled: env.PROPOSAL_DELETED_ENABLED === "true",
setCollateralAndBondEnabled: env.SET_COLLATERAL_BOND_ENABLED === "true",
setRulesEnabled: env.SET_RULES_ENABLED === "true",
setLivenessEnabled: env.SET_LIVENESS_ENABLED === "true",
setIdentifierEnabled: env.SET_IDENTIFIER_ENABLED === "true",
setEscalationManagerEnabled: env.SET_ESCALATION_MANAGER_ENABLED === "true",
};
return {
ogAddress,
provider,
chainId,
blockRange: { start: startingBlock, end: endingBlock },
pollingDelay,
botModes,
};
};
export const waitNextBlockRange = async (params: MonitoringParams): Promise<BlockRange> => {
await delay(Number(params.pollingDelay));
const latestBlockNumber: number = await params.provider.getBlockNumber();
return { start: params.blockRange.end + 1, end: latestBlockNumber };
};
export const startupLogLevel = (params: MonitoringParams): "debug" | "info" => {
return params.pollingDelay === 0 ? "debug" : "info";
};
export const tryHexToUtf8String = (ancillaryData: string): string => {
try {
return utils.toUtf8String(ancillaryData);
} catch (err) {
return ancillaryData;
}
};
export const getCurrencyDecimals = async (provider: Provider, currencyAddress: string): Promise<number> => {
const currencyContract = await getContractInstanceWithProvider<ERC20Ethers>("ERC20", provider, currencyAddress);
try {
return await currencyContract.decimals();
} catch (err) {
return 18;
}
};
export const getCurrencySymbol = async (provider: Provider, currencyAddress: string): Promise<string> => {
const currencyContract = await getContractInstanceWithProvider<ERC20Ethers>("ERC20", provider, currencyAddress);
try {
return await currencyContract.symbol();
} catch (err) {
// Try to get the symbol as bytes32 (e.g. MKR uses this).
try {
const bytes32SymbolIface = new utils.Interface(["function symbol() view returns (bytes32 symbol)"]);
const bytes32Symbol = await provider.call({
to: currencyAddress,
data: bytes32SymbolIface.encodeFunctionData("symbol"),
});
return utils.parseBytes32String(bytes32SymbolIface.decodeFunctionResult("symbol", bytes32Symbol).symbol);
} catch (err) {
return "";
}
}
};
export const runQueryFilter = async (
contract: OptimisticGovernorEthers,
filter: any,
blockRange: BlockRange
): Promise<any> => {
return contract.queryFilter(filter, blockRange.start, blockRange.end);
};
export const getOg = async (params: MonitoringParams): Promise<OptimisticGovernorEthers> => {
return await getContractInstanceWithProvider<OptimisticGovernorEthers>(
"OptimisticGovernor",
params.provider,
params.ogAddress
);
};