Skip to content

Commit

Permalink
signIn docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
samgermain committed Jun 8, 2022
1 parent e1e1be5 commit 167ffef
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 0 deletions.
7 changes: 7 additions & 0 deletions js/btctradeua.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@ module.exports = class btctradeua extends Exchange {
}

async signIn (params = {}) {
/**
* @method
* @name btctradeua#signIn
* @description sign in, must be called prior to using other authenticated methods
* @param {dict} params extra parameters specific to the btctradeua api endpoint
* @returns response from exchange
*/
return await this.privatePostAuth (params);
}

Expand Down
7 changes: 7 additions & 0 deletions js/ndax.js
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,13 @@ module.exports = class ndax extends Exchange {
}

async signIn (params = {}) {
/**
* @method
* @name ndax#signIn
* @description sign in, must be called prior to using other authenticated methods
* @param {dict} params extra parameters specific to the ndax api endpoint
* @returns response from exchange
*/
this.checkRequiredCredentials ();
if (this.login === undefined || this.password === undefined) {
throw new AuthenticationError (this.id + ' signIn() requires exchange.login, exchange.password');
Expand Down
7 changes: 7 additions & 0 deletions js/probit.js
Original file line number Diff line number Diff line change
Expand Up @@ -1435,6 +1435,13 @@ module.exports = class probit extends Exchange {
}

async signIn (params = {}) {
/**
* @method
* @name probit#signIn
* @description sign in, must be called prior to using other authenticated methods
* @param {dict} params extra parameters specific to the probit api endpoint
* @returns response from exchange
*/
this.checkRequiredCredentials ();
const request = {
'grant_type': 'client_credentials', // the only supported value
Expand Down
7 changes: 7 additions & 0 deletions js/wavesexchange.js
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,13 @@ module.exports = class wavesexchange extends Exchange {
}

async signIn (params = {}) {
/**
* @method
* @name wavesexchange#signIn
* @description sign in, must be called prior to using other authenticated methods
* @param {dict} params extra parameters specific to the wavesexchange api endpoint
* @returns response from exchange
*/
if (!this.safeString (this.options, 'accessToken')) {
const prefix = 'ffffff01';
const expiresDelta = 60 * 60 * 24 * 7;
Expand Down

0 comments on commit 167ffef

Please sign in to comment.