Initial commit

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,27 @@
+{
+    "root": true,
+    "ignorePatterns": ["lib/*", "node_modules/**"],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended"
+    ],
+    "rules": {
+        "prettier/prettier": "warn",
+        "no-console": "warn",
+        "sort-imports": [
+            "warn",
+            {
+                "ignoreCase": true,
+                "ignoreDeclarationSort": true
+            }
+        ],
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-namespace": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-empty-function": "warn",
+        "no-inner-declarations": "off"
+    }
+}

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: 'https://greymass.com/support-us'

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Tests
+on: push
+jobs:
+    test-node-js:
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: false
+            matrix:
+                node-version: [14, 16, 18]
+        name: Node.js v${{ matrix.node-version }}
+        steps:
+            - name: Setup Node.js
+              uses: actions/setup-node@v2
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - name: Checkout code
+              uses: actions/checkout@v2
+            - name: Install dependencies
+              run: make node_modules
+            - name: Run checks
+              run: make check
+            - name: Run tests
+              run: make ci-test

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+lib/

.prettierrc

@@ -0,0 +1,8 @@
+arrowParens: "always"
+bracketSpacing: false
+endOfLine: "lf"
+printWidth: 100
+semi: false
+singleQuote: true
+tabWidth: 4
+trailingComma: "es5"

LICENSE

@@ -0,0 +1,29 @@
+Copyright (c) 2023 Greymass Inc. All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistribution of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+
+2.  Redistribution in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+3.  Neither the name of the copyright holder nor the names of its contributors
+    may be used to endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+
+YOU ACKNOWLEDGE THAT THIS SOFTWARE IS NOT DESIGNED, LICENSED OR INTENDED FOR USE
+IN THE DESIGN, CONSTRUCTION, OPERATION OR MAINTENANCE OF ANY MILITARY FACILITY.

Makefile

