This repository has been archived by the owner on Apr 21, 2023. It is now read-only.
forked from SpiderBTT/NanoWallet-1
-
Notifications
You must be signed in to change notification settings - Fork 13
[node-rewards-program] task: add service to communicate with API #679
Merged
AnthonyLaw
merged 12 commits into
node-rewards-program
from
feat/init-node-rewards-program-service
Jun 28, 2022
Merged
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
153f5d8
[node-rewards-program] task: add service
OlegMakarenko 2abefc0
[node-rewards-program] fix: typo in error message
OlegMakarenko 53fe266
[node-rewards-program] fix: typo in class name
OlegMakarenko 040a98e
[node-rewards-program] task: add tests
OlegMakarenko 763769e
[node-rewards-program] fix: fetch mock, improve prepareEnrollTransact…
OlegMakarenko e08e6c5
[node-rewards-program] feat: add getNodePayouts() and getNodeInfo() m…
OlegMakarenko 1f1ba29
[node-rewards-program] fix: typo in jsdoc
OlegMakarenko cd63ec3
[node-rewards-program] fix: test comments
OlegMakarenko 6cef4de
[node-rewards-program] fix: remove whitespaces
OlegMakarenko 90991f3
[node-rewards-program] task: refactor fetch requests
OlegMakarenko 75927ff
[node-rewards-program] task: refactor the enrollment and error tests,…
OlegMakarenko d9baab0
[node-rewards-program] task: update codeword test, fix runPromiseErro…
OlegMakarenko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
import nem from 'nem-sdk'; | ||
|
||
const NODE_REWARDS_PROGRAM_API_BASE_URL = 'https://supernodesapi.nem.io'; | ||
|
||
/** Service to enroll in the Node Rewards Program and to get the status related information */ | ||
class nodeRewardsProgram { | ||
|
||
/** | ||
* Initialize dependencies and properties | ||
* | ||
* @params {services} - Angular services to inject | ||
*/ | ||
constructor($localStorage, $filter, Wallet) { | ||
'ngInject'; | ||
|
||
// Service dependencies region // | ||
|
||
this._storage = $localStorage; | ||
this._$filter = $filter; | ||
this._Wallet = Wallet; | ||
|
||
// End dependencies region // | ||
|
||
// Service properties region // | ||
|
||
this.apiBaseUrl = NODE_REWARDS_PROGRAM_API_BASE_URL; | ||
this.common = nem.model.objects.get('common'); | ||
|
||
// End properties region // | ||
} | ||
|
||
// Service methods region // | ||
|
||
/** | ||
* Prepare the enroll transaction | ||
* | ||
* @param {string} mainPublicKey - Delegated harvesting public key. | ||
* @param {string} host - IP or domain of the node. | ||
* @param {string} enrollmentAddress - Node Rewards Program enrollment address. | ||
* @param {string} [multisigAccountAddress] - Multisig account address. For multisig enrollment only. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why square brackets? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is an optional parameter, according to the JSDoc syntax. |
||
* | ||
* @return {Promise<object>} - Prepared enroll transaction | ||
*/ | ||
async prepareEnrollTransaction(mainPublicKey, host, enrollmentAddress, multisigAccountAddress) { | ||
// Create a new transaction object | ||
const transferTransaction = nem.model.objects.get('transferTransaction'); | ||
|
||
// Set enrollment address as recipient | ||
transferTransaction.recipient = enrollmentAddress.toUpperCase().replace(/-/g, ''); | ||
|
||
// Set multisig, if selected | ||
if (multisigAccountAddress) { | ||
transferTransaction.isMultisig = true; | ||
transferTransaction.multisigAccount = multisigAccountAddress.toUpperCase().replace(/-/g, ''); | ||
} | ||
Jaguar0625 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
// Set the message | ||
const hash = await this.getEnrollmentHash(mainPublicKey); | ||
transferTransaction.message = `enroll ${host} ${hash}`; | ||
|
||
// Set no mosaics | ||
transferTransaction.mosaics = null; | ||
|
||
return nem.model.transactions.prepare('transferTransaction')(this.common, transferTransaction, this._Wallet.network); | ||
} | ||
|
||
/** | ||
* Checks if an address is the current enrollment address. | ||
* | ||
* @param {string} address - Address to check. | ||
* | ||
* @return {Promise<boolean>} - If the address to check matches the current enrollment address. | ||
*/ | ||
async checkEnrollmentAddress(address) { | ||
const response = await fetch(this.apiBaseUrl + `/enrollment/check/address/${address}`); | ||
Jaguar0625 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
if (!response.ok) { | ||
throw Error('failed_to_validate_enroll_address'); | ||
} | ||
Jaguar0625 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
const status = await response.text(); | ||
|
||
return status === 'true'; | ||
} | ||
|
||
/** | ||
* Checks if a signer public key is enrolled in the current period. | ||
* | ||
* @param {string} publicKey - Delegated harvesting public key to check. | ||
* | ||
* @return {Promise<boolean>} - If the public key is enrolled in the current period. | ||
*/ | ||
async checkEnrollmentStatus(publicKey) { | ||
try { | ||
const successEnrollmentResponse = await fetch(this.apiBaseUrl + `/enrollment/successes/${publicKey}?count=1`); | ||
|
||
const successEnrollments = await successEnrollmentResponse.json(); | ||
|
||
if (successEnrollments.length === 0) { | ||
return false; | ||
} | ||
|
||
const latestSuccessEnrollment = successEnrollments[0]; | ||
const enrollAddress = latestSuccessEnrollment.recipientAddress; | ||
|
||
return this.checkEnrollAddress(enrollAddress); | ||
} | ||
catch { | ||
throw Error('failed_to_get_enroll_status'); | ||
} | ||
} | ||
|
||
/** | ||
* Gets codeword dependent hash for the current period given a public key. | ||
* | ||
* @param {string} publicKey - Signer public key to use in hash calculation. | ||
* | ||
* @return {Promise<string>} - The result of keccak_256(codeword || public_key) as a hex string, which should be used in enrollment messages. | ||
Jaguar0625 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
*/ | ||
async getEnrollmentHash(publicKey) { | ||
const response = await fetch(this.apiBaseUrl + `/codeword/${publicKey}`); | ||
|
||
if (!response.ok) { | ||
throw Error('failed_to_get_enroll_hash'); | ||
} | ||
|
||
return await response.text(); | ||
} | ||
|
||
// End methods region // | ||
} | ||
|
||
export default nodeRewardsProgram; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we apply a PascalCase since it's a class? (Capitalize the first letter)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.