Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update config types to match the new bot config #154

Merged
merged 9 commits into from
Feb 17, 2024
Merged

fix: update config types to match the new bot config #154

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bbf9660
feat: type pulled from gitmodule bot repository
gentlementlegen Feb 12, 2024
344c81d
chore: renamed conf keys to match the new bot conf
gentlementlegen Feb 13, 2024
b556272
chore: set private key to empty string to init conf
gentlementlegen Feb 13, 2024
baf6f8d
chore: removed default conf fetch as it is already imported in the su…
gentlementlegen Feb 15, 2024
ef0b7b3
chore: changed privateKeyEncrypted to be undefined by default
gentlementlegen Feb 15, 2024
24618d6
chore: added back safe-address
gentlementlegen Feb 15, 2024
3819fb9
chore: removed unused constants
gentlementlegen Feb 15, 2024
41006a2
chore: removed unused safe-address
gentlementlegen Feb 15, 2024
6c9239a
chore: submodule checkout
gentlementlegen Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@
[submodule "lib/permit2"]
path = lib/permit2
url = https://github.com/Uniswap/permit2
[submodule "lib/ubiquibot"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Smart way to share types!

path = lib/ubiquibot
url = https://github.com/ubiquity/ubiquibot
shallow = true
1 change: 1 addition & 0 deletions lib/ubiquibot
Open in desktop
Submodule ubiquibot added at 8afd7c
141 changes: 28 additions & 113 deletions static/scripts/onboarding/onboarding.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import _sodium from "libsodium-wrappers";
import { Octokit } from "@octokit/rest";
import { JsonRpcSigner } from "@ethersproject/providers";
import { createOrUpdateTextFile } from "@octokit/plugin-create-or-update-text-file";
import YAML from "yaml";
import { ethers } from "ethers";
import { Octokit } from "@octokit/rest";
import { PERMIT2_ADDRESS } from "@uniswap/permit2-sdk";
import { JsonRpcSigner, Network } from "@ethersproject/providers";
import { ethers } from "ethers";
import { parseUnits } from "ethers/lib/utils";
import { NetworkIds, Tokens, getNetworkName, networkNames } from "../rewards/constants";
import _sodium from "libsodium-wrappers";
import YAML from "yaml";
import { DefaultConfig } from "../../../lib/ubiquibot/src/configs/ubiquibot-config-default";
import { MergedConfig } from "../../../lib/ubiquibot/src/types";
import { erc20Abi } from "../rewards/abis/erc20Abi";
import { getNetworkName, NetworkIds, Tokens } from "../rewards/constants";

const classes = ["error", "warn", "success"];
const inputClasses = ["input-warn", "input-error", "input-success"];
Expand All @@ -22,107 +24,23 @@ const chainIdSelect = document.getElementById("chainId") as HTMLSelectElement;
const loader = document.querySelector(".loader-wrap") as HTMLElement;

const APP_ID = 236521;
const DEFAULT_ORG = "ubiquity";
const REPO_NAME = "ubiquibot-config";
const DEFAULT_REPO = "ubiquibot";
const KEY_PATH = ".github/ubiquibot-config.yml";
const DEFAULT_PATH = "ubiquibot-config-default.json";
const KEY_NAME = "private-key-encrypted";
const PRIVATE_ENCRYPTED_KEY_NAME = "privateKeyEncrypted";
const EVM_NETWORK_KEY_NAME = "evmNetworkId";
rndquu marked this conversation as resolved.
Show resolved Hide resolved
const KEY_PREFIX = "HSK_";
const X25519_KEY = "5ghIlfGjz_ChcYlBDOG7dzmgAgBPuTahpvTMBipSH00";

rndquu marked this conversation as resolved.
Show resolved Hide resolved
let encryptedValue = "";

interface ConfLabel {
name: string;
}

interface CommandLabel {
name: string;
enabled: boolean;
}

interface IIncentive {
comment: {
elements: Record<string, unknown>;
totals: {
word: number;
};
};
}

interface IControl {
label: boolean;
organization: boolean;
}

interface IConf {
"private-key-encrypted"?: string;
"safe-address"?: string;
"base-multiplier"?: number;
"auto-pay-mode"?: boolean;
"analytics-mode"?: boolean;
"max-concurrent-bounties"?: number;
"incentive-mode"?: boolean;
"evm-network-id"?: number;
"price-multiplier"?: number;
"issue-creator-multiplier"?: number;
"payment-permit-max-price"?: number;
"max-concurrent-assigns"?: number;
"assistive-pricing"?: boolean;
"disable-analytics"?: boolean;
"comment-incentives"?: boolean;
"register-wallet-with-verification"?: boolean;
"promotion-comment"?: string;
"default-labels"?: string[];
"time-labels"?: ConfLabel[];
"priority-labels"?: ConfLabel[];
"command-settings"?: CommandLabel[];
incentives?: IIncentive;
"enable-access-control"?: IControl;
}

let defaultConf: IConf = {
"private-key-encrypted": "",
"safe-address": "",
"base-multiplier": 1,
"auto-pay-mode": false,
"analytics-mode": false,
"max-concurrent-bounties": 1,
"incentive-mode": false,
"evm-network-id": 1,
"price-multiplier": 1,
"issue-creator-multiplier": 1,
"payment-permit-max-price": 1,
"max-concurrent-assigns": 1,
"assistive-pricing": false,
"disable-analytics": false,
"comment-incentives": false,
"register-wallet-with-verification": false,
"promotion-comment": "",
"default-labels": [],
"time-labels": [],
"priority-labels": [],
"command-settings": [],
incentives: {
comment: {
elements: {},
totals: {
word: 0,
},
},
},
"enable-access-control": {
label: false,
organization: true,
},
};
let defaultConf = { ...DefaultConfig, "safe-address": "" };

export const parseYAML = async (data: any): Promise<any | undefined> => {
export const parseYAML = async <T>(data: string | undefined) => {
if (!data) return undefined;
0x4007 marked this conversation as resolved.
Show resolved Hide resolved
try {
const parsedData = await YAML.parse(data);
if (parsedData !== null) {
return parsedData;
return parsedData as T;
} else {
return undefined;
}
Expand All @@ -131,24 +49,24 @@ export const parseYAML = async (data: any): Promise<any | undefined> => {
}
};

export const parseJSON = async (data: any): Promise<any | undefined> => {
export const parseJSON = async <T>(data: string) => {
try {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a wise way to set up types.

const parsedData = await JSON.parse(data);
return parsedData;
return parsedData as T;
} catch (error) {
return undefined;
}
};

export const YAMLStringify = (value: any) => YAML.stringify(value, { defaultKeyType: "PLAIN", defaultStringType: "QUOTE_DOUBLE", lineWidth: 0 });

export const getConf = async (initial: boolean = false): Promise<string | undefined> => {
export const getConf = async (): Promise<string | undefined> => {
try {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I need to update the lint settings after this is merged. I banned these arrow functions in favor of named functions (unless they are in a callback.)

const octokit = new Octokit({ auth: githubPAT.value });
const { data } = await octokit.rest.repos.getContent({
owner: initial ? DEFAULT_ORG : orgName.value,
repo: initial ? DEFAULT_REPO : REPO_NAME,
path: initial ? DEFAULT_PATH : KEY_PATH,
owner: orgName.value,
repo: REPO_NAME,
path: KEY_PATH,
mediaType: {
format: "raw",
},
Expand Down Expand Up @@ -227,8 +145,8 @@ const sodiumEncryptedSeal = async (publicKey: string, secret: string) => {
const binsec = sodium.from_string(secret);
const encBytes = sodium.crypto_box_seal(binsec, binkey);
const output = sodium.to_base64(encBytes, sodium.base64_variants.URLSAFE_NO_PADDING);
defaultConf[KEY_NAME] = output;
defaultConf["evm-network-id"] = Number(chainIdSelect.value);
defaultConf[PRIVATE_ENCRYPTED_KEY_NAME] = output;
defaultConf[EVM_NETWORK_KEY_NAME] = Number(chainIdSelect.value);
defaultConf["safe-address"] = safeAddressInput.value;
rndquu marked this conversation as resolved.
Show resolved Hide resolved
outKey.value = YAMLStringify(defaultConf);
outKey.style.height = getTextBox(outKey.value);
Expand Down Expand Up @@ -304,10 +222,10 @@ const setConfig = async () => {
const conf = await getConf();

const updatedConf = defaultConf;
const parsedConf: IConf | undefined = await parseYAML(conf);
updatedConf[KEY_NAME] = encryptedValue;
updatedConf["evm-network-id"] = Number(chainIdSelect.value);
updatedConf["safe-address"] = safeAddressInput.value;
const parsedConf = await parseYAML<MergedConfig>(conf);
updatedConf[PRIVATE_ENCRYPTED_KEY_NAME] = encryptedValue;
updatedConf[EVM_NETWORK_KEY_NAME] = Number(chainIdSelect.value);
defaultConf["safe-address"] = safeAddressInput.value;

// combine configs (default + remote org wide)
const combinedConf = Object.assign(updatedConf, parsedConf);
Expand Down Expand Up @@ -552,12 +470,9 @@ const step2Handler = async () => {
};

const init = async () => {
let conf = await getConf(true);
if (conf !== undefined) {
if (defaultConf !== undefined) {
try {
rndquu marked this conversation as resolved.
Show resolved Hide resolved
conf = JSON.parse(conf);
defaultConf = conf as IConf;
defaultConf["private-key-encrypted"] = "";
defaultConf[PRIVATE_ENCRYPTED_KEY_NAME] = undefined;
setInputListeners();

setBtn.addEventListener("click", async () => {
Expand Down
Loading