From 6a1cfcd1c03d464428a21425b42c016b2d783c46 Mon Sep 17 00:00:00 2001 From: Drew Edwards Date: Tue, 28 Mar 2023 17:56:49 +0100 Subject: [PATCH] chore: improvements to homepage/docs --- apidoc-template/index.html | 1 + apidoc-template/src/css/main.css | 7 + package.json | 2 +- src/utils/git.ts | 13 +- src/webserver/routes/blocks.ts | 209 -------------------------- src/webserver/routes/lookup/blocks.ts | 48 ------ src/webserver/routes/motd.ts | 18 --- src/webserver/routes/names.ts | 31 +--- src/webserver/routes/search/index.ts | 5 +- src/webserver/routes/search/search.ts | 8 +- src/webserver/routes/submission.ts | 66 -------- src/webserver/routes/transactions.ts | 4 +- src/webserver/routes/websockets.ts | 9 +- src/webserver/routes/work.ts | 64 -------- src/websockets/routes/submission.ts | 54 ------- static/style.css | 3 +- views/home.hbs | 10 +- whats-new.json | 4 - 18 files changed, 42 insertions(+), 514 deletions(-) diff --git a/apidoc-template/index.html b/apidoc-template/index.html index bd2ebb5..3796688 100644 --- a/apidoc-template/index.html +++ b/apidoc-template/index.html @@ -20,6 +20,7 @@
+ Krist HTTP API reference
diff --git a/apidoc-template/src/css/main.css b/apidoc-template/src/css/main.css index 1b76155..a81e0e8 100644 --- a/apidoc-template/src/css/main.css +++ b/apidoc-template/src/css/main.css @@ -615,3 +615,10 @@ body.container-fluid { top: -1px; overflow: hidden; } + +#logo { + display: inline; + width: 24px; + height: 24px; + margin-right: 2rem; +} diff --git a/package.json b/package.json index a38b8e9..d2cddf1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "krist", - "version": "3.3.0", + "version": "3.3.1", "description": "The new Krist node written in TypeScript.", "main": "dist/src/index.js", "scripts": { diff --git a/src/utils/git.ts b/src/utils/git.ts index 0b79a70..b6cc6e5 100644 --- a/src/utils/git.ts +++ b/src/utils/git.ts @@ -28,6 +28,7 @@ import { redis, rKey } from "../database/redis"; import { GITHUB_TOKEN } from "./constants"; const MESSAGE_TYPE_RE = /^(\w+): (.+)/; +const EXCLUDE_COMMITS_RE = /block|submi/gi; const octokit = GITHUB_TOKEN ? new Octokit({ auth: GITHUB_TOKEN, @@ -44,7 +45,7 @@ export interface FormattedCommit extends CommitBase { export async function getCommits(): Promise { const commits = await gitlog({ repo: path.join(__dirname, "../../"), - number: 10, + number: 20, fields: [ "subject", "body", "hash", "authorName", "authorEmail", "authorDate", "authorDateRel" @@ -60,7 +61,13 @@ async function formatCommits(commits: CommitBase[]): Promise for (const baseCommit of commits) { const commit: FormattedCommit = { ...baseCommit }; - if (!commit.subject) continue; + if ( + !commit.subject + || EXCLUDE_COMMITS_RE.test(commit.subject) + || (commit.body && EXCLUDE_COMMITS_RE.test(commit.body)) + ) { + continue; + } const [, type, rest] = MESSAGE_TYPE_RE.exec(commit.subject) || []; if (type) { @@ -84,7 +91,7 @@ async function formatCommits(commits: CommitBase[]): Promise }); } - return newCommits; + return newCommits.slice(0, 10); } async function getAvatar(commit: FormattedCommit): Promise { diff --git a/src/webserver/routes/blocks.ts b/src/webserver/routes/blocks.ts index 5c1146e..1b0c0d0 100755 --- a/src/webserver/routes/blocks.ts +++ b/src/webserver/routes/blocks.ts @@ -26,189 +26,24 @@ import { ctrlGetBlock, ctrlGetLastBlock } from "../../controllers/blocks"; import { blockToJson, getBlock, getBlocks, getBlockValue, getLastBlock, getLowestHashes } from "../../krist/blocks"; import { getBaseBlockValue, padDigits } from "../../utils"; -/** - * @apiDefine BlockGroup Blocks - * - * All Block related endpoints. - */ - -/** - * @apiDefine Block - * - * @apiSuccess {Object} block - * @apiSuccess {Number} block.height The height (ID) of this block. - * @apiSuccess {String} block.address The address which submitted this block. - * @apiSuccess {String} block.hash The full-length SHA-256 hash of this block. - * The hash is calculated by the SHA-256 of the submitter's address, - * the 12-char SHA-256 of the last block, and the nonce. - * @apiSuccess {String} block.short_hash The hash trimmed to 12 characters. - * @apiSuccess {Number} block.value The reward value of this block. - * @apiSuccess {Number} block.difficulty The difficulty at the time the block - * was mined. - * @apiSuccess {Date} block.time The time this block was submitted, as an - * ISO-8601 string. - */ - -/** - * @apiDefine Blocks - * - * @apiSuccess {Object[]} blocks - * @apiSuccess {Number} blocks.height The height (ID) of this block. - * @apiSuccess {String} blocks.address The address which submitted this block. - * @apiSuccess {String} blocks.hash The full-length SHA-256 hash of this block. - * The hash is calculated by the SHA-256 of the submitter's address, - * the 12-char SHA-256 of the last block, and the nonce. - * @apiSuccess {String} blocks.short_hash The hash trimmed to 12 characters. - * @apiSuccess {Number} blocks.value The reward value of this block. - * @apiSuccess {Number} blocks.difficulty The difficulty at the time the block - * was mined. - * @apiSuccess {Date} blocks.time The time this block was submitted, as an - * ISO-8601 string. - */ - export default (): Router => { const router = Router(); - /** - * @api {get} /blocks List all blocks - * @apiName GetBlocks - * @apiGroup BlockGroup - * @apiVersion 2.0.0 - * - * @apiUse LimitOffset - * - * @apiSuccess {Number} count The count of results. - * @apiSuccess {Number} total The total amount of blocks. - * @apiUse Blocks - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "count": 49, - * "total": 100000 - * "blocks": [ - * { - * "height": 2, - * "address": "a5dfb396d3", - * "hash": "00480dc35dc111d9953e5182df7d7f404a62d2b0d71ed51a873a81d89e78fbd8", - * "short_hash": "00480dc35dc1", - * "value": 50, - * "time": "2015-02-14T20:42:30.000Z" - * }, - * { - * "height": 3, - * "address": "a5dfb396d3", - * "hash": "0046a3582fed130ee18c05e7e278992678d46e311465a4af6b787f5c014640a9", - * "short_hash": "0046a3582fed", - * "value": 50, - * "time": "2015-02-14T20:48:43.000Z" - * }, - * ... - */ router.get("/blocks", async (req: PaginatedQuery, res) => { const results = await getBlocks(req.query.limit, req.query.offset, true); returnPaginatedResult(res, "blocks", blockToJson, results); }); - /** - * @api {get} /blocks/latest List latest blocks - * @apiName GetLatestBlocks - * @apiGroup BlockGroup - * @apiVersion 2.0.0 - * - * @apiUse LimitOffset - * - * @apiSuccess {Number} count The count of results. - * @apiUse Blocks - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "count": 50, - * "blocks": [ - * { - * "height": 122225, - * "address": "kre3w0i79j", - * "hash": "1aa36f210f2e07b666646ac7dac3ea972262a6a474419edfc058e4402d40538d", - * "short_hash": "1aa36f210f2e", - * "value": 12, - * "time": "2016-02-02T17:55:35.000Z" - * }, - * { - * "height": 122224, - * "address": "k123456789", - * "hash": "000000f31b3ca2cf166d0ee669cd2ae2be6ea0fc35d1cf1e7b52811ecb358796", - * "short_hash": "000000f31b3c", - * "value": 12, - * "time": "2016-02-01T14:18:47.000Z" - * }, - * ... - */ router.get("/blocks/latest", async (req: PaginatedQuery, res) => { const results = await getBlocks(req.query.limit, req.query.offset); returnPaginatedResult(res, "blocks", blockToJson, results); }); - /** - * @api {get} /blocks/lowest List blocks with the lowest hash - * @apiName GetLowestBlocks - * @apiGroup BlockGroup - * @apiVersion 2.0.0 - * - * @apiUse LimitOffset - * - * @apiSuccess {Number} count The count of results. - * @apiUse Blocks - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "count": 43, - * "blocks": [ - * { - * "height": 110128, - * "address": "k5ztameslf", - * "hash": "000000000000fd42f2c046d9c0f99b6534c1e04a87902ebff7ed4396d1f5b4ea", - * "short_hash": "000000000000", - * "value": 12, - * "time": "2016-01-22T00:09:17.000Z" - * }, - * { - * "height": 113253, - * "address": "k5ztameslf", - * "hash": "000000000001285d349f8781ac4f1d155472178e1150c0eb6a1cf4e441320f2c", - * "short_hash": "000000000001", - * "value": 14, - * "time": "2016-01-24T22:10:49.000Z" - * }, - * ... - */ router.get("/blocks/lowest", async (req: PaginatedQuery, res) => { const results = await getLowestHashes(req.query.limit, req.query.offset); returnPaginatedResult(res, "blocks", blockToJson, results); }); - /** - * @api {get} /blocks/last Get the last block - * @apiName GetLastBlock - * @apiGroup BlockGroup - * @apiVersion 2.0.0 - * - * @apiUse Block - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "block": { - * "height": 122225, - * "address": "kre3w0i79j", - * "hash": "1aa36f210f2e07b666646ac7dac3ea972262a6a474419edfc058e4402d40538d", - * "short_hash": "1aa36f210f2e", - * "value": 12, - * "time": "2016-02-02T17:55:35.000Z" - * } - * } - */ router.get("/blocks/last", async (req, res) => { const block = await ctrlGetLastBlock(); res.json({ @@ -217,27 +52,6 @@ export default (): Router => { }); }); - /** - * - * @api {get} /blocks/value Get the block reward - * @apiName GetBlockValue - * @apiGroup BlockGroup - * @apiVersion 2.0.6 - * - * @apiSuccess {Number} value - The current block reward. - * @apiSuccess {Number} base_value - The base block reward. - * - * @apiDescription Returns the block reward - the base value plus the amount - * of unpaid names (names registered in the last 500 blocks). This - * is how much Krist will be rewarded for mining a block right now. - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "value": 2, - * "base_value": 1 - * } - */ router.get(["/blocks/value", "/blocks/basevalue"], async (req, res) => { const block = await ctrlGetLastBlock(); const blockValue = await getBlockValue(); @@ -249,29 +63,6 @@ export default (): Router => { }); }); - /** - * @api {get} /blocks/:height Get a block - * @apiName GetBlock - * @apiGroup BlockGroup - * @apiVersion 2.0.0 - * - * @apiParam {String} height The height of the block. - * - * @apiUse Block - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "block": { - * "height": 5000, - * "address": "b5591107c4", - * "hash": "0000003797c090eb72d87a391aeedbef89957f9627aea9807870df46eb13a7e3", - * "short_hash": "0000003797c0", - * "value": 50, - * "time": "2015-02-21T11:05:47.000Z" - * } - * } - */ router.get("/blocks/:height", async (req, res) => { const block = await ctrlGetBlock(req.params.height); res.json({ diff --git a/src/webserver/routes/lookup/blocks.ts b/src/webserver/routes/lookup/blocks.ts index 2d10cd2..015a29a 100644 --- a/src/webserver/routes/lookup/blocks.ts +++ b/src/webserver/routes/lookup/blocks.ts @@ -33,54 +33,6 @@ import { export default (): Router => { const router = Router(); - /** - * @api {get} /lookup/blocks Lookup blocks - * @apiName LookupBlocks - * @apiGroup LookupGroup - * @apiVersion 2.1.3 - * - * @apiDescription Return all the blocks. - * - * **WARNING:** The Lookup API is in Beta, and is subject to change at any - * time without warning. - * - * @apiUse LimitOffset - * @apiQuery {String} [orderBy=height] The field to order the - * results by. Must be one of `height`, `address`, `hash`, `value`, - * `time` or `difficulty`. - * @apiQuery {String} [order=ASC] The direction to order - * the results in. Must be one of `ASC` or `DESC`. - * - * @apiSuccess {Number} count The count of results returned. - * @apiSuccess {Number} total The total count of results available. - * @apiUse Blocks - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "count": 20, - * "total": 1397410, - * "blocks": [ - * { - * "height": 101496, - * "address": "k5ztameslf", - * "hash": "00000000224f08def4a2cef05fed91abdf8eb03feb79d80fe2b187487d2ad06b", - * "short_hash": "00000000224f", - * "value": 3013, - * "time": "2016-01-11T22:16:09.000Z", - * "difficulty": 18758 - * }, - * { - * "height": 1187992, - * "address": "kristallie", - * "hash": "00000000004fd4ededc6edc7528c99f10e74cdecd88627a5a98df9431f52473b", - * "short_hash": "00000000004f", - * "value": 152, - * "time": "2020-02-09T04:02:58.000Z", - * "difficulty": 100 - * }, - * ... - */ router.get("/blocks", async (req: LookupQuery, res) => { // Query filtering parameters const limit = validateLimit(req.query.limit); diff --git a/src/webserver/routes/motd.ts b/src/webserver/routes/motd.ts index 97be212..136bd97 100755 --- a/src/webserver/routes/motd.ts +++ b/src/webserver/routes/motd.ts @@ -41,14 +41,8 @@ export default (): Router => { * * @apiSuccess {String} public_url The public URL of this Krist node. * @apiSuccess {String} public_ws_url The public URL of the Websocket gateway. - * @apiSuccess {Boolean} mining_enabled If mining is enabled on the server, - * this will be set to `true`. * @apiSuccess {Boolean} debug_mode If the server is running in debug mode, * this will be set to `true`. - * - * @apiSuccess {Number} work The current Krist work (difficulty). - * @apiSuccess {Object} last_block The last block mined on the Krist node. May - * be `null`. * * @apiSuccess {Object} package Information related to this build of the Krist * source code. @@ -65,20 +59,8 @@ export default (): Router => { * configuration. * @apiSuccess {Number} constants.wallet_version The latest version of * KristWallet. - * @apiSuccess {Number} constants.nonce_max_size The maximum size, in bytes, - * of a block nonce. * @apiSuccess {Number} constants.name_cost The cost, in KST, of purchasing a * new name. - * @apiSuccess {Number} constants.min_work The minimum work (block difficulty) - * value. The work will not automatically go below this. - * @apiSuccess {Number} constants.max_work The maximum work (block difficulty) - * value. The work will not automatically go above this. - * @apiSuccess {Number} constants.work_factor Work adjustment rate per block, - * where 1 means immediate adjustment to target work and 0 means constant - * work. - * @apiSuccess {Number} constants.seconds_per_block The ideal time between - * mined blocks. The Krist server will adjust the difficulty to match this - * value. * * @apiSuccess {Object} currency Constants related to the currency that this * server represents. diff --git a/src/webserver/routes/names.ts b/src/webserver/routes/names.ts index c7dbe48..0b878c7 100755 --- a/src/webserver/routes/names.ts +++ b/src/webserver/routes/names.ts @@ -59,8 +59,7 @@ import { PaginatedQuery, ReqQuery, returnPaginatedResult } from "../utils"; * @apiSuccess {Date} [name.transferred] The time this name was last transferred * to a new owner, as an ISO-8601 string. * @apiSuccess {String} [name.a] The name's data. - * @apiSuccess {Number} name.unpaid The number of blocks until this name has - * been paid off. + * @apiSuccess {Number} name.unpaid Currently unused. */ /** @@ -79,8 +78,7 @@ import { PaginatedQuery, ReqQuery, returnPaginatedResult } from "../utils"; * @apiSuccess {Date} [names.transferred] The time this name was last * transferred to a new owner, as an ISO-8601 string. * @apiSuccess {String} names.a The name's data. - * @apiSuccess {Number} names.unpaid The number of blocks until this name has - * been paid off. + * @apiSuccess {Number} names.unpaid Currently unused. */ export default (): Router => { @@ -131,24 +129,6 @@ export default (): Router => { }); }); - /** - * @api {get} /names/bonus Get the name bonus - * @apiName GetNameBonus - * @apiGroup NameGroup - * @apiVersion 2.0.1 - * - * @apiDescription Returns the amount of KST that is currently added to the - * base block reward. Essentially, this is the count of names registered in - * the last 500 blocks. - * - * @apiSuccess {Number} name_bonus The name bonus. - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "name_bonus": 12 - * } - */ router.get("/names/bonus", async (req, res) => { res.json({ ok: true, @@ -206,15 +186,10 @@ export default (): Router => { * @apiGroup NameGroup * @apiVersion 2.0.0 * - * @apiDescription *Note*: This only returns names that are **unpaid**. An - * name is "paid off" after the submission of 500 blocks after its - * registration. - * * @apiUse LimitOffset * * @apiSuccess {Number} count The count of results. - * @apiSuccess {Number} total The total amount of names registered in the last - * 500 blocks. + * @apiSuccess {Number} total The total amount of new names returned. * @apiUse Names * * @apiSuccessExample {json} Success diff --git a/src/webserver/routes/search/index.ts b/src/webserver/routes/search/index.ts index 60091b8..1e4d433 100644 --- a/src/webserver/routes/search/index.ts +++ b/src/webserver/routes/search/index.ts @@ -50,15 +50,14 @@ export type ReqSearchQuery = LookupQuery<{ * matches the format of a Krist address. * @apiSuccess {Boolean} query.matchName Whether or not the query exactly * matches the format of a Krist name (with or without the `.kst`) suffix. - * @apiSuccess {Boolean} query.matchBlock Whether or not the query exactly - * matches the format of a block ID (with all non-numbers removed). + * @apiSuccess {Boolean} query.matchBlock Currently unused. * @apiSuccess {Boolean} query.matchTransaction Whether or not the query * exactly matches the format of a transaction ID (with all non-numbers * removed). * @apiSuccess {String} query.strippedName The query with the `.kst` suffix * stripped, if it was present. * @apiSuccess {Boolean} query.hasID Whether or not the query looks like an ID - * number (e.g. for blocks or transactions). + * number (e.g. for transactions). * @apiSuccess {Number} [query.cleanID] If hasID is true, this is the query, * sanitised and converted to a number. */ diff --git a/src/webserver/routes/search/search.ts b/src/webserver/routes/search/search.ts index 18abe84..4b02e3a 100644 --- a/src/webserver/routes/search/search.ts +++ b/src/webserver/routes/search/search.ts @@ -74,11 +74,10 @@ export default (): Router => { * @apiVersion 2.8.0 * * @apiDescription Search the Krist network for objects that match the given - * query, including addresses, names, blocks, and transactions. + * query, including addresses, names, and transactions. * * - Addresses are searched by exact address match only * - Names are searched by their name with and without the `.kst` suffix - * - Blocks are searched by ID * - Transactions are searched by ID * * For more advanced transaction searches (by involved addresses and @@ -100,10 +99,7 @@ export default (): Router => { * Name object if the query looked like a valid Krist name (with or without * the `.kst` suffix), and that name exists in the database. Otherwise, if * there is no result, it will be `false`. - * @apiSuccess {Object} matches.exactBlock An exact block match - this will be - * a Block object if the query looked like a valid Krist block ID, and that - * block exists in the database. Otherwise, if there is no result, it will - * be `false`. + * @apiSuccess {Object} matches.exactBlock Currently unused. * @apiSuccess {Object} matches.exactTransaction An exact transaction match - * this will be a Transaction object if the query looked like a valid Krist * transaction ID, and that transaction exists in the database. Otherwise, diff --git a/src/webserver/routes/submission.ts b/src/webserver/routes/submission.ts index 88e3677..93507f2 100755 --- a/src/webserver/routes/submission.ts +++ b/src/webserver/routes/submission.ts @@ -38,72 +38,6 @@ export default (): Router => { // =========================================================================== // API v2 // =========================================================================== - /** - * @api {post} /submit Submit a block - * @apiName SubmitBlock - * @apiGroup BlockGroup - * @apiVersion 2.0.0 - * @apiDeprecated Block submission is currently disabled. - * - * @apiBody {String} address The address to send the reward - * to, if successful. - * @apiBody {String|Number[]} nonce The nonce to submit with. - * - * @apiSuccess {Boolean} success Whether the submission was successful or not. - * @apiSuccess {String} [error] The block submission error (if success was - * `false`). - * @apiSuccess {Number} [work] The new difficulty for block submission (if the - * solution was successful). - * @apiUse Address - * @apiUse Block - * @apiSuccess {Object} [address] The address of the solver (if the solution - * was successful). - * @apiSuccess {Object} [block] The block which was just submitted (if the - * solution was successful). - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "success": true, - * "work": 18750, - * "address": { - * "address": "kre3w0i79j", - * "balance": 925378, - * "totalin": 925378, - * "totalout": 0, - * "firstseen": "2015-03-13T12:55:18.000Z" - * }, - * "block": { - * "height": 122226, - * "address": "kre3w0i79j", - * "hash": "000000007abc9f0cafaa8bf85d19817ee4f5c41ae758de3ad419d62672423ef", - * "short_hash": "000000007ab", - * "value": 14, - * "time": "2016-02-06T19:22:41.746Z" - * } - * } - * - * @apiSuccessExample {json} Solution Incorrect - * { - * "ok": true, - * "success": false, - * "error": "solution_incorrect" - * } - * - * @apiSuccessExample {json} Solution Duplicate - * { - * "ok": true, - * "success": false, - * "error": "solution_duplicate" - * } - * - * @apiErrorExample {json} Invalid Nonce - * { - * "ok": false, - * "error": "invalid_parameter", - * "parameter": "nonce" - * } - */ router.post("/submit", async (req, res) => { try { const result = await ctrlSubmitBlock(req, diff --git a/src/webserver/routes/transactions.ts b/src/webserver/routes/transactions.ts index f051a15..5d09d21 100755 --- a/src/webserver/routes/transactions.ts +++ b/src/webserver/routes/transactions.ts @@ -39,7 +39,7 @@ import { PaginatedQuery, ReqQuery, returnPaginatedResult } from "../utils"; * @apiSuccess {Object} transaction * @apiSuccess {Number} transaction.id The ID of this transaction. * @apiSuccess {String} transaction.from The sender of this transaction. This - * may be `null` if the transaction was a block mining reward. + * may be `null`. * @apiSuccess {String} transaction.to The recipient of this transaction. This * may be `"name"` if the transaction was a name purchase, or `"a"` if it was * a name's data change. @@ -66,7 +66,7 @@ import { PaginatedQuery, ReqQuery, returnPaginatedResult } from "../utils"; * @apiSuccess {Object[]} transactions * @apiSuccess {Number} transactions.id The ID of this transaction. * @apiSuccess {String} transactions.from The sender of this transaction. This - * may be `null` if the transaction was a block mining reward. + * may be `null`. * @apiSuccess {String} transactions.to The recipient of this transaction. This * may be `"name"` if the transaction was a name purchase, or `"a"` if it was * a name's data change. diff --git a/src/webserver/routes/websockets.ts b/src/webserver/routes/websockets.ts index 0e53b46..0607c36 100644 --- a/src/webserver/routes/websockets.ts +++ b/src/webserver/routes/websockets.ts @@ -94,7 +94,7 @@ export default (): Router => { * * Authed Sessions * * A **guest session** is a session without a privatekey. It has access to - * basic API calls such as getters and submitblock. + * basic API calls such as `address`. * * An **authed session** is a session linked to an address. The privatekey is * supplied as a POST body parameter during `/ws/start`. It has access to most @@ -136,9 +136,8 @@ export default (): Router => { * { * "ok": "true", * "type": "event", - * "event": "block", - * "block": { ... }, - * "new_work": 100000 + * "event": "transaction", + * "transaction": { ... } * } * ``` * @@ -149,8 +148,6 @@ export default (): Router => { * * | Subscription Name | Events | Description | * | ----------------- | ------------- | ----------------------------------------------------------------------------------------- | - * | `blocks` | `block` | Block events whenever a block is mined by anybody on the node. | - * | `ownBlocks` | `block` | Block events whenever the authed user mines a block. | * | `transactions` | `transaction` | Transaction events whenever a transaction is made by anybody on the node. | * | `ownTransactions` | `transaction` | Transaction events whenever a transaction is made to or from the authed user. | * | `names` | `name` | Name events whenever a name is purchased, modified or transferred by anybody on the node. | diff --git a/src/webserver/routes/work.ts b/src/webserver/routes/work.ts index 3622759..3898dec 100755 --- a/src/webserver/routes/work.ts +++ b/src/webserver/routes/work.ts @@ -34,20 +34,6 @@ export default (): Router => { // =========================================================================== // API v2 // =========================================================================== - /** - * @api {get} /work Get the current work - * @apiName GetWork - * @apiGroup MiscellaneousGroup - * @apiVersion 2.0.5 - * - * @apiSuccess {Number} work The current Krist work (difficulty). - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "work": 18750 - * } - */ router.get("/work", async (req, res) => { res.json({ ok: true, @@ -55,21 +41,6 @@ export default (): Router => { }); }); - /** - * @api {get} /work/day Get the work over the past 24 hours - * @apiName GetWorkDay - * @apiGroup MiscellaneousGroup - * @apiVersion 2.0.5 - * - * @apiSuccess {Number[]} work The work every minute for the past 24 hours, - * starting with 24 hours ago. - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "work": [18750, 19250, ...] - * } - */ router.get("/work/day", async (req, res) => { res.json({ ok: true, @@ -77,41 +48,6 @@ export default (): Router => { }); }); - /** - * @api {get} /work/detailed Get detailed work and block value information - * @apiName GetWorkDetailed - * @apiGroup MiscellaneousGroup - * @apiVersion 2.6.0 - * - * @apiSuccess {Number} work The current Krist work (difficulty). - * @apiSuccess {Number} unpaid The current number of unpaid names. - * - * @apiSuccess {Number} base_value The base block value. - * @apiSuccess {Number} block_value The current block value (base + unpaid). - * - * @apiSuccess {Object} decrease Information about the next block value - * decrease. - * @apiSuccess {Number} decrease[value] How much Krist the block value will - * decrease by when the next name(s) expire. - * @apiSuccess {Number} decrease[blocks] How many blocks before the next block - * value decrease. - * @apiSuccess {Number} decrease[reset] How many blocks before the block value - * will completely reset to the base value. - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "work": 92861, - * "unpaid": 3, - * "base_value": 1, - * "block_value": 4, - * "decrease": { - * "value": 2, - * "blocks": 496, - * "reset": 500 - * } - * } - */ router.get("/work/detailed", async (req, res) => { const lastBlock = await getLastBlock(); if (!lastBlock) throw new ErrorBlockNotFound(); diff --git a/src/websockets/routes/submission.ts b/src/websockets/routes/submission.ts index 24c013c..6b2458f 100644 --- a/src/websockets/routes/submission.ts +++ b/src/websockets/routes/submission.ts @@ -29,60 +29,6 @@ import { ErrorMissingParameter, ErrorSolutionDuplicate, ErrorSolutionIncorrect } from "../../errors"; -/** - * @api {ws} /type/submit_block Submit a block - * @apiName WSSubmitBlock - * @apiGroup WebsocketGroup - * @apiVersion 2.0.8 - * @apiDeprecated Block submission is currently disabled. - * - * @apiBody {Number} id - * @apiBody {String="submit_block"} type - * @apiBody {String} [address] - * @apiBody {String|Number[]} nonce - * - * @apiSuccess {Boolean} success Whether the submission was successful or not. - * @apiSuccess {Number} [work] The new difficulty for block submission (if the solution was successful). - * @apiUse Address - * @apiUse Block - * @apiSuccess {Object} [address] The address of the solver (if the solution was successful). - * @apiSuccess {Object} [block] The block which was just submitted (if the solution was successful). - * - * @apiSuccessExample {json} Success - * { - * "ok": true, - * "success": true, - * "work": 18750, - * "address": { - * "address": "kre3w0i79j", - * "balance": 925378, - * "totalin": 925378, - * "totalout": 0, - * "firstseen": "2015-03-13T12:55:18.000Z" - * }, - * "block": { - * "height": 122226, - * "address": "kre3w0i79j", - * "hash": "000000007abc9f0cafaa8bf85d19817ee4f5c41ae758de3ad419d62672423ef", - * "short_hash": "000000007ab", - * "value": 14, - * "time": "2016-02-06T19:22:41.746Z" - * } - * } - * - * @apiSuccessExample {json} Solution Incorrect - * { - * "ok": true, - * "success": false - * } - * - * @apiErrorExample {json} Invalid Nonce - * { - * "ok": false, - * "error": "invalid_parameter", - * "parameter": "nonce" - * } - */ export const wsSubmitBlock: WebSocketEventHandler<{ address?: string; nonce?: number[] | string; diff --git a/static/style.css b/static/style.css index ff3f15b..f3e37f1 100755 --- a/static/style.css +++ b/static/style.css @@ -161,8 +161,9 @@ p:last-child { text-align: left; font-weight: 300; font-size: 75%; - opacity: 50%; + opacity: 65%; max-width: 24rem; + line-height: 1.3; } b { diff --git a/views/home.hbs b/views/home.hbs index 79cd3d6..f758b95 100644 --- a/views/home.hbs +++ b/views/home.hbs @@ -21,7 +21,15 @@

-

Privacy Disclaimer

+

Disclaimer

+

+ It should be noted that Krist does not use a block-chain, or any similar + technology. Krist is not a "cryptocurrency". Krist is a centralized-database + economy system for Minecraft servers. +

+ +

+

Privacy

The only PII that the Krist server stores is your IP address, User-Agent and Origin, as part of the webserver logs. This information is automatically diff --git a/whats-new.json b/whats-new.json index c300c1e..f500d4b 100644 --- a/whats-new.json +++ b/whats-new.json @@ -4,10 +4,6 @@ "date": "2023-03-22T21:30:30+00:00", "new": true, "body": "The websocket gateway returned by `/ws/start` is now `wss://ws.krist.dev`. You should connect to the URL returned by `/ws/start` instead of hardcoding the URL." - }, { - "commitHash": "2fdb8f64e0cb81b08e825858369b1458d119f042", - "date": "2022-07-19T21:52:31+01:00", - "body": "Block submission is now disabled." }, { "commitHash": "a7e1844f85ade36f5f7c8487713ed2e03caf0315", "date": "2022-07-17T19:37:00+01:00",