ontology-ts-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"scrypt" | ontology-ts-sdk</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">ontology-ts-sdk</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="_scrypt_.html">"scrypt"</a> </li> </ul> <h1>External module "scrypt"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-kind-icon">Scrypt<wbr>Params</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#checkctrdecrypted" class="tsd-kind-icon">check<wbr>Ctr<wbr>Decrypted</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#checkecbdecrypted" class="tsd-kind-icon">check<wbr>Ecb<wbr>Decrypted</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#decryptwithctr" class="tsd-kind-icon">decrypt<wbr>With<wbr>Ctr</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#decryptwithecb" class="tsd-kind-icon">decrypt<wbr>With<wbr>Ecb</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#decryptwithgcm" class="tsd-kind-icon">decrypt<wbr>With<wbr>Gcm</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#encryptwithctr" class="tsd-kind-icon">encrypt<wbr>With<wbr>Ctr</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#encryptwithecb" class="tsd-kind-icon">encrypt<wbr>With<wbr>Ecb</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_scrypt_.html#encryptwithgcm" class="tsd-kind-icon">encrypt<wbr>With<wbr>Gcm</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_scrypt_.html#scrypt" class="tsd-kind-icon">scrypt</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="checkctrdecrypted" class="tsd-anchor"></a> <h3>check<wbr>Ctr<wbr>Decrypted</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">check<wbr>Ctr<wbr>Decrypted<span class="tsd-signature-symbol">(</span>saltOrAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, publicKeyEncoded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L184">scrypt.ts:184</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Checks if the password supplied to decrypt was correct.</p> </div> <p>This method was taken out from decrypt, because it needs to create public key from private key and it needs to be supplied from outside.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>saltOrAddress: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>4 hex encoded bytes salt or Address object</p> </div> </li> <li> <h5>publicKeyEncoded: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Public key from decrypted key</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="checkecbdecrypted" class="tsd-anchor"></a> <h3>check<wbr>Ecb<wbr>Decrypted</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">check<wbr>Ecb<wbr>Decrypted<span class="tsd-signature-symbol">(</span>encryptedKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, decryptedKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKeyEncoded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L303">scrypt.ts:303</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Checks if the password supplied to decrypt was correct.</p> </div> <p>This method was taken out from decrypt, because it needs to create public key from private key and it needs to be supplied from outside.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>encryptedKey: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Original encrypted key</p> </div> </li> <li> <h5>decryptedKey: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Decrypted key with decrypt</p> </div> </li> <li> <h5>publicKeyEncoded: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Public key from decrypted key</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="decryptwithctr" class="tsd-anchor"></a> <h3>decrypt<wbr>With<wbr>Ctr</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Ctr<span class="tsd-signature-symbol">(</span>encryptedKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, saltOrAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, scryptParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L121">scrypt.ts:121</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Decrypt with aes-ctr</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>encryptedKey: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>encrypted private key</p> </div> </li> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>user's password to encrypt private key</p> </div> </li> <li> <h5>saltOrAddress: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>4 hex encoded bytes salt or Address object</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scryptParams: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol"> = DEFAULT_SCRYPT</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="decryptwithecb" class="tsd-anchor"></a> <h3>decrypt<wbr>With<wbr>Ecb</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Ecb<span class="tsd-signature-symbol">(</span>encryptedKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scryptParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L262">scrypt.ts:262</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Decrypt with aes-ecb</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>encryptedKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scryptParams: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol"> = DEFAULT_SCRYPT</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="decryptwithgcm" class="tsd-anchor"></a> <h3>decrypt<wbr>With<wbr>Gcm</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Gcm<span class="tsd-signature-symbol">(</span>encrypted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scryptParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L366">scrypt.ts:366</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Decrypt with aes-256-gcm</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>encrypted: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Encrypted private key</p> </div> </li> <li> <h5>address: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>Address to decrypt with</p> </div> </li> <li> <h5>salt: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Salt to decrypt with</p> </div> </li> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>User's password</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scryptParams: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol"> = DEFAULT_SCRYPT</span></h5> <div class="tsd-comment tsd-typography"> <p>Optioanl params to decrypt with</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="encryptwithctr" class="tsd-anchor"></a> <h3>encrypt<wbr>With<wbr>Ctr</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Ctr<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKeyEncoded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scryptParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L67">scrypt.ts:67</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Encrypt with aes-ctr</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>privateKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>publicKeyEncoded: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scryptParams: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol"> = DEFAULT_SCRYPT</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="encryptwithecb" class="tsd-anchor"></a> <h3>encrypt<wbr>With<wbr>Ecb</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Ecb<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKeyEncoded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scryptParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L228">scrypt.ts:228</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Encrypt with aes-ecb</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>privateKey: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>publicKeyEncoded: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scryptParams: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol"> = DEFAULT_SCRYPT</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="encryptwithgcm" class="tsd-anchor"></a> <h3>encrypt<wbr>With<wbr>Gcm</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Gcm<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scryptParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L332">scrypt.ts:332</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Encrypt with aes-gcm-256 This is the default encryption algorithm for private key</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>privateKey: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Private key to encpryt with</p> </div> </li> <li> <h5>address: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>Adderss to encrypt with</p> </div> </li> <li> <h5>salt: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Salt to encrypt with</p> </div> </li> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>User's password</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> scryptParams: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol"> = DEFAULT_SCRYPT</span></h5> <div class="tsd-comment tsd-typography"> <p>Optional params to encrypt</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="scrypt" class="tsd-anchor"></a> <h3>scrypt</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">scrypt<span class="tsd-signature-symbol">(</span>keyphrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, addressHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/scrypt.ts#L45">scrypt.ts:45</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Synchronious call to scrypt-async-js.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>keyphrase: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Keyphrase to use</p> </div> </li> <li> <h5>addressHash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Hex encoded address</p> </div> </li> <li> <h5>params: <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-signature-type">ScryptParams</a></h5> <div class="tsd-comment tsd-typography"> <p>Scrypt params</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="_scrypt_.html">"scrypt"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_scrypt_.scryptparams.html" class="tsd-kind-icon">Scrypt<wbr>Params</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#checkctrdecrypted" class="tsd-kind-icon">check<wbr>Ctr<wbr>Decrypted</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#checkecbdecrypted" class="tsd-kind-icon">check<wbr>Ecb<wbr>Decrypted</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#decryptwithctr" class="tsd-kind-icon">decrypt<wbr>With<wbr>Ctr</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#decryptwithecb" class="tsd-kind-icon">decrypt<wbr>With<wbr>Ecb</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#decryptwithgcm" class="tsd-kind-icon">decrypt<wbr>With<wbr>Gcm</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#encryptwithctr" class="tsd-kind-icon">encrypt<wbr>With<wbr>Ctr</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#encryptwithecb" class="tsd-kind-icon">encrypt<wbr>With<wbr>Ecb</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_scrypt_.html#encryptwithgcm" class="tsd-kind-icon">encrypt<wbr>With<wbr>Gcm</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_scrypt_.html#scrypt" class="tsd-kind-icon">scrypt</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>