feat(sdk): add initial base structure

ordzaar · Oct 23, 2023 · d242a9b · d242a9b
1 parent 9e1fac8
commit d242a9b
Show file tree

Hide file tree

Showing 23 changed files with 583 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,14 @@ npm install -g pnpm
 pnpm i
 ```
 
+### Running in Development Mode
+
+Execute the following command below and it will run the build process in watch mode.
+
+```bash
+pnpm dev
+```
+
 ## License & Disclaimer
 
 By using `Ordit` (this repo), you (the user) agree to be bound by [the terms of this license](LICENSE).
diff --git a/apps/browser-tests/index.d.ts b/apps/browser-tests/index.d.ts
@@ -0,0 +1 @@
+export * from "./dist/index";
diff --git a/apps/browser-tests/index.html b/apps/browser-tests/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + TS</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/apps/browser-tests/package.json b/apps/browser-tests/package.json
@@ -0,0 +1,24 @@
+{
+  "name": "@ordzaar/ordit-sdk-browser-tests",
+  "version": "0.0.0",
+  "description": "SDK tests for simplified interaction with wallet APIs and inscription service",
+  "license": "MIT",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "ordit",
+    "ordit-sdk",
+    "sdk"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "build:watch": "tsc && vite build --watch",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@ordzaar/ordit-sdk": "workspace:*"
+  }
+}
diff --git a/apps/browser-tests/src/main.ts b/apps/browser-tests/src/main.ts
@@ -0,0 +1,11 @@
+async function main() {
+  const appRoot = document.getElementById("app");
+
+  if (!appRoot) {
+    return;
+  }
+
+  appRoot.innerHTML = "Browser Test";
+}
+
+main();
diff --git a/apps/browser-tests/src/vite-env.d.ts b/apps/browser-tests/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/apps/browser-tests/tsconfig.json b/apps/browser-tests/tsconfig.json
@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Default",
+  "compilerOptions": {
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "module": "ESNext",
+    "target": "ESNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "rootDir": "./",
+    "outDir": "./dist",
+    "sourceMap": true
+  },
+  "include": ["./src", "./tests", "./src/types"],
+  "exclude": ["node_modules", "dist"]
+}
diff --git a/package.json b/package.json
@@ -10,7 +10,8 @@
     "clean": "turbo run clean",
     "format": "prettier --write .",
     "lint": "turbo run lint -- --fix",
-    "test": "turbo run test"
+    "test": "turbo run test",
+    "dev": "turbo run dev"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.4.8",
@@ -19,8 +20,8 @@
     "@stickyjs/turbo": "^1.3.4",
     "@waveshq/standard-prettier": "^2.16.0",
     "@waveshq/standard-web-linter": "^2.16.0",
-    "semver": "^7.5.4",
     "husky": "^8.0.3",
+    "semver": "^7.5.4",
     "typescript": "5.2.2",
     "vite": "^4.4.11",
     "vitest": "^0.34.6"

diff --git a/packages/sdk/browser-wallets.d.ts b/packages/sdk/browser-wallets.d.ts
@@ -0,0 +1 @@
+export * from "./dist/browser-wallets/index";
diff --git a/packages/sdk/index.d.ts b/packages/sdk/index.d.ts
@@ -0,0 +1 @@
+export * from "./dist/index";
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -2,21 +2,36 @@
   "name": "@ordzaar/ordit-sdk",
   "version": "0.0.0",
   "description": "SDK for simplified interaction with wallet APIs and inscription service",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./browser-wallets": {
+      "import": "./dist/browser-wallets.js",
+      "require": "./dist/browser-wallets.cjs"
+    }
+  },
   "files": [
-    "dist"
+    "dist/*",
+    "index.d.ts",
+    "browser-wallets.d.ts"
   ],
   "keywords": [
     "ordit",
     "ordit-sdk",
     "sdk"
   ],
   "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "build:watch": "tsc && vite build --watch",
-    "preview": "vite preview"
+    "dev": "pnpm clean && tsc && vite build --watch",
+    "build": "pnpm clean && tsc && vite build",
+    "build:watch": "pnpm clean && tsc && vite build --watch",
+    "preview": "vite preview",
+    "clean": "rm -rf dist"
   },
   "dependencies": {
     "@bitcoinerlab/secp256k1": "1.0.5",
@@ -32,6 +47,7 @@
     "sats-connect": "^1.1.1"
   },
   "devDependencies": {
-    "@types/node": "^20.8.6"
+    "@types/node": "^20.8.6",
+    "vite-plugin-dts": "^3.6.0"
   }
 }
diff --git a/packages/sdk/src/browser-wallets/index.ts b/packages/sdk/src/browser-wallets/index.ts
@@ -0,0 +1,2 @@
+export { wallet as unisat } from "./unisat";
+export { wallet as xverse } from "./xverse";
diff --git a/packages/sdk/src/browser-wallets/types.ts b/packages/sdk/src/browser-wallets/types.ts
@@ -0,0 +1,6 @@
+export interface BrowserWallet {
+  isInstalled: () => Promise<boolean>;
+  getAddresses: () => Promise<void>;
+  signPsbt: () => Promise<void>;
+  signMessage: () => Promise<void>;
+}
diff --git a/packages/sdk/src/browser-wallets/unisat/index.ts b/packages/sdk/src/browser-wallets/unisat/index.ts
@@ -0,0 +1,20 @@
+import { BrowserWallet } from "../types";
+
+async function isInstalled() {
+  return false;
+}
+
+async function getAddresses() {}
+
+async function signPsbt() {}
+
+async function signMessage() {}
+
+const wallet: BrowserWallet = {
+  isInstalled,
+  getAddresses,
+  signPsbt,
+  signMessage,
+};
+
+export { wallet };
diff --git a/packages/sdk/src/browser-wallets/xverse/index.ts b/packages/sdk/src/browser-wallets/xverse/index.ts
@@ -0,0 +1,20 @@
+import { BrowserWallet } from "../types";
+
+async function isInstalled() {
+  return false;
+}
+
+async function getAddresses() {}
+
+async function signPsbt() {}
+
+async function signMessage() {}
+
+const wallet: BrowserWallet = {
+  isInstalled,
+  getAddresses,
+  signPsbt,
+  signMessage,
+};
+
+export { wallet };
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -0,0 +1,6 @@
+import type { BrowserWallet } from "./browser-wallets/types";
+export type { BrowserWallet };
+
+const SDK_NAME = "ORDIT_SDK";
+
+export { SDK_NAME };
diff --git a/packages/sdk/src/types.d.ts b/packages/sdk/src/types.d.ts
@@ -0,0 +1,23 @@
+declare interface Window {
+  unisat: Unisat;
+  ethereum: MetaMask;
+}
+
+type UnisatNetwork = "livenet" | "testnet";
+
+type Unisat = {
+  getNetwork: () => Promise<UnisatNetwork>;
+  switchNetwork: (targetNetwork: UnisatNetwork) => Promise<void>;
+  requestAccounts: () => Promise<string[]>;
+  getPublicKey: () => Promise<string>;
+  signPsbt: (
+    hex: string,
+    { autoFinalized }: Record<string, boolean>,
+  ) => Promise<string>;
+  signMessage: (message: string) => Promise<string>;
+};
+
+type MetaMask = {
+  isMetaMask: boolean;
+  request: (options: { method: string; params?: any }) => Promise<any>;
+};
diff --git a/packages/sdk/tsconfig.json b/packages/sdk/tsconfig.json
@@ -18,10 +18,10 @@
     "noUnusedLocals": false,
     "noUnusedParameters": false,
     "preserveWatchOutput": true,
-    "rootDir": "./",
+    "rootDir": "./src",
     "outDir": "./dist",
     "sourceMap": true
   },
-  "include": ["./src", "./tests", "./src/types"],
+  "include": ["./src", "./src/types"],
   "exclude": ["node_modules", "dist"]
 }
diff --git a/packages/sdk/tsconfig.tsbuildinfo b/packages/sdk/tsconfig.tsbuildinfo
diff --git a/packages/sdk/vite.config.ts b/packages/sdk/vite.config.ts
@@ -0,0 +1,28 @@
+import { resolve } from "path";
+import { defineConfig } from "vite";
+import dts from "vite-plugin-dts";
+import * as packageJson from "./package.json";
+
+export default defineConfig({
+  build: {
+    outDir: "dist",
+    lib: {
+      entry: {
+        index: resolve(__dirname, "src/index.ts"),
+        "browser-wallets": resolve(__dirname, "src/browser-wallets/index.ts"),
+      },
+      formats: ["es", "cjs"],
+    },
+    rollupOptions: {
+      external: Object.keys(packageJson.dependencies),
+    },
+    commonjsOptions: {
+      include: [/node_modules/],
+    },
+  },
+  plugins: [
+    dts({
+      insertTypesEntry: true,
+    }),
+  ],
+});
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export { wallet as unisat } from "./unisat";
		export { wallet as xverse } from "./xverse";