From 5b57fbc8cfe2a2f0bddce042d49a4689917a793c Mon Sep 17 00:00:00 2001
From: Willem Olding <willemolding@gmail.com>
Date: Fri, 9 Aug 2024 17:26:17 -0400
Subject: [PATCH] add draft memory store implementation
---
package-lock.json | 48 ++++++++
package.json | 4 +
packages/webz-indexdb-store/index.js | 0
packages/webz-memory-store/index.ts | 17 +++
.../package.json | 12 +-
packages/webz-memory-store/tsconfig.json | 108 ++++++++++++++++++
src/store/injected_store.rs | 10 +-
tests/web_accounts.rs | 2 +-
8 files changed, 192 insertions(+), 9 deletions(-)
create mode 100644 package-lock.json
create mode 100644 package.json
delete mode 100644 packages/webz-indexdb-store/index.js
create mode 100644 packages/webz-memory-store/index.ts
rename packages/{webz-indexdb-store => webz-memory-store}/package.json (66%)
create mode 100644 packages/webz-memory-store/tsconfig.json
diff --git a/package-lock.json b/package-lock.json
new file mode 100644
index 0000000..e69c74a
--- /dev/null
+++ b/package-lock.json
@@ -0,0 +1,48 @@
+{
+ "name": "webzjs",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "webzjs",
+ "workspaces": [
+ "packages/*"
+ ]
+ },
+ "node_modules/typescript": {
+ "version": "5.5.4",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz",
+ "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==",
+ "dev": true,
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=14.17"
+ }
+ },
+ "node_modules/webz-core": {
+ "resolved": "packages/webz-core",
+ "link": true
+ },
+ "node_modules/webz-memory-store": {
+ "resolved": "packages/webz-memory-store",
+ "link": true
+ },
+ "packages/webz-core": {
+ "version": "0.1.0",
+ "license": "MIT OR Apache-2.0"
+ },
+ "packages/webz-memory-store": {
+ "version": "1.0.0",
+ "license": "MIT OR Apache-2.0",
+ "dependencies": {
+ "webz-core": "^0.1.0"
+ },
+ "devDependencies": {
+ "typescript": "^5.5.4"
+ }
+ }
+ }
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..65ba0a4
--- /dev/null
+++ b/package.json
@@ -0,0 +1,4 @@
+{
+ "name": "webzjs",
+ "workspaces": ["packages/*"]
+ }
\ No newline at end of file
diff --git a/packages/webz-indexdb-store/index.js b/packages/webz-indexdb-store/index.js
deleted file mode 100644
index e69de29..0000000
diff --git a/packages/webz-memory-store/index.ts b/packages/webz-memory-store/index.ts
new file mode 100644
index 0000000..b0f1964
--- /dev/null
+++ b/packages/webz-memory-store/index.ts
@@ -0,0 +1,17 @@
+import { IWalletStore } from 'webz-core';
+
+export class MemoryStore implements IWalletStore {
+ private store: Record<string, Uint8Array> = {};
+
+ async get(key: string): Promise<Uint8Array> {
+ return this.store[key];
+ }
+
+ async update(key: string, value: Uint8Array): Promise<void> {
+ this.store[key] = value;
+ }
+
+ async clear(key: string): Promise<void> {
+ delete this.store[key];
+ }
+}
diff --git a/packages/webz-indexdb-store/package.json b/packages/webz-memory-store/package.json
similarity index 66%
rename from packages/webz-indexdb-store/package.json
rename to packages/webz-memory-store/package.json
index 3dee8f8..1e8dfed 100644
--- a/packages/webz-indexdb-store/package.json
+++ b/packages/webz-memory-store/package.json
@@ -1,8 +1,8 @@
{
- "name": "webz-indexdb-store",
+ "name": "webz-memory-store",
"version": "1.0.0",
"description": "Simple wrapper to allow using indexdb as the wallet store for WebZjs",
- "main": "index.js",
+ "main": "index.ts",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
@@ -15,5 +15,11 @@
"bugs": {
"url": "https://github.com/ChainSafe/WebZjs/issues"
},
- "homepage": "https://github.com/ChainSafe/WebZjs#readme"
+ "homepage": "https://github.com/ChainSafe/WebZjs#readme",
+ "dependencies": {
+ "webz-core": "^0.1.0"
+ },
+ "devDependencies": {
+ "typescript": "^5.5.4"
+ }
}
diff --git a/packages/webz-memory-store/tsconfig.json b/packages/webz-memory-store/tsconfig.json
new file mode 100644
index 0000000..8bb6097
--- /dev/null
+++ b/packages/webz-memory-store/tsconfig.json
@@ -0,0 +1,108 @@
+{
+ "compilerOptions": {
+ /* Visit https://aka.ms/tsconfig to read more about this file */
+
+ /* Projects */
+ // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
+ // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
+ // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
+ // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
+ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
+
+ /* Language and Environment */
+ "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+ // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+ // "jsx": "preserve", /* Specify what JSX code is generated. */
+ // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
+ // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
+ // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+ // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+ // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+ // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+ // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
+ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
+ // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
+
+ /* Modules */
+ "module": "commonjs", /* Specify what module code is generated. */
+ // "rootDir": "./", /* Specify the root folder within your source files. */
+ // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
+ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
+ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
+ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
+ // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
+ // "types": [], /* Specify type package names to be included without being referenced in a source file. */
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
+ // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
+ // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+ // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
+ // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
+ // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+ // "resolveJsonModule": true, /* Enable importing .json files. */
+ // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
+ // "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+ /* JavaScript Support */
+ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+ // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
+ // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+ /* Emit */
+ // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+ // "declarationMap": true, /* Create sourcemaps for d.ts files. */
+ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
+ // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
+ // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
+ // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+ // "outDir": "./", /* Specify an output folder for all emitted files. */
+ // "removeComments": true, /* Disable emitting comments. */
+ // "noEmit": true, /* Disable emitting files from a compilation. */
+ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+ // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+ // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
+ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
+ // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
+ // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+ // "newLine": "crlf", /* Set the newline character for emitting files. */
+ // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+ // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
+ // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
+ // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
+ // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
+
+ /* Interop Constraints */
+ // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
+ // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+ // "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+ // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
+ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+ // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+
+ /* Type Checking */
+ "strict": true, /* Enable all strict type-checking options. */
+ // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+ // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
+ // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+ // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+ // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
+ // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
+ // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
+ // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
+ // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
+ // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
+ // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
+ // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
+ // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
+ // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
+ // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
+ // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
+ // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
+ // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
+
+ /* Completeness */
+ // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
+ "skipLibCheck": true /* Skip type checking all .d.ts files. */
+ }
+}
diff --git a/src/store/injected_store.rs b/src/store/injected_store.rs
index 1a2156f..fdfb642 100644
--- a/src/store/injected_store.rs
+++ b/src/store/injected_store.rs
@@ -14,15 +14,15 @@ interface IWalletStore {
/**
* Update the value for a given key in store (or set it for the first time)
*/
- update(key: string, value: Uint8Array): void;
+ update(key: string, value: Uint8Array): Promise<void>;
/**
* Get the value at a given key
*/
- get(key: string): Uint8Array;
+ get(key: string): Promise<Uint8Array>;
/**
* Clear the value at a given key
*/
- clear(key: string): void;
+ clear(key: string): Promise<void>;
}
"#;
@@ -46,7 +46,7 @@ extern "C" {
impl WalletStore for InjectedStore {
async fn update(&mut self, key: &str, value: &[u8]) -> Result<(), Error> {
- InjectedStore::update(self, key, value);
+ InjectedStore::update(self, key, value).await?;
Ok(())
}
@@ -56,7 +56,7 @@ impl WalletStore for InjectedStore {
}
async fn clear(&mut self, key: &str) -> Result<(), Error> {
- InjectedStore::clear(self, key);
+ InjectedStore::clear(self, key).await?;
Ok(())
}
}
diff --git a/tests/web_accounts.rs b/tests/web_accounts.rs
index 7b74317..5f21e54 100644
--- a/tests/web_accounts.rs
+++ b/tests/web_accounts.rs
@@ -1,7 +1,7 @@
use wasm_bindgen_test::*;
wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);
-use webzjs::account::Account;
+use webz_core::account::Account;
#[wasm_bindgen_test]
fn test_account_from_seed() {