refactor: restructure osx-commons-sdk (#73)

* chore: folder restructure * chore: delete examples from sdk 1.0 * fix: prettier * fix: broken dependency * fix: broken dependency * fix: update yarn.lock * fix: tests missing dependency * fix: apply code structure suggestions * fix: remove regex.ts * fix: pr comments * update: package.json version
aragon · Apr 18, 2024 · 1c745cc · 1c745cc
1 parent 871f039
commit 1c745cc
Show file tree

Hide file tree

Showing 55 changed files with 310 additions and 1,960 deletions.
diff --git a/sdk/examples/01-extended-context.ts b/sdk/examples/01-extended-context.ts
diff --git a/sdk/examples/02-extended-client.ts b/sdk/examples/02-extended-client.ts
diff --git a/sdk/package.json b/sdk/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aragon/osx-commons-sdk",
   "author": "Aragon Association",
-  "version": "0.0.1-alpha.7",
+  "version": "0.0.1-alpha.8",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/osx-commons-sdk.esm.js",
@@ -43,6 +43,7 @@
     }
   ],
   "devDependencies": {
+    "@aragon/osx-ethers": "1.3.0",
     "@size-limit/preset-small-lib": "^7.0.8",
     "@types/node": "^20.10.0",
     "dts-cli": "^2.0.3",
@@ -53,19 +54,10 @@
   },
   "dependencies": {
     "@aragon/osx-commons-configs": "^0.4.0",
-    "@aragon/osx-ethers": "^1.3.0-rc0.4",
-    "@aragon/osx-ethers-v1.0.0": "npm:@aragon/[email protected]",
-    "@aragon/sdk-ipfs": "^1.1.0",
-    "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/bignumber": "^5.7.0",
-    "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/hash": "^5.7.0",
-    "@ethersproject/providers": "^5.7.2",
-    "@ethersproject/wallet": "^5.7.0",
-    "graphql": "^16.5.0",
-    "graphql-request": "^4.3.0",
-    "ipfs-http-client": "^51.0.0",
-    "yup": "^1.2.0"
+    "@ethersproject/providers": "^5.7.0",
+    "ipfs-http-client": "^51.0.0"
   }
 }
diff --git a/sdk/src/bitmap/utils.ts → sdk/src/bitmap.ts b/sdk/src/bitmap/utils.ts → sdk/src/bitmap.ts
@@ -3,7 +3,7 @@ import {
   InvalidBitMapValueError,
   InvalidBitPositionError,
 } from './errors';
-import {BigNumber} from 'ethers';
+import {BigNumber} from '@ethersproject/bignumber';
 
 /**
  * Flips a specific bit in a `BigNumber` object and returns a new `BigNumber` object with the bit flipped.

diff --git a/sdk/src/bitmap/errors.ts b/sdk/src/bitmap/errors.ts
diff --git a/sdk/src/bitmap/index.ts b/sdk/src/bitmap/index.ts
diff --git a/sdk/src/constants.ts b/sdk/src/constants.ts
diff --git a/sdk/src/ens/utils.ts → sdk/src/ens.ts b/sdk/src/ens/utils.ts → sdk/src/ens.ts
@@ -1,9 +1,11 @@
-import {InvalidEnsError, UnsupportedNetworkError} from '../errors';
-import {isEnsName} from '../validation';
+import {InvalidEnsError, UnsupportedNetworkError} from './errors';
 import {getNetworkByAlias} from '@aragon/osx-commons-configs';
 import {Networkish} from '@ethersproject/networks';
 import {JsonRpcProvider, Provider} from '@ethersproject/providers';
 
+const ENS_REGEX = /^(?:[a-z0-9-]+\.)*[a-z0-9-]+\.eth$/;
+const SUBDOMAIN_REGEX = /^[a-z0-9-]+$/;
+
 /**
  * Resolves an ENS name to an address given a provider
  *
@@ -35,3 +37,23 @@ export function resolveEnsName(
   }
   return provider.resolveName(ensName);
 }
+/**
+ * Checks if the given string is a valid ENS name
+ *
+ * @export
+ * @param {string} name
+ * @return {*}  {boolean}
+ */
+export function isEnsName(name: string): boolean {
+  return ENS_REGEX.test(name);
+}
+/**
+ * Checks if the given string is a valid subdomain
+ *
+ * @export
+ * @param {string} name
+ * @return {*}  {boolean}
+ */
+export function isSubdomain(name: string): boolean {
+  return SUBDOMAIN_REGEX.test(name);
+}
diff --git a/sdk/src/ens/index.ts b/sdk/src/ens/index.ts