mirror of
https://github.com/wharfkit/transact-plugin-finality-callback.git
synced 2026-07-21 17:23:29 +00:00
Initial commit
This commit is contained in:
Daniel Fugere
@@ -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
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
custom: 'https://greymass.com/support-us'
|
||||
@@ -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
|
||||
@@ -0,0 +1,4 @@
|
||||
node_modules/
|
||||
lib/
|
||||
build/
|
||||
test/browser.html*
|
||||
@@ -0,0 +1,8 @@
|
||||
arrowParens: "always"
|
||||
bracketSpacing: false
|
||||
endOfLine: "lf"
|
||||
printWidth: 100
|
||||
semi: false
|
||||
singleQuote: true
|
||||
tabWidth: 4
|
||||
trailingComma: "es5"
|
||||
@@ -0,0 +1,29 @@
|
||||
Copyright (c) 2021 FFF00 Agents AB & 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.
|
||||
@@ -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' \
|
||||
${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' \
|
||||
${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/
|
||||
@@ -0,0 +1,20 @@
|
||||
# @wharfkit/transact-plugin-template
|
||||
|
||||
A template to create a `transactPlugin` for use during a `transact` call 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 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).
|
||||
@@ -0,0 +1,57 @@
|
||||
{
|
||||
"name": "@wharfkit/transact-plugin-template",
|
||||
"description": "A template to create plugins for use with @wharfkit/session transact method.",
|
||||
"version": "0.1.0",
|
||||
"homepage": "https://github.com/wharfkit/transact-plugin-template",
|
||||
"license": "BSD-3-Clause",
|
||||
"main": "lib/transact-plugin-template.js",
|
||||
"module": "lib/transact-plugin-template.m.js",
|
||||
"types": "lib/transact-plugin-template.d.ts",
|
||||
"sideEffects": false,
|
||||
"files": [
|
||||
"lib/*",
|
||||
"src/*"
|
||||
],
|
||||
"scripts": {
|
||||
"prepare": "make"
|
||||
},
|
||||
"dependencies": {
|
||||
"tslib": "^2.1.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@wharfkit/session": "^0.3.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/session": "^0.3.0",
|
||||
"@wharfkit/wallet-plugin-privatekey": "^0.3.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"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
import fs from 'fs'
|
||||
import dts from 'rollup-plugin-dts'
|
||||
import typescript from '@rollup/plugin-typescript'
|
||||
import json from '@rollup/plugin-json'
|
||||
|
||||
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.dependencies), ...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'}), json()],
|
||||
external,
|
||||
},
|
||||
{
|
||||
input: 'src/index.ts',
|
||||
output: {
|
||||
banner,
|
||||
file: pkg.module,
|
||||
format: 'esm',
|
||||
sourcemap: true,
|
||||
},
|
||||
plugins: [typescript({target: 'es2020'}), json()],
|
||||
external,
|
||||
},
|
||||
{
|
||||
input: 'src/index.ts',
|
||||
output: {banner, file: pkg.types, format: 'esm'},
|
||||
|
||||
plugins: [dts()],
|
||||
},
|
||||
]
|
||||
@@ -0,0 +1,90 @@
|
||||
import {
|
||||
AbstractTransactPlugin,
|
||||
TransactContext,
|
||||
TransactHookResponseType,
|
||||
TransactHookTypes,
|
||||
} from '@wharfkit/session'
|
||||
|
||||
/** Import JSON localization strings */
|
||||
import defaultTranslations from './translations.json'
|
||||
|
||||
export class TransactPluginTemplate extends AbstractTransactPlugin {
|
||||
/** A unique ID for this plugin */
|
||||
id = 'transact-plugin-template'
|
||||
|
||||
/** Optional - The translation strings to use for the plugin */
|
||||
translations = defaultTranslations
|
||||
|
||||
/**
|
||||
* Register the hooks required for this plugin to function
|
||||
*
|
||||
* @param context The TransactContext of the transaction being performed
|
||||
*/
|
||||
register(context: TransactContext): void {
|
||||
// Optional - Retrieve the translation function from the UI if it exists
|
||||
let t
|
||||
if (context.ui) {
|
||||
t = context.ui.getTranslate()
|
||||
}
|
||||
|
||||
// Register any desired beforeSign hooks
|
||||
context.addHook(
|
||||
TransactHookTypes.beforeSign,
|
||||
async (request, context): Promise<TransactHookResponseType> => {
|
||||
// If this plugin is interacting with the UI, throw an error since this is an undefined function
|
||||
if (context.ui) {
|
||||
throw new Error(
|
||||
// Translate the error message against the given key or use the default value as English
|
||||
t('beforesign', {
|
||||
default: 'undefined beforeSign hook called from plugin template',
|
||||
})
|
||||
)
|
||||
} else {
|
||||
// eslint-disable-next-line no-console
|
||||
console.log('undefined beforeSign hook called with', request, context)
|
||||
}
|
||||
return
|
||||
}
|
||||
)
|
||||
|
||||
// Register any desired afterSign hooks
|
||||
context.addHook(
|
||||
TransactHookTypes.afterSign,
|
||||
async (request, context): Promise<TransactHookResponseType> => {
|
||||
// If this plugin is interacting with the UI, throw an error since this is an undefined function
|
||||
if (context.ui) {
|
||||
throw new Error(
|
||||
// Translate the error message against the given key or use the default value as English
|
||||
t('aftersign', {
|
||||
default: 'undefined afterSign hook called from plugin template',
|
||||
})
|
||||
)
|
||||
} else {
|
||||
// eslint-disable-next-line no-console
|
||||
console.log('undefined afterSign hook called with', request, context)
|
||||
}
|
||||
return
|
||||
}
|
||||
)
|
||||
|
||||
// Register any desired afterBroadcast hooks
|
||||
context.addHook(
|
||||
TransactHookTypes.afterBroadcast,
|
||||
async (request, context): Promise<TransactHookResponseType> => {
|
||||
// If this plugin is interacting with the UI, throw an error since this is an undefined function
|
||||
if (context.ui) {
|
||||
throw new Error(
|
||||
// Translate the error message against the given key or use the default value as English
|
||||
t('afterbroadcast', {
|
||||
default: 'undefined afterBroadcast hook called from plugin template',
|
||||
})
|
||||
)
|
||||
} else {
|
||||
// eslint-disable-next-line no-console
|
||||
console.log('undefined afterBroadcast hook called with', request, context)
|
||||
}
|
||||
return
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"ko": {
|
||||
"beforesign": "undefined beforeSign hook called from plugin template",
|
||||
"aftersign": "undefined afterSign hook called from plugin template",
|
||||
"afterbroadcast": "undefined afterBroadcast hook called from plugin template"
|
||||
},
|
||||
"zh": {
|
||||
"beforesign": "undefined beforeSign hook called from plugin template",
|
||||
"aftersign": "undefined afterSign hook called from plugin template",
|
||||
"afterbroadcast": "undefined afterBroadcast hook called from plugin template"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"request": {
|
||||
"path": "https://jungle4.greymass.com/v1/chain/get_info",
|
||||
"params": {
|
||||
"method": "POST"
|
||||
}
|
||||
},
|
||||
"headers": {
|
||||
"access-control-allow-headers": "X-Requested-With,Accept,Content-Type,Origin",
|
||||
"access-control-allow-methods": "GET, POST, OPTIONS",
|
||||
"access-control-allow-origin": "*",
|
||||
"connection": "close",
|
||||
"content-length": "964",
|
||||
"content-type": "application/json",
|
||||
"date": "Sat, 31 Dec 2022 07:01:37 GMT",
|
||||
"host": "jungle4.greymass.com",
|
||||
"server": "nginx/1.18.0 (Ubuntu)",
|
||||
"x-cached": "MISS"
|
||||
},
|
||||
"status": 200,
|
||||
"json": {
|
||||
"server_version": "905c5cc9",
|
||||
"chain_id": "73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d",
|
||||
"head_block_num": 53515366,
|
||||
"last_irreversible_block_num": 53515039,
|
||||
"last_irreversible_block_id": "0330931f8caaac25828e42073605c1fbe07ebcbb3d330890a63420e0cd596885",
|
||||
"head_block_id": "033094661eb1189e4d3aea3800a53821f6ac21b0a50f76ab76ed69febed7468e",
|
||||
"head_block_time": "2022-12-31T07:01:37.000",
|
||||
"head_block_producer": "jumpingfrogs",
|
||||
"virtual_block_cpu_limit": 200000000,
|
||||
"virtual_block_net_limit": 1048576000,
|
||||
"block_cpu_limit": 200000,
|
||||
"block_net_limit": 1048576,
|
||||
"server_version_string": "v3.1.3",
|
||||
"fork_db_head_block_num": 53515366,
|
||||
"fork_db_head_block_id": "033094661eb1189e4d3aea3800a53821f6ac21b0a50f76ab76ed69febed7468e",
|
||||
"server_full_version_string": "v3.1.3-905c5cc900b4e88aed4ab6912009127bf9f4f140",
|
||||
"total_cpu_weight": "120460600273060",
|
||||
"total_net_weight": "117529136309360",
|
||||
"earliest_available_block_num": 53328984,
|
||||
"last_irreversible_block_time": "2022-12-31T06:58:53.500"
|
||||
},
|
||||
"text": "{\"server_version\":\"905c5cc9\",\"chain_id\":\"73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d\",\"head_block_num\":53515366,\"last_irreversible_block_num\":53515039,\"last_irreversible_block_id\":\"0330931f8caaac25828e42073605c1fbe07ebcbb3d330890a63420e0cd596885\",\"head_block_id\":\"033094661eb1189e4d3aea3800a53821f6ac21b0a50f76ab76ed69febed7468e\",\"head_block_time\":\"2022-12-31T07:01:37.000\",\"head_block_producer\":\"jumpingfrogs\",\"virtual_block_cpu_limit\":200000000,\"virtual_block_net_limit\":1048576000,\"block_cpu_limit\":200000,\"block_net_limit\":1048576,\"server_version_string\":\"v3.1.3\",\"fork_db_head_block_num\":53515366,\"fork_db_head_block_id\":\"033094661eb1189e4d3aea3800a53821f6ac21b0a50f76ab76ed69febed7468e\",\"server_full_version_string\":\"v3.1.3-905c5cc900b4e88aed4ab6912009127bf9f4f140\",\"total_cpu_weight\":\"120460600273060\",\"total_net_weight\":\"117529136309360\",\"earliest_available_block_num\":53328984,\"last_irreversible_block_time\":\"2022-12-31T06:58:53.500\"}"
|
||||
}
|
||||
@@ -0,0 +1,212 @@
|
||||
{
|
||||
"request": {
|
||||
"path": "https://jungle4.greymass.com/v1/chain/get_abi",
|
||||
"params": {
|
||||
"method": "POST",
|
||||
"body": "{\"account_name\":\"eosio.token\"}"
|
||||
}
|
||||
},
|
||||
"headers": {
|
||||
"access-control-allow-headers": "X-Requested-With,Accept,Content-Type,Origin",
|
||||
"access-control-allow-methods": "GET, POST, OPTIONS",
|
||||
"access-control-allow-origin": "*",
|
||||
"connection": "close",
|
||||
"content-length": "1707",
|
||||
"content-type": "application/json",
|
||||
"date": "Sat, 31 Dec 2022 07:01:36 GMT",
|
||||
"host": "jungle4.greymass.com",
|
||||
"server": "nginx/1.18.0 (Ubuntu)"
|
||||
},
|
||||
"status": 200,
|
||||
"json": {
|
||||
"account_name": "eosio.token",
|
||||
"abi": {
|
||||
"version": "eosio::abi/1.2",
|
||||
"types": [],
|
||||
"structs": [
|
||||
{
|
||||
"name": "account",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "balance",
|
||||
"type": "asset"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "close",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "owner",
|
||||
"type": "name"
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "symbol"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "create",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "issuer",
|
||||
"type": "name"
|
||||
},
|
||||
{
|
||||
"name": "maximum_supply",
|
||||
"type": "asset"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_stats",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "supply",
|
||||
"type": "asset"
|
||||
},
|
||||
{
|
||||
"name": "max_supply",
|
||||
"type": "asset"
|
||||
},
|
||||
{
|
||||
"name": "issuer",
|
||||
"type": "name"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "issue",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "to",
|
||||
"type": "name"
|
||||
},
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "asset"
|
||||
},
|
||||
{
|
||||
"name": "memo",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "open",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "owner",
|
||||
"type": "name"
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "symbol"
|
||||
},
|
||||
{
|
||||
"name": "ram_payer",
|
||||
"type": "name"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "retire",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "asset"
|
||||
},
|
||||
{
|
||||
"name": "memo",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "transfer",
|
||||
"base": "",
|
||||
"fields": [
|
||||
{
|
||||
"name": "from",
|
||||
"type": "name"
|
||||
},
|
||||
{
|
||||
"name": "to",
|
||||
"type": "name"
|
||||
},
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "asset"
|
||||
},
|
||||
{
|
||||
"name": "memo",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"actions": [
|
||||
{
|
||||
"name": "close",
|
||||
"type": "close",
|
||||
"ricardian_contract": ""
|
||||
},
|
||||
{
|
||||
"name": "create",
|
||||
"type": "create",
|
||||
"ricardian_contract": ""
|
||||
},
|
||||
{
|
||||
"name": "issue",
|
||||
"type": "issue",
|
||||
"ricardian_contract": ""
|
||||
},
|
||||
{
|
||||
"name": "open",
|
||||
"type": "open",
|
||||
"ricardian_contract": ""
|
||||
},
|
||||
{
|
||||
"name": "retire",
|
||||
"type": "retire",
|
||||
"ricardian_contract": ""
|
||||
},
|
||||
{
|
||||
"name": "transfer",
|
||||
"type": "transfer",
|
||||
"ricardian_contract": ""
|
||||
}
|
||||
],
|
||||
"tables": [
|
||||
{
|
||||
"name": "accounts",
|
||||
"index_type": "i64",
|
||||
"key_names": [],
|
||||
"key_types": [],
|
||||
"type": "account"
|
||||
},
|
||||
{
|
||||
"name": "stat",
|
||||
"index_type": "i64",
|
||||
"key_names": [],
|
||||
"key_types": [],
|
||||
"type": "currency_stats"
|
||||
}
|
||||
],
|
||||
"ricardian_clauses": [],
|
||||
"error_messages": [],
|
||||
"abi_extensions": [],
|
||||
"variants": [],
|
||||
"action_results": []
|
||||
}
|
||||
},
|
||||
"text": "{\"account_name\":\"eosio.token\",\"abi\":{\"version\":\"eosio::abi/1.2\",\"types\":[],\"structs\":[{\"name\":\"account\",\"base\":\"\",\"fields\":[{\"name\":\"balance\",\"type\":\"asset\"}]},{\"name\":\"close\",\"base\":\"\",\"fields\":[{\"name\":\"owner\",\"type\":\"name\"},{\"name\":\"symbol\",\"type\":\"symbol\"}]},{\"name\":\"create\",\"base\":\"\",\"fields\":[{\"name\":\"issuer\",\"type\":\"name\"},{\"name\":\"maximum_supply\",\"type\":\"asset\"}]},{\"name\":\"currency_stats\",\"base\":\"\",\"fields\":[{\"name\":\"supply\",\"type\":\"asset\"},{\"name\":\"max_supply\",\"type\":\"asset\"},{\"name\":\"issuer\",\"type\":\"name\"}]},{\"name\":\"issue\",\"base\":\"\",\"fields\":[{\"name\":\"to\",\"type\":\"name\"},{\"name\":\"quantity\",\"type\":\"asset\"},{\"name\":\"memo\",\"type\":\"string\"}]},{\"name\":\"open\",\"base\":\"\",\"fields\":[{\"name\":\"owner\",\"type\":\"name\"},{\"name\":\"symbol\",\"type\":\"symbol\"},{\"name\":\"ram_payer\",\"type\":\"name\"}]},{\"name\":\"retire\",\"base\":\"\",\"fields\":[{\"name\":\"quantity\",\"type\":\"asset\"},{\"name\":\"memo\",\"type\":\"string\"}]},{\"name\":\"transfer\",\"base\":\"\",\"fields\":[{\"name\":\"from\",\"type\":\"name\"},{\"name\":\"to\",\"type\":\"name\"},{\"name\":\"quantity\",\"type\":\"asset\"},{\"name\":\"memo\",\"type\":\"string\"}]}],\"actions\":[{\"name\":\"close\",\"type\":\"close\",\"ricardian_contract\":\"\"},{\"name\":\"create\",\"type\":\"create\",\"ricardian_contract\":\"\"},{\"name\":\"issue\",\"type\":\"issue\",\"ricardian_contract\":\"\"},{\"name\":\"open\",\"type\":\"open\",\"ricardian_contract\":\"\"},{\"name\":\"retire\",\"type\":\"retire\",\"ricardian_contract\":\"\"},{\"name\":\"transfer\",\"type\":\"transfer\",\"ricardian_contract\":\"\"}],\"tables\":[{\"name\":\"accounts\",\"index_type\":\"i64\",\"key_names\":[],\"key_types\":[],\"type\":\"account\"},{\"name\":\"stat\",\"index_type\":\"i64\",\"key_names\":[],\"key_types\":[],\"type\":\"currency_stats\"}],\"ricardian_clauses\":[],\"error_messages\":[],\"abi_extensions\":[],\"variants\":[],\"action_results\":[]}}"
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
/* eslint-disable no-undef */
|
||||
|
||||
import fs from 'fs'
|
||||
import path from 'path'
|
||||
|
||||
import {terser} from 'rollup-plugin-terser'
|
||||
import alias from '@rollup/plugin-alias'
|
||||
import commonjs from '@rollup/plugin-commonjs'
|
||||
import json from '@rollup/plugin-json'
|
||||
import replace from '@rollup/plugin-replace'
|
||||
import resolve from '@rollup/plugin-node-resolve'
|
||||
import typescript from '@rollup/plugin-typescript'
|
||||
import virtual from '@rollup/plugin-virtual'
|
||||
|
||||
const mockData = Object.fromEntries(
|
||||
fs
|
||||
.readdirSync(path.join(__dirname, 'data'))
|
||||
.map((f) => path.join(__dirname, 'data', f))
|
||||
.map((f) => [path.basename(f), JSON.parse(fs.readFileSync(f))])
|
||||
)
|
||||
|
||||
const testFiles = fs
|
||||
.readdirSync(path.join(__dirname, 'tests'))
|
||||
.filter((f) => f.match(/\.ts$/))
|
||||
.map((f) => path.join(__dirname, 'tests', f))
|
||||
.sort()
|
||||
|
||||
const template = `
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Tests</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="stylesheet" href="https://unpkg.com/mocha/mocha.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="mocha"></div>
|
||||
<script src="https://unpkg.com/chai/chai.js"></script>
|
||||
<script src="https://unpkg.com/mocha/mocha.js"></script>
|
||||
<script class="mocha-init">
|
||||
mocha.setup('tdd');
|
||||
mocha.checkLeaks();
|
||||
</script>
|
||||
<script>%%tests%%</script>
|
||||
<script class="mocha-exec">
|
||||
mocha.run();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`
|
||||
|
||||
function inline() {
|
||||
return {
|
||||
name: 'Inliner',
|
||||
generateBundle(opts, bundle) {
|
||||
const file = path.basename(opts.file)
|
||||
const output = bundle[file]
|
||||
delete bundle[file]
|
||||
const code = `${output.code}`
|
||||
this.emitFile({
|
||||
type: 'asset',
|
||||
fileName: file,
|
||||
source: template.replace('%%tests%%', code),
|
||||
})
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
/** @type {import('rollup').RollupOptions} */
|
||||
export default [
|
||||
{
|
||||
input: 'tests.ts',
|
||||
output: {
|
||||
file: 'build/browser.html',
|
||||
format: 'iife',
|
||||
sourcemap: true,
|
||||
globals: {
|
||||
chai: 'chai',
|
||||
mocha: 'mocha',
|
||||
util: 'undefined',
|
||||
crypto: 'undefined',
|
||||
},
|
||||
},
|
||||
external: ['chai', 'mocha', 'crypto', 'util'],
|
||||
plugins: [
|
||||
virtual({
|
||||
'tests.ts': testFiles.map((f) => `import '${f.slice(0, -3)}'`).join('\n'),
|
||||
}),
|
||||
alias({
|
||||
entries: [
|
||||
{find: '$lib', replacement: path.join(__dirname, '..', 'lib/session.m.js')},
|
||||
{find: './utils/mock-provider', replacement: './utils/browser-provider.ts'},
|
||||
],
|
||||
}),
|
||||
typescript({target: 'es6', module: 'esnext', tsconfig: './test/tsconfig.json'}),
|
||||
replace({'global.MOCK_DATA': JSON.stringify(mockData), preventAssignment: true}),
|
||||
resolve({browser: true}),
|
||||
commonjs(),
|
||||
json(),
|
||||
terser({
|
||||
mangle: false,
|
||||
format: {
|
||||
beautify: true,
|
||||
},
|
||||
compress: false,
|
||||
}),
|
||||
inline(),
|
||||
],
|
||||
},
|
||||
]
|
||||
@@ -0,0 +1,49 @@
|
||||
import {mockFetch} from '$test/utils/mock-fetch'
|
||||
import {TransactPluginTemplate} from '../../src/index'
|
||||
|
||||
import {Session, SessionArgs, SessionOptions} from '@wharfkit/session'
|
||||
import {WalletPluginPrivateKey} from '@wharfkit/wallet-plugin-privatekey'
|
||||
|
||||
const wallet = new WalletPluginPrivateKey('5Jtoxgny5tT7NiNFp1MLogviuPJ9NniWjnU4wKzaX4t7pL4kJ8s')
|
||||
|
||||
const mockSessionArgs: SessionArgs = {
|
||||
chain: {
|
||||
id: '73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d',
|
||||
url: 'https://jungle4.greymass.com',
|
||||
},
|
||||
permissionLevel: 'wharfkit1131@test',
|
||||
walletPlugin: wallet,
|
||||
}
|
||||
|
||||
const mockSessionOptions: SessionOptions = {
|
||||
fetch: mockFetch,
|
||||
transactPlugins: [new TransactPluginTemplate()],
|
||||
}
|
||||
|
||||
suite('example', function () {
|
||||
test('plugin usage', async function () {
|
||||
const session = new Session(mockSessionArgs, mockSessionOptions)
|
||||
const action = {
|
||||
authorization: [
|
||||
{
|
||||
actor: 'wharfkit1115',
|
||||
permission: 'test',
|
||||
},
|
||||
],
|
||||
account: 'eosio.token',
|
||||
name: 'transfer',
|
||||
data: {
|
||||
from: 'wharfkit1115',
|
||||
to: 'wharfkittest',
|
||||
quantity: '0.0001 EOS',
|
||||
memo: 'wharfkit plugin - resource provider test (maxFee: 0.0001)',
|
||||
},
|
||||
}
|
||||
await session.transact(
|
||||
{
|
||||
action,
|
||||
},
|
||||
{broadcast: false}
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"extends": "../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"isolatedModules": false,
|
||||
"resolveJsonModule": true,
|
||||
"module": "commonjs",
|
||||
"target": "es6",
|
||||
"types": ["mocha", "node"],
|
||||
"baseUrl": "..",
|
||||
"paths": {
|
||||
"$lib": ["src"],
|
||||
"$test": ["test"],
|
||||
"$test/*": ["test/*"]
|
||||
}
|
||||
},
|
||||
"include": ["*.ts", "**/*.ts"]
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
import fetch, {Response} from 'node-fetch'
|
||||
import {join as joinPath} from 'path'
|
||||
import {promisify} from 'util'
|
||||
import {readFile as _readFile, writeFile as _writeFile} from 'fs'
|
||||
import {Bytes, Checksum160} from '@greymass/eosio'
|
||||
|
||||
const readFile = promisify(_readFile)
|
||||
const writeFile = promisify(_writeFile)
|
||||
|
||||
function getFilename(path: string, params?: unknown) {
|
||||
const digest = Checksum160.hash(
|
||||
Bytes.from(path + (params ? JSON.stringify(params) : ''), 'utf8')
|
||||
).hexString
|
||||
return joinPath(__dirname, '../data', digest + '.json')
|
||||
}
|
||||
|
||||
async function getExisting(filename: string) {
|
||||
try {
|
||||
const data = await readFile(filename)
|
||||
return JSON.parse(data.toString('utf8'))
|
||||
} catch (error) {
|
||||
if ((<any>error).code !== 'ENOENT') {
|
||||
throw error
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function mockFetch(path, params) {
|
||||
const filename = getFilename(path, params)
|
||||
if (process.env['MOCK'] !== 'overwrite') {
|
||||
const existing = await getExisting(filename)
|
||||
if (existing) {
|
||||
return new Response(existing.text, {
|
||||
status: existing.status,
|
||||
headers: existing.headers,
|
||||
})
|
||||
}
|
||||
}
|
||||
if (process.env['MOCK']) {
|
||||
const response = await fetch(path, params)
|
||||
const cloned = response.clone()
|
||||
const json = await cloned.json()
|
||||
await writeFile(
|
||||
filename,
|
||||
JSON.stringify(
|
||||
{
|
||||
request: {
|
||||
path,
|
||||
params,
|
||||
},
|
||||
headers: Object.fromEntries(response.headers.entries()),
|
||||
status: response.status,
|
||||
json,
|
||||
text: JSON.stringify(json),
|
||||
},
|
||||
undefined,
|
||||
4
|
||||
)
|
||||
)
|
||||
return response
|
||||
} else {
|
||||
throw new Error(`No data for ${path}`)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"downlevelIteration": true,
|
||||
"esModuleInterop": true,
|
||||
"experimentalDecorators": true,
|
||||
"importHelpers": true,
|
||||
"isolatedModules": true,
|
||||
"lib": ["dom", "es2020"],
|
||||
"module": "es2020",
|
||||
"moduleResolution": "node",
|
||||
"noImplicitAny": false,
|
||||
"resolveJsonModule": true,
|
||||
"sourceMap": true,
|
||||
"strict": true,
|
||||
"target": "es2020"
|
||||
},
|
||||
"include": ["src/**/*"]
|
||||
}
|
||||
Reference in New Issue
Block a user