Export a lightweight headless tokenscript engine

javascript/engine-js/package.json

@@ -11,6 +11,16 @@
   "main": "./dist/lib.commonjs/index.js",
   "module": "./dist/lib.esm/index.js",
   "types": "./dist/lib.esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/lib.esm/index.js",
+      "require": "./dist/lib.commonjs/index.js"
+    },
+    "./lite": {
+      "import": "./dist/lib.esm/index.lite.js",
+      "require": "./dist/lib.commonjs/index.lite.js"
+    }
+  },
   "scripts": {
     "build": "tsc && tsc -p tsconfig-commonjs.json && npm run copy-sdk",
     "copy-sdk": "copyfiles -u 1 ./src/view/sdk/* ./dist/lib.esm && copyfiles copyfiles -u 1 ./src/view/sdk/* ./dist/lib.commonjs",

javascript/engine-js/src/AbstractEngine.ts

@@ -0,0 +1,113 @@
+import { IEngineConfig, ITokenScriptEngine } from './IEngine';
+import { ITokenScript } from './ITokenScript';
+import { Repo } from './repo/Repo';
+import { IWalletAdapter } from './wallet/IWalletAdapter';
+
+const DEFAULT_CONFIG: IEngineConfig = {
+  ipfsGateway: 'https://smart-token-labs-demo-server.mypinata.cloud/ipfs/',
+  noLocalStorage: false,
+  trustedKeys: [],
+};
+
+/**
+ * Engine.ts is the top level component for the TokenScript engine, it can be used to create a new TokenScript instance
+ * via the repo, URL or directly from XML source
+ */
+export abstract class AbstractTokenScriptEngine implements ITokenScriptEngine {
+  protected repo: Repo
+  // TODO: Should we pass in a function or a constructor, dunno
+  constructor(public getWalletAdapter: () => Promise<IWalletAdapter>, public readonly config?: IEngineConfig) {
+    this.repo = new Repo(this)
+
+    if (this.config) {
+      this.config = {
+        ...DEFAULT_CONFIG,
+        ...this.config,
+      };
+    } else {
+      this.config = DEFAULT_CONFIG;
+    }
+  }
+
+  public resolveAllScripts(tsPath: string, forceReload = false) {
+    return this.repo.resolveAllScripts(tsPath, forceReload);
+  }
+
+  /**
+   * Sign a personal message using the Ethereum WalletAdapter implementation provided by the user-agent
+   * @param data
+   */
+  public async signPersonalMessage(data) {
+    try {
+      return await (await this.getWalletAdapter()).signPersonalMessage(data);
+    } catch (e) {
+      throw new Error('Signing failed: ' + e.message);
+    }
+  }
+
+  // TODO: This should probably be moved somewhere else
+  /**
+   * Public IPFS gateways are sometimes very slow, so when a custom IPFS gateway is supplied in the config,
+   * we update the following URLs to our own gateways.
+   * @private
+   */
+  private IPFS_REPLACE_GATEWAYS = ['ipfs://', 'https://ipfs.io/ipfs/', 'https://gateway.pinata.cloud/ipfs/'];
+
+  public processIpfsUrl(uri: string) {
+    for (let gateway of this.IPFS_REPLACE_GATEWAYS) {
+      if (this.config.ipfsGateway.indexOf(gateway) === 0) {
+        continue;
+      }
+
+      if (uri.indexOf(gateway) === 0) {
+        uri = uri.replace(gateway, this.config.ipfsGateway);
+        break;
+      }
+    }
+
+    return uri;
+  }
+
+  public async getScriptUris(chain: string | number, contractAddr: string) {
+    // Direct RPC gets too hammered by opensea view (that doesn't allow localStorage to cache XML)
+    /*const provider = await this.getWalletAdapter();
+		let uri: string|string[]|null;
+
+		try {
+			uri = Array.from(await provider.call(parseInt(chain), contractAddr, "scriptURI", [], ["string[]"])) as string[];
+		} catch (e) {
+			uri = await provider.call(parseInt(chain), contractAddr, "scriptURI", [], ["string"]);
+		}
+
+		if (uri && Array.isArray(uri))
+			uri = uri.length ? uri[0] : null
+
+		return <string>uri;*/
+
+    // TODO: Add support for selecting a specific index or URL?
+    // const res = await fetch(`https://api.token-discovery.tokenscript.org/script-uri?chain=${chain}&contract=${contractAddr}`);
+    // const scriptUris = await res.json();
+    //return <string>scriptUris[0];
+
+    // i.e. https://store-backend.smartlayer.network/tokenscript/0xD5cA946AC1c1F24Eb26dae9e1A53ba6a02bd97Fe/chain/137/script-uri
+    const res = await fetch(`https://store-backend.smartlayer.network/tokenscript/${contractAddr.toLowerCase()}/chain/${chain}/script-uri`);
+    const data = await res.json();
+
+    if (!data.scriptURI) return null;
+
+    let uris: string[] = [];
+
+    if (data.scriptURI.erc5169?.length) uris.push(...data.scriptURI.erc5169);
+
+    if (data.scriptURI.offchain?.length) uris.push(...data.scriptURI.offchain);
+
+    return uris.length ? uris : null;
+  }
+
+  public abstract getTokenScriptFromUrl(url: string): Promise<ITokenScript>;
+  public abstract loadTokenScript(xml: string): Promise<ITokenScript>;
+  public abstract getTokenDiscoveryAdapter?: () => Promise<any>;
+  public abstract getAttestationStorageAdapter?: () => any;
+  public abstract getLocalStorageAdapter?: () => any;
+  public abstract getAttestationManager(): any;
+}