Add alias for chain (#31)

helix-bridge · Oct 10, 2024 · 837e08a · 837e08a
1 parent e54bcf6
commit 837e08a
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 3 deletions.
diff --git a/conf/mainnets/crab.yml b/conf/mainnets/crab.yml
@@ -1,5 +1,7 @@
 id: '44'
 code: crab-dvm
+alias:
+ - crab
 name: Crab
 rpcs:
  - https://crab-rpc.dcdao.box

diff --git a/conf/mainnets/darwinia.yml b/conf/mainnets/darwinia.yml
@@ -1,5 +1,7 @@
 id: '46'
 code: darwinia-dvm
+alias:
+ - darwinia
 name: Darwinia
 rpcs:
  - https://rpc.darwinia.network

diff --git a/package-lock.json b/package-lock.json
diff --git a/scripts/generate/stdconf.mjs b/scripts/generate/stdconf.mjs
@@ -2,6 +2,7 @@ import * as helper from './_helper.mjs'
 
 export function standardization(global, ccf) {
  _stdGeneric(global, ccf);
+ _stdAlias(global, ccf);
  _stdRpcs(global, ccf);
  _stdMessagers(global, ccf);
  _stdIndexers(global, ccf);
@@ -17,6 +18,18 @@ function _stdGeneric(global, ccf) {
  if (!ccf.rpcs) ccf.rpcs = [];
  if (!ccf.protocol) ccf.protocol = {};
  if (!ccf.indexers) ccf.indexers = [];
+ if (!ccf.alias) ccf.alias = [];
+}
+
+function _stdAlias(global, ccf) {
+ if (!ccf.alias.length) {
+ ccf.alias.push(ccf.code);
+ return;
+ }
+ if (ccf.alias.find(item => item.toUpperCase() === ccf.code.toUpperCase())) {
+ return ccf.alias;
+ }
+ ccf.alias.push(ccf.code);
 }
 
 function _stdMessagers(global, ccf) {

diff --git a/template/ts/files/package.json b/template/ts/files/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@helixbridge/helixconf",
- "version": "1.1.15",
+ "version": "1.1.16",
  "description": "Helix conf",
  "main": "dist/src/index.js",
  "publishConfig": {

diff --git a/template/ts/files/src/helixconf.ts b/template/ts/files/src/helixconf.ts
@@ -94,6 +94,7 @@ export interface HelixChainConfType {
  id: bigint
  lzid?: bigint
  code: string
+ alias: string[]
  name: string
  rpcs: ChainRpc[]
  protocol: Record<HelixProtocolName, string>
@@ -213,6 +214,10 @@ export class HelixChainConf {
  return this._data.code;
  }
 
+ get alias(): string[] {
+ return this._data.alias;
+ }
+
  get name(): string {
  return this._data.name;
  }
@@ -430,6 +435,7 @@ export class HelixChainConf {
  contract: this.contract,
  additional: this.additional,
  code: this.code,
+ alias: this.alias,
  name: this.name,
  rpcs: this.rpcs,
  indexers: this.indexers,
@@ -449,6 +455,7 @@ export class HelixChainConf {
  contract: json.contract,
  additional: json.additional,
  code: json.code,
+ alias: json.alias,
  name: json.name,
  rpcs: ChainRpc.fromOptions(json.rpcs),
  indexers: json.indexers,

diff --git a/template/ts/templates/helpers.ts.mustache b/template/ts/templates/helpers.ts.mustache
@@ -30,9 +30,13 @@ export class HelixChain {
 
  static get(chain: string | number | bigint): HelixChainConf | undefined {
  const upperCaseChainName = chain.toString().toUpperCase();
- return HelixChain.chains().find(
+ const pickedChain = HelixChain.chains().find(
  item => item.code.toUpperCase() === upperCaseChainName || item.id.toString() === upperCaseChainName
  );
+ if (pickedChain) return pickedChain;
+ return HelixChain.chains().find(
+ item => item.alias.find(alias => alias.toUpperCase() === upperCaseChainName)
+ );
  }
 }