This repository has been archived by the owner on Jun 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 458
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
♻️ Update plugin to follow new application architecture (#6835)
- Loading branch information
Showing
30 changed files
with
630 additions
and
541 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
framework-plugins/lisk-framework-faucet-plugin/src/plugin/endpoint.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * Copyright © 2021 Lisk Foundation | ||
| * | ||
| * See the LICENSE file at the top-level directory of this distribution | ||
| * for licensing information. | ||
| * | ||
| * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation, | ||
| * no part of this software, including this file, may be copied, modified, | ||
| * propagated, or distributed except according to the terms contained in the | ||
| * LICENSE file. | ||
| * | ||
| * Removal or modification of this copyright notice is prohibited. | ||
| */ | ||
|
|
||
| import axios from 'axios'; | ||
| import { | ||
| decryptPassphraseWithPassword, | ||
| getAddressAndPublicKeyFromPassphrase, | ||
| parseEncryptedPassphrase, | ||
| } from '@liskhq/lisk-cryptography'; | ||
| import { LiskValidationError, validator } from '@liskhq/lisk-validator'; | ||
| import { BasePluginEndpoint, PluginEndpointContext } from 'lisk-framework'; | ||
| import { convertLSKToBeddows } from '@liskhq/lisk-transactions'; | ||
| import { APIClient } from '@liskhq/lisk-api-client'; | ||
| import { authorizeParamsSchema, fundParamsSchema } from './schemas'; | ||
| import { FaucetPluginConfig, State } from './types'; | ||
|
|
||
| export class Endpoint extends BasePluginEndpoint { | ||
| private _state: State = { publicKey: undefined, passphrase: undefined }; | ||
| private _client!: APIClient; | ||
| private _config!: FaucetPluginConfig; | ||
|
|
||
| public init(state: State, apiClient: APIClient, config: FaucetPluginConfig) { | ||
| this._state = state; | ||
| this._client = apiClient; | ||
| this._config = config; | ||
| } | ||
| // eslint-disable-next-line @typescript-eslint/require-await | ||
| public async authorize(context: PluginEndpointContext): Promise<{ result: string }> { | ||
| const errors = validator.validate(authorizeParamsSchema, context.params); | ||
|
|
||
| if (errors.length) { | ||
| throw new LiskValidationError(errors); | ||
| } | ||
|
|
||
| const { enable, password } = context.params; | ||
|
|
||
| try { | ||
| const parsedEncryptedPassphrase = parseEncryptedPassphrase(this._config.encryptedPassphrase); | ||
|
|
||
| const passphrase = decryptPassphraseWithPassword( | ||
| parsedEncryptedPassphrase, | ||
| password as string, | ||
| ); | ||
|
|
||
| const { publicKey } = getAddressAndPublicKeyFromPassphrase(passphrase); | ||
|
|
||
| this._state.publicKey = enable ? publicKey : undefined; | ||
| this._state.passphrase = enable ? passphrase : undefined; | ||
| const changedState = enable ? 'enabled' : 'disabled'; | ||
|
|
||
| return { | ||
| result: `Successfully ${changedState} the faucet.`, | ||
| }; | ||
| } catch (error) { | ||
| throw new Error('Password given is not valid.'); | ||
| } | ||
| } | ||
|
|
||
| public async fundTokens(context: PluginEndpointContext): Promise<{ result: string }> { | ||
| const errors = validator.validate(fundParamsSchema, context.params); | ||
| const { address, token } = context.params; | ||
|
|
||
| if (errors.length) { | ||
| throw new LiskValidationError(errors); | ||
| } | ||
|
|
||
| if (!this._state.publicKey || !this._state.passphrase) { | ||
| throw new Error('Faucet is not enabled.'); | ||
| } | ||
|
|
||
| const captchaResult = await axios({ | ||
| method: 'post', | ||
| url: 'https://www.google.com/recaptcha/api/siteverify', | ||
| params: { | ||
| secret: this._config.captchaSecretkey, | ||
| response: token, | ||
| }, | ||
| }); | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access | ||
| if (!captchaResult?.data?.success) { | ||
| throw new Error('Captcha response was invalid.'); | ||
| } | ||
|
|
||
| await this._transferFunds(address as string); | ||
|
|
||
| return { | ||
| result: `Successfully funded account at address: ${address as string}.`, | ||
| }; | ||
| } | ||
|
|
||
| private async _transferFunds(address: string): Promise<void> { | ||
| const transferTransactionParams = { | ||
| amount: BigInt(convertLSKToBeddows(this._config.amount)), | ||
| recipientAddress: Buffer.from(address, 'hex'), | ||
| data: '', | ||
| }; | ||
|
|
||
| const transaction = await this._client.transaction.create( | ||
| { | ||
| moduleID: 2, | ||
| commandID: 0, | ||
| senderPublicKey: this._state.publicKey as Buffer, | ||
| fee: BigInt(convertLSKToBeddows(this._config.fee)), // TODO: The static fee should be replaced by fee estimation calculation | ||
| params: transferTransactionParams, | ||
| }, | ||
| this._state.passphrase as string, | ||
| ); | ||
|
|
||
| await this._client.transaction.send(transaction); | ||
| } | ||
| } |
Oops, something went wrong.