Skip to content

Commit

Permalink
feat(core-wallet-api): initial implementation (#2544)
Browse files Browse the repository at this point in the history
  • Loading branch information
faustbrian authored May 8, 2019
1 parent c55cbed commit d3af2e9
Show file tree
Hide file tree
Showing 13 changed files with 184 additions and 12 deletions.
36 changes: 24 additions & 12 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ jobs:
- save_cache:
key: 'core-node10-{{ checksum "checksum.txt" }}-unit-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -44,6 +43,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -68,6 +68,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -116,7 +117,6 @@ jobs:
- save_cache:
key: 'core-node11-{{ checksum "checksum.txt" }}-unit-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -130,6 +130,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -154,6 +155,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -210,7 +212,6 @@ jobs:
- save_cache:
key: 'core-node10-{{ checksum "checksum.txt" }}-functional-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -224,6 +225,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -248,6 +250,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -304,7 +307,6 @@ jobs:
- save_cache:
key: 'core-node11-{{ checksum "checksum.txt" }}-functional-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -318,6 +320,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -342,6 +345,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -398,7 +402,6 @@ jobs:
- save_cache:
key: 'core-node10-{{ checksum "checksum.txt" }}-1-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -412,6 +415,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -436,6 +440,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -517,7 +522,6 @@ jobs:
- save_cache:
key: 'core-node11-{{ checksum "checksum.txt" }}-1-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -531,6 +535,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -555,6 +560,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -625,7 +631,6 @@ jobs:
- save_cache:
key: 'core-node10-{{ checksum "checksum.txt" }}-benchmark-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -639,6 +644,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -663,6 +669,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Benchmark
command: cd ~/core && yarn bench
Expand Down Expand Up @@ -693,7 +700,6 @@ jobs:
- save_cache:
key: 'core-node11-{{ checksum "checksum.txt" }}-benchmark-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -707,6 +713,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -731,6 +738,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Benchmark
command: cd ~/core && yarn bench
Expand Down Expand Up @@ -769,7 +777,6 @@ jobs:
- save_cache:
key: 'ark-node10-e2e-{{ checksum "checksum.txt" }}-1-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -783,6 +790,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -807,6 +815,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Generate files
command: >-
Expand Down Expand Up @@ -887,7 +896,6 @@ jobs:
- save_cache:
key: 'ark-node11-e2e-{{ checksum "checksum.txt" }}-2-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -901,6 +909,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -925,6 +934,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Generate files
command: >-
Expand Down Expand Up @@ -1008,7 +1018,6 @@ jobs:
- save_cache:
key: 'core-node10-{{ checksum "checksum.txt" }}-1-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -1022,6 +1031,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -1046,6 +1056,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down Expand Up @@ -1127,7 +1138,6 @@ jobs:
- save_cache:
key: 'core-node11-{{ checksum "checksum.txt" }}-1-2'
paths:
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-pino/node_modules
- ./packages/core-logger-signale/node_modules
Expand All @@ -1141,6 +1151,7 @@ jobs:
- ./packages/core-transactions/node_modules
- ./packages/core-utils/node_modules
- ./packages/core-vote-report/node_modules
- ./packages/core-wallet-api/node_modules
- ./packages/core-webhooks/node_modules
- ./packages/crypto/node_modules
- ./node_modules
Expand All @@ -1165,6 +1176,7 @@ jobs:
- ./packages/core-http-utils/node_modules
- ./packages/core-interfaces/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- run:
name: Create .core/database directory
command: mkdir -p $HOME/.core/database
Expand Down
7 changes: 7 additions & 0 deletions packages/core-wallet-api/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/README.md export-ignore
21 changes: 21 additions & 0 deletions packages/core-wallet-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ARK Core - Wallet API

<p align="center">
<img src="https://raw.githubusercontent.com/ARKEcosystem/core/master/banner.png" />
</p>

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://docs.ark.io/guidebook/core/plugins/required/core-wallet-api.html).

## Security

If you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](../../../../contributors).

## License

[MIT](LICENSE) © [ARK Ecosystem](https://ark.io)
34 changes: 34 additions & 0 deletions packages/core-wallet-api/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"name": "@arkecosystem/core-wallet-api",
"description": "Wallet API for ARK Core",
"version": "2.4.0-next.1",
"contributors": [
"Brian Faust <brian@ark.io>",
"Alex Barnsley <alex@ark.io>"
],
"license": "MIT",
"main": "dist/index",
"types": "dist/index",
"files": [
"dist"
],
"scripts": {
"prepublishOnly": "yarn build",
"pretest": "bash ../../scripts/pre-test.sh",
"compile": "../../node_modules/typescript/bin/tsc",
"build": "yarn clean && yarn compile",
"build:watch": "yarn clean && yarn compile -w",
"clean": "del dist"
},
"dependencies": {
"@arkecosystem/core-container": "^2.4.0-next.1",
"@arkecosystem/core-http-utils": "^2.4.0-next.1",
"@arkecosystem/core-interfaces": "^2.4.0-next.1"
},
"publishConfig": {
"access": "public"
},
"engines": {
"node": ">=10.x"
}
}
1 change: 1 addition & 0 deletions packages/core-wallet-api/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from "./plugin";
17 changes: 17 additions & 0 deletions packages/core-wallet-api/src/plugin.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { Container, Logger } from "@arkecosystem/core-interfaces";
import { startServer } from "./server";

export const plugin: Container.IPluginDescriptor = {
pkg: require("../package.json"),
alias: "wallet-api",
async register(container: Container.IContainer, options) {
container.resolvePlugin<Logger.ILogger>("logger").info("Starting Wallet API");

return startServer(options);
},
async deregister(container: Container.IContainer, options) {
container.resolvePlugin<Logger.ILogger>("logger").info("Stopping Wallet API");

return container.resolvePlugin("wallet-api").stop();
},
};
Loading

0 comments on commit d3af2e9

Please sign in to comment.