@@ -0,0 +1,81 @@
+SHELL := /bin/bash
+SRC_FILES := $(shell find src -name '*.ts')
+TEST_FILES := $(shell find test/tests -name '*.ts')
+BIN := ./node_modules/.bin
+MOCHA_OPTS := -u tdd -r ts-node/register -r tsconfig-paths/register --extension ts
+NYC_OPTS := --temp-dir build/nyc_output --report-dir build/coverage
+
+lib: ${SRC_FILES} package.json tsconfig.json node_modules rollup.config.js
+	@${BIN}/rollup -c && touch lib
+
+.PHONY: test
+test: node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' MOCK_DIR='./test/data' \
+		${BIN}/mocha ${MOCHA_OPTS} ${TEST_FILES} --grep '$(grep)'
+
+build/coverage: ${SRC_FILES} ${TEST_FILES} node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' \
+		${BIN}/nyc ${NYC_OPTS} --reporter=html \
+		${BIN}/mocha ${MOCHA_OPTS} -R nyan ${TEST_FILES}
+
+.PHONY: coverage
+coverage: build/coverage
+	@open build/coverage/index.html
+
+.PHONY: ci-test
+ci-test: node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' MOCK_DIR='./test/data' \
+		${BIN}/nyc ${NYC_OPTS} --reporter=text \
+		${BIN}/mocha ${MOCHA_OPTS} -R list ${TEST_FILES}
+
+.PHONY: check
+check: node_modules
+	@${BIN}/eslint src --ext .ts --max-warnings 0 --format unix && echo "Ok"
+
+.PHONY: format
+format: node_modules
+	@${BIN}/eslint src --ext .ts --fix
+
+.PHONY: publish
+publish: | distclean node_modules
+	@git diff-index --quiet HEAD || (echo "Uncommitted changes, please commit first" && exit 1)
+	@git fetch origin && git diff origin/master --quiet || (echo "Changes not pushed to origin, please push first" && exit 1)
+	@yarn config set version-tag-prefix "" && yarn config set version-git-message "Version %s"
+	@yarn publish && git push && git push --tags
+
+.PHONY: docs
+docs: build/docs
+	@open build/docs/index.html
+
+build/docs: $(SRC_FILES) node_modules
+	@${BIN}/typedoc --out build/docs \
+		--excludeInternal --excludePrivate --excludeProtected \
+		--includeVersion --hideGenerator --readme none \
+		src/index.ts
+
+build/pages: build/docs test/browser.html
+	@mkdir -p build/pages
+	@cp -r build/docs/* build/pages/
+	@cp test/browser.html build/pages/tests.html
+
+.PHONY: deploy-pages
+deploy-pages: | clean build/pages node_modules
+	@${BIN}/gh-pages -d build/pages
+
+test/browser.html: $(SRC_FILES) $(TEST_FILES) test/rollup.config.js node_modules
+	@${BIN}/rollup -c test/rollup.config.js
+
+.PHONY: browser-test
+browser-test: test/browser.html
+	@open test/browser.html
+
+node_modules:
+	yarn install --non-interactive --frozen-lockfile --ignore-scripts
+
+.PHONY: clean
+clean:
+	rm -rf lib/ build/ test/browser.html
+
+.PHONY: distclean
+distclean: clean
+	rm -rf node_modules/

README.md

@@ -0,0 +1,20 @@
+# @wharfkit/wallet-plugin-template
+
+A template to create a `WalletPlugin` for use within the `@wharfkit/session` library.
+
+## Usage
+
+-   [Use this as a template.](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
+-   Write your wallet plugin's logic.
+-   Publish it on Github or npmjs.com
+-   Include it in your project and use it.
+
+## Developing
+
+You need [Make](https://www.gnu.org/software/make/), [node.js](https://nodejs.org/en/) and [yarn](https://classic.yarnpkg.com/en/docs/install) installed.
+
+Clone the repository and run `make` to checkout all dependencies and build the project. See the [Makefile](./Makefile) for other useful targets. Before submitting a pull request make sure to run `make lint`.
+
+---
+
+Made with ☕️ & ❤️ by [Greymass](https://greymass.com), if you find this useful please consider [supporting us](https://greymass.com/support-us).

package.json

@@ -0,0 +1,57 @@
+{
+    "name": "@wharfkit/wallet-plugin-template",
+    "description": "A template to create wallet plugins for use with @wharfkit/session.",
+    "version": "1.0.0",
+    "homepage": "https://github.com/wharfkit/wallet-plugin-template",
+    "license": "BSD-3-Clause",
+    "main": "lib/wallet-plugin-template.js",
+    "module": "lib/wallet-plugin-template.m.js",
+    "types": "lib/wallet-plugin-template.d.ts",
+    "sideEffects": false,
+    "files": [
+        "lib/*",
+        "src/*"
+    ],
+    "scripts": {
+        "prepare": "make"
+    },
+    "dependencies": {
+        "tslib": "^2.1.0"
+    },
+    "peerDependencies": {
+        "@wharfkit/session": "^1.0.0"
+    },
+    "devDependencies": {
+        "@rollup/plugin-alias": "^3.1.4",
+        "@rollup/plugin-commonjs": "^22.0.0",
+        "@rollup/plugin-json": "^4.1.0",
+        "@rollup/plugin-node-resolve": "^14.1.0",
+        "@rollup/plugin-replace": "^5.0.1",
+        "@rollup/plugin-typescript": "^10.0.1",
+        "@rollup/plugin-virtual": "^2.0.3",
+        "@types/chai": "^4.3.1",
+        "@types/mocha": "^9.0.0",
+        "@types/node": "^18.7.18",
+        "@typescript-eslint/eslint-plugin": "^5.20.0",
+        "@typescript-eslint/parser": "^5.20.0",
+        "@wharfkit/mock-data": "^1.0.2",
+        "@wharfkit/session": "^1.0.0",
+        "chai": "^4.3.4",
+        "eslint": "^8.13.0",
+        "eslint-config-prettier": "^8.1.0",
+        "eslint-plugin-prettier": "^4.0.0",
+        "gh-pages": "^4.0.0",
+        "mocha": "^10.0.0",
+        "node-fetch": "^2.6.1",
+        "nyc": "^15.1.0",
+        "prettier": "^2.2.1",
+        "rollup": "^2.70.2",
+        "rollup-plugin-dts": "^4.2.1",
+        "rollup-plugin-terser": "^7.0.2",
+        "ts-node": "^10.9.1",
+        "tsconfig-paths": "^4.1.1",
+        "typedoc": "^0.23.14",
+        "typescript": "^4.1.2",
+        "yarn-deduplicate": "^6.0.1"
+    }
+}

rollup.config.js

@@ -0,0 +1,51 @@
+import fs from 'fs'
+import dts from 'rollup-plugin-dts'
+import typescript from '@rollup/plugin-typescript'
+
+import pkg from './package.json'
+
+const name = pkg.name
+const license = fs.readFileSync('LICENSE').toString('utf-8').trim()
+const banner = `
+/**
+ * ${name} v${pkg.version}
+ * ${pkg.homepage}
+ *
+ * @license
+ * ${license.replace(/\n/g, '\n * ')}
+ */
+`.trim()
+
+const external = Object.keys(pkg.peerDependencies)
+
+/** @type {import('rollup').RollupOptions} */
+export default [
+    {
+        input: 'src/index.ts',
+        output: {
+            banner,
+            file: pkg.main,
+            format: 'cjs',
+            sourcemap: true,
+            exports: 'named',
+        },
+        plugins: [typescript({target: 'es6'})],
+        external,
+    },
+    {
+        input: 'src/index.ts',
+        output: {
+            banner,
+            file: pkg.module,
+            format: 'esm',
+            sourcemap: true,
+        },
+        plugins: [typescript({target: 'es2020'})],
+        external,
+    },
+    {
+        input: 'src/index.ts',
+        output: {banner, file: pkg.types, format: 'esm'},
+        plugins: [dts()],
+    },
+]