From ea01cbf904cfba6e879bdc8ac45bd4e36a8dfb4c Mon Sep 17 00:00:00 2001 From: Reed Rosenbluth Date: Wed, 1 Jul 2020 10:04:04 -0600 Subject: [PATCH] docs: rebuild to fix missing links --- README.md | 2 +- docs/classes/blockstacknetwork.html | 1328 +++++++++++++++++++ docs/classes/nodecryptoaescipher.html | 337 +++++ docs/classes/nodecryptohmacsha256.html | 277 ++++ docs/classes/nodecryptopbkdf2.html | 286 ++++ docs/classes/nodecryptoripemd160digest.html | 274 ++++ docs/classes/nodecryptosha2hash.html | 270 ++++ docs/classes/ripemd160polyfilldigest.html | 217 +++ docs/classes/webcryptoaescipher.html | 320 +++++ docs/classes/webcryptohmacsha256.html | 277 ++++ docs/classes/webcryptopartialpbkdf2.html | 286 ++++ docs/classes/webcryptopbkdf2.html | 286 ++++ docs/classes/webcryptosha2hash.html | 276 ++++ docs/interfaces/accountproofinfo.html | 239 ++++ docs/interfaces/accounttokens.html | 197 +++ docs/interfaces/aescipher.html | 262 ++++ docs/interfaces/encryptcontentoptions.html | 289 ++++ docs/interfaces/encryptionoptions.html | 262 ++++ docs/interfaces/hmac.html | 220 +++ docs/interfaces/huberrordetails.html | 229 ++++ docs/interfaces/nodecryptolib.html | 211 +++ docs/interfaces/pbkdf2.html | 230 ++++ docs/interfaces/priceinfo.html | 211 +++ docs/interfaces/ripemd160digest.html | 217 +++ docs/interfaces/sha2hash.html | 219 +++ docs/interfaces/transactioninfo.html | 201 +++ docs/interfaces/uploadresponse.html | 211 +++ docs/interfaces/utxo.html | 239 ++++ docs/interfaces/webcryptolib.html | 211 +++ 29 files changed, 8083 insertions(+), 1 deletion(-) create mode 100644 docs/classes/blockstacknetwork.html create mode 100644 docs/classes/nodecryptoaescipher.html create mode 100644 docs/classes/nodecryptohmacsha256.html create mode 100644 docs/classes/nodecryptopbkdf2.html create mode 100644 docs/classes/nodecryptoripemd160digest.html create mode 100644 docs/classes/nodecryptosha2hash.html create mode 100644 docs/classes/ripemd160polyfilldigest.html create mode 100644 docs/classes/webcryptoaescipher.html create mode 100644 docs/classes/webcryptohmacsha256.html create mode 100644 docs/classes/webcryptopartialpbkdf2.html create mode 100644 docs/classes/webcryptopbkdf2.html create mode 100644 docs/classes/webcryptosha2hash.html create mode 100644 docs/interfaces/accountproofinfo.html create mode 100644 docs/interfaces/accounttokens.html create mode 100644 docs/interfaces/aescipher.html create mode 100644 docs/interfaces/encryptcontentoptions.html create mode 100644 docs/interfaces/encryptionoptions.html create mode 100644 docs/interfaces/hmac.html create mode 100644 docs/interfaces/huberrordetails.html create mode 100644 docs/interfaces/nodecryptolib.html create mode 100644 docs/interfaces/pbkdf2.html create mode 100644 docs/interfaces/priceinfo.html create mode 100644 docs/interfaces/ripemd160digest.html create mode 100644 docs/interfaces/sha2hash.html create mode 100644 docs/interfaces/transactioninfo.html create mode 100644 docs/interfaces/uploadresponse.html create mode 100644 docs/interfaces/utxo.html create mode 100644 docs/interfaces/webcryptolib.html diff --git a/README.md b/README.md index 900f1885..6a190df6 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ To securely use the latest distribution of blockstack.js from a CDN, use the fol ```html - + ``` diff --git a/docs/classes/blockstacknetwork.html b/docs/classes/blockstacknetwork.html new file mode 100644 index 00000000..b5dad5ec --- /dev/null +++ b/docs/classes/blockstacknetwork.html @@ -0,0 +1,1328 @@ + + + + + + BlockstackNetwork | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BlockstackNetwork

+
+
+
+
+
+
+
+
+
+

Use the methods in class to build third-party wallets or in DApps that register names.

+
+
+
+
+

Hierarchy

+
    +
  • + BlockstackNetwork +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new BlockstackNetwork(apiUrl: string, broadcastServiceUrl: string, bitcoinAPI: BitcoinNetwork, network?: Network): BlockstackNetwork
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      apiUrl: string
      +
      • +
    • +
      broadcastServiceUrl: string
      +
      • +
    • +
      bitcoinAPI: BitcoinNetwork
      +
      • +
    • +
      Default value network: Network = networks.bitcoin
      +
      • +
    +

    Returns BlockstackNetwork

    +
    • +
+
+
+
+

Properties

+
+ +

DUST_MINIMUM

+
DUST_MINIMUM: number
+ +
+
+ +

MAGIC_BYTES

+
MAGIC_BYTES: string
+ +
+
+ +

blockstackAPIUrl

+
blockstackAPIUrl: string
+ +
+
+ +

broadcastServiceUrl

+
broadcastServiceUrl: string
+ +
+
+ +

btc

+
btc: BitcoinNetwork
+ +
+
+ +

excludeUtxoSet

+
excludeUtxoSet: UTXO[]
+ +
+
+ +

includeUtxoMap

+
includeUtxoMap: object
+ +
+

Type declaration

+
    +
  • +
    [address: string]: UTXO[]
    +
    • +
+
+
+
+
+

Methods

+
+ +

Private broadcastNameRegistration

+
    +
  • broadcastNameRegistration(preorderTransaction: string, registerTransaction: string, zoneFile: string): Promise<any>
    • +
+
    +
  • + +
    +
    +

    Sends the preorder and registration transactions and zone file + for a Blockstack name registration along with the to the transaction + broadcast service.

    +
    +

    The transaction broadcast:

    +
      +
    • immediately broadcasts the preorder transaction
      • +
    • broadcasts the register transactions after the preorder transaction + has an appropriate number of confirmations
      • +
    • broadcasts the zone file to the Atlas network after the register transaction + has an appropriate number of confirmations
      • +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      preorderTransaction: string
      +
      +

      the hex-encoded, signed preorder transaction generated + using the makePreorder function

      +
      +
      • +
    • +
      registerTransaction: string
      +
      +

      the hex-encoded, signed register transaction generated + using the makeRegister function

      +
      +
      • +
    • +
      zoneFile: string
      +
      +

      the zone file to be broadcast to the Atlas network

      +
      +
      • +
    +

    Returns Promise<any>

    +

    Returns a Promise that resolves to an object with a + transaction_hash key containing the transaction hash of the broadcasted transaction.

    +

    In the event of an error, it rejects with:

    +
      +
    • a RemoteServiceError if there is a problem + with the transaction broadcast service
      • +
    • MissingParameterError if you call the function without a required + parameter
      • +
    +
    • +
+
+
+ +

Private broadcastServiceFetchHelper

+
    +
  • broadcastServiceFetchHelper(endpoint: string, body: any): Promise<any | Error>
    • +
+
    +
  • + +
    +
    +

    Performs a POST request to the given URL. This is intended for + use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      endpoint: string
      +
      +

      the name of

      +
      +
      • +
    • +
      body: any
      +
      • +
    +

    Returns Promise<any | Error>

    +

    Returns a Promise that resolves to the object requested. + In the event of an error, it rejects with:

    +
      +
    • a RemoteServiceError if there is a problem + with the transaction broadcast service
      • +
    • MissingParameterError if you call the function without a required + parameter
      • +
    +
    • +
+
+
+ +

Private broadcastTransaction

+
    +
  • broadcastTransaction(transaction: string, transactionToWatch?: string, confirmations?: number): Promise<any>
    • +
+
    +
  • + +
    +
    +

    Broadcasts a signed bitcoin transaction to the network optionally waiting to broadcast the + transaction until a second transaction has a certain number of confirmations.

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      transaction: string
      +
      +

      the hex-encoded transaction to broadcast

      +
      +
      • +
    • +
      Default value transactionToWatch: string = null
      +
      +

      the hex transaction id of the transaction to watch for + the specified number of confirmations before broadcasting the transaction

      +
      +
      • +
    • +
      Default value confirmations: number = 6
      +
      +

      the number of confirmations transactionToWatch must have + before broadcasting transaction.

      +
      +
      • +
    +

    Returns Promise<any>

    +

    Returns a Promise that resolves to an object with a + transaction_hash key containing the transaction hash of the broadcasted transaction.

    +

    In the event of an error, it rejects with:

    +
      +
    • a RemoteServiceError if there is a problem + with the transaction broadcast service
      • +
    • MissingParameterError if you call the function without a required + parameter
      • +
    +
    • +
+
+
+ +

Private broadcastZoneFile

+
    +
  • broadcastZoneFile(zoneFile?: string, transactionToWatch?: string): Promise<any>
    • +
+
    +
  • + +
    +
    +

    Broadcasts a zone file to the Atlas network via the transaction broadcast service. + This is intended for use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional zoneFile: string
      +
      +

      the zone file to be broadcast to the Atlas network

      +
      +
      • +
    • +
      Default value transactionToWatch: string = null
      +
      +

      the hex transaction id of the transaction + to watch for confirmation before broadcasting the zone file to the Atlas network

      +
      +
      • +
    +

    Returns Promise<any>

    +

    Returns a Promise that resolves to an object with a + transaction_hash key containing the transaction hash of the broadcasted transaction.

    +

    In the event of an error, it rejects with:

    +
      +
    • a RemoteServiceError if there is a problem + with the transaction broadcast service
      • +
    • MissingParameterError if you call the function without a required + parameter
      • +
    +
    • +
+
+
+ +

getAccountAt

+
    +
  • getAccountAt(address: string, blockHeight: number): Promise<any[]>
    • +
+
    +
  • + +
    +
    +

    Get the state(s) of an account at a particular block height. This includes the state of the + account beginning with this block's transactions, as well as all of the states the account + passed through when this block was processed (if any).

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      the account's address

      +
      +
      • +
    • +
      blockHeight: number
      +
      +

      the block to query

      +
      +
      • +
    +

    Returns Promise<any[]>

    +

    a promise that resolves to an Array of Objects, where each Object encodes + states of the account at this block.

    +
    • +
+
+
+ +

getAccountBalance

+
    +
  • getAccountBalance(address: string, tokenType: string): Promise<BN>
    • +
+
    +
  • + +
    +
    +

    Get the number of tokens owned by an account. If the account does not exist or has no + tokens of this type, then 0 will be returned.

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      the account's address

      +
      +
      • +
    • +
      tokenType: string
      +
      +

      the type of token to query.

      +
      +
      • +
    +

    Returns Promise<BN>

    +

    a promise that resolves to a BigInteger that encodes the number of tokens + held by this account.

    +
    • +
+
+
+ +

getAccountHistoryPage

+
    +
  • getAccountHistoryPage(address: string, page: number): Promise<any[]>
    • +
+
    +
  • + +
    +
    +

    Get a page of an account's transaction history. This is intended for use in + third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      the account's address

      +
      +
      • +
    • +
      page: number
      +
      +

      the page number. Page 0 is the most recent transactions

      +
      +
      • +
    +

    Returns Promise<any[]>

    +

    a promise that resolves to an Array of Objects, where each Object encodes + states of the account at various block heights (e.g. prior balances, txids, etc)

    +
    • +
+
+
+ +

getAccountStatus

+
    +
  • getAccountStatus(address: string, tokenType: string): Promise<any>
    • +
+
    +
  • + +
    +
    +

    Get the status of an account for a particular token holding. This includes its total number of + expenditures and credits, lockup times, last txid, and so on.

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      the account

      +
      +
      • +
    • +
      tokenType: string
      +
      +

      the token type to query

      +
      +
      • +
    +

    Returns Promise<any>

    +

    a promise that resolves to an object representing the state of the account + for this token

    +
    • +
+
+
+ +

getAccountTokens

+ +
    +
  • + +
    +
    +

    Get the set of token types that this account owns. This is intended for use + in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      the account's address

      +
      +
      • +
    +

    Returns Promise<AccountTokens>

    +

    a promise that resolves to an Array of Strings, where each item encodes the + type of token this account holds (excluding the underlying blockchain's tokens)

    +
    • +
+
+
+ +

getDefaultBurnAddress

+
    +
  • getDefaultBurnAddress(): string
    • +
+
    +
  • + +
    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +
    +

    Returns string

    +
    • +
+
+
+ +

getGracePeriod

+
    +
  • getGracePeriod(_fullyQualifiedName?: string): Promise<number>
    • +
+
    +
  • + +
    +
    +

    How many blocks can pass between a name expiring and the name being able to be + re-registered by a different owner. This is intended for + use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional _fullyQualifiedName: string
      +
      • +
    +

    Returns Promise<number>

    +

    a promise to the number of blocks

    +
    • +
+
+
+ +

getNameInfo

+
    +
  • getNameInfo(fullyQualifiedName: string): Promise<any>
    • +
+
    +
  • + +
    +
    +

    Get WHOIS-like information for a name, including the address that owns it, + the block at which it expires, and the zone file anchored to it (if available).

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      fullyQualifiedName: string
      +
      +

      the name to query. Can be on-chain of off-chain.

      +
      +
      • +
    +

    Returns Promise<any>

    +

    a promise that resolves to the WHOIS-like information

    +
    • +
+
+
+ +

getNamePrice

+
    +
  • getNamePrice(fullyQualifiedName: string): Promise<PriceInfo>
    • +
+
    +
  • + +
    +
    +

    Get the price of a name. This is intended for + use in third-party wallets or in DApps that register names. + This is intended for use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      fullyQualifiedName: string
      +
      +

      the name to query

      +
      +
      • +
    +

    Returns Promise<PriceInfo>

    +

    a promise to an Object with { units: String, amount: BigInteger }, where + .units encodes the cryptocurrency units to pay (e.g. BTC, STACKS), and + .amount encodes the number of units, in the smallest denominiated amount + (e.g. if .units is BTC, .amount will be satoshis; if .units is STACKS, + .amount will be microStacks)

    +
    • +
+
+
+ +

Private getNamePriceV1

+
    +
  • getNamePriceV1(fullyQualifiedName: string): Promise<PriceInfo>
    • +
+
    +
  • + +
    +
    +

    Get the price of a name via the legacy /v1/prices API endpoint. This is + intended for use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      fullyQualifiedName: string
      +
      +

      the name to query

      +
      +
      • +
    +

    Returns Promise<PriceInfo>

    +

    a promise to an Object with { units: String, amount: BigInteger }

    +
    • +
+
+
+ +

Private getNamePriceV2

+
    +
  • getNamePriceV2(fullyQualifiedName: string): Promise<PriceInfo>
    • +
+
    +
  • + +
    +
    +

    Get the price of a name via the /v2/prices API endpoint. This is intended + for use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      fullyQualifiedName: string
      +
      +

      the name to query

      +
      +
      • +
    +

    Returns Promise<PriceInfo>

    +

    a promise to an Object with { units: String, amount: BigInteger }

    +
    • +
+
+
+ +

getNamesOwned

+
    +
  • getNamesOwned(address: string): Promise<string[]>
    • +
+
    +
  • + +
    +
    +

    Get the names -- both on-chain and off-chain -- owned by an address. This is intended for + use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      the blockchain address (the hash of the owner public key)

      +
      +
      • +
    +

    Returns Promise<string[]>

    +

    a promise that resolves to a list of names (Strings)

    +
    • +
+
+
+ +

getNamespaceBurnAddress

+
    +
  • getNamespaceBurnAddress(namespace: string): Promise<string>
    • +
+
    +
  • + +
    +
    +

    Get the blockchain address to which a name's registration fee must be sent + (the address will depend on the namespace in which it is registered.)

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      namespace: string
      +
      +

      the namespace ID

      +
      +
      • +
    +

    Returns Promise<string>

    +

    a promise that resolves to an address (String)

    +
    • +
+
+
+ +

getNamespaceInfo

+
    +
  • getNamespaceInfo(namespaceID: string): Promise<any>
    • +
+
    +
  • + +
    +
    +

    Get the pricing parameters and creation history of a namespace. This is intended for + use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      namespaceID: string
      +
      +

      the namespace to query

      +
      +
      • +
    +

    Returns Promise<any>

    +

    a promise that resolves to the namespace information.

    +
    • +
+
+
+ +

getNamespacePrice

+
    +
  • getNamespacePrice(namespaceID: string): Promise<PriceInfo>
    • +
+
    +
  • + +
    +
    +

    Get the price of a namespace. This is intended for use in third-party + wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      namespaceID: string
      +
      +

      the namespace to query

      +
      +
      • +
    +

    Returns Promise<PriceInfo>

    +

    a promise to an Object with { units: String, amount: BigInteger }, where + .units encodes the cryptocurrency units to pay (e.g. BTC, STACKS), and + .amount encodes the number of units, in the smallest denominiated amount + (e.g. if .units is BTC, .amount will be satoshis; if .units is STACKS, + .amount will be microStacks)

    +
    • +
+
+
+ +

Private getNamespacePriceV1

+
    +
  • getNamespacePriceV1(namespaceID: string): Promise<PriceInfo>
    • +
+
    +
  • + +
    +
    +

    Get the price of a namespace via the legacy /v1/prices API endpoint. This is intended for + use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      namespaceID: string
      +
      +

      the namespace to query

      +
      +
      • +
    +

    Returns Promise<PriceInfo>

    +

    a promise to an Object with { units: String, amount: BigInteger }

    +
    • +
+
+
+ +

Private getNamespacePriceV2

+
    +
  • getNamespacePriceV2(namespaceID: string): Promise<PriceInfo>
    • +
+
    +
  • + +
    +
    +

    Get the price of a namespace via the /v2/prices API endpoint. + This is intended for use in third-party wallets or in DApps that register names.

    +
    +
    +

    Parameters

    +
      +
    • +
      namespaceID: string
      +
      +

      the namespace to query

      +
      +
      • +
    +

    Returns Promise<PriceInfo>

    +

    a promise to an Object with { units: String, amount: BigInteger }

    +
    • +
+
+
+ +

getNetworkedUTXOs

+
    +
  • getNetworkedUTXOs(address: string): Promise<UTXO[]>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      address: string
      +
      • +
    +

    Returns Promise<UTXO[]>

    +
    • +
+
+
+ +

getTransactionInfo

+ + +
+
+ +

getZonefile

+
    +
  • getZonefile(zonefileHash: string): Promise<string>
    • +
+
    +
  • + +
    +
    +

    Get a zone file, given its hash. Throws an exception if the zone file + obtained does not match the hash.

    +
    +

    This is intended for use in third-party wallets or in DApps that register names.

    +
    +

    Parameters

    +
      +
    • +
      zonefileHash: string
      +
      +

      the ripemd160(sha256) hash of the zone file

      +
      +
      • +
    +

    Returns Promise<string>

    +

    a promise that resolves to the zone file's text

    +
    • +
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/nodecryptoaescipher.html b/docs/classes/nodecryptoaescipher.html new file mode 100644 index 00000000..3852bb34 --- /dev/null +++ b/docs/classes/nodecryptoaescipher.html @@ -0,0 +1,337 @@ + + + + + + NodeCryptoAesCipher | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NodeCryptoAesCipher

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + NodeCryptoAesCipher +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

createCipher

+
createCipher: NodeCryptoCreateCipher
+ +
+
+ +

createDecipher

+
createDecipher: NodeCryptoCreateDecipher
+ +
+
+
+

Methods

+
+ +

decrypt

+
    +
  • decrypt(algorithm: CipherAlgorithm, key: Buffer, iv: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+ +

encrypt

+
    +
  • encrypt(algorithm: CipherAlgorithm, key: Buffer, iv: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/nodecryptohmacsha256.html b/docs/classes/nodecryptohmacsha256.html new file mode 100644 index 00000000..cbea6e72 --- /dev/null +++ b/docs/classes/nodecryptohmacsha256.html @@ -0,0 +1,277 @@ + + + + + + NodeCryptoHmacSha256 | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NodeCryptoHmacSha256

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + NodeCryptoHmacSha256 +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

createHmac

+
createHmac: NodeCryptoCreateHmac
+ +
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(key: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/nodecryptopbkdf2.html b/docs/classes/nodecryptopbkdf2.html new file mode 100644 index 00000000..449f9be6 --- /dev/null +++ b/docs/classes/nodecryptopbkdf2.html @@ -0,0 +1,286 @@ + + + + + + NodeCryptoPbkdf2 | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NodeCryptoPbkdf2

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + NodeCryptoPbkdf2 +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

nodePbkdf2

+
nodePbkdf2: NodePbkdf2Fn
+ +
+
+
+

Methods

+
+ +

derive

+
    +
  • derive(password: string, salt: Buffer, iterations: number, keyLength: number, digest: Pbkdf2Digests): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/nodecryptoripemd160digest.html b/docs/classes/nodecryptoripemd160digest.html new file mode 100644 index 00000000..98214602 --- /dev/null +++ b/docs/classes/nodecryptoripemd160digest.html @@ -0,0 +1,274 @@ + + + + + + NodeCryptoRipemd160Digest | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NodeCryptoRipemd160Digest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + NodeCryptoRipemd160Digest +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

nodeCryptoCreateHash

+
nodeCryptoCreateHash: NodeCryptoCreateHash
+ +
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(data: Buffer): Buffer
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/nodecryptosha2hash.html b/docs/classes/nodecryptosha2hash.html new file mode 100644 index 00000000..e720bc1d --- /dev/null +++ b/docs/classes/nodecryptosha2hash.html @@ -0,0 +1,270 @@ + + + + + + NodeCryptoSha2Hash | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class NodeCryptoSha2Hash

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + NodeCryptoSha2Hash +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

createHash

+
createHash: NodeCryptoCreateHash
+ +
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(data: Buffer, algorithm?: string): Promise<Buffer>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      data: Buffer
      +
      • +
    • +
      Default value algorithm: string = "sha256"
      +
      • +
    +

    Returns Promise<Buffer>

    +
    • +
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/ripemd160polyfilldigest.html b/docs/classes/ripemd160polyfilldigest.html new file mode 100644 index 00000000..895ec617 --- /dev/null +++ b/docs/classes/ripemd160polyfilldigest.html @@ -0,0 +1,217 @@ + + + + + + Ripemd160PolyfillDigest | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Ripemd160PolyfillDigest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Ripemd160PolyfillDigest +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(data: Buffer): Buffer
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/webcryptoaescipher.html b/docs/classes/webcryptoaescipher.html new file mode 100644 index 00000000..2a7156f6 --- /dev/null +++ b/docs/classes/webcryptoaescipher.html @@ -0,0 +1,320 @@ + + + + + + WebCryptoAesCipher | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebCryptoAesCipher

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebCryptoAesCipher +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

subtleCrypto

+
subtleCrypto: SubtleCrypto
+ +
+
+
+

Methods

+
+ +

decrypt

+
    +
  • decrypt(algorithm: CipherAlgorithm, key: Buffer, iv: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+ +

encrypt

+
    +
  • encrypt(algorithm: CipherAlgorithm, key: Buffer, iv: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/webcryptohmacsha256.html b/docs/classes/webcryptohmacsha256.html new file mode 100644 index 00000000..3a2fc170 --- /dev/null +++ b/docs/classes/webcryptohmacsha256.html @@ -0,0 +1,277 @@ + + + + + + WebCryptoHmacSha256 | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebCryptoHmacSha256

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebCryptoHmacSha256 +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

subtleCrypto

+
subtleCrypto: SubtleCrypto
+ +
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(key: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/webcryptopartialpbkdf2.html b/docs/classes/webcryptopartialpbkdf2.html new file mode 100644 index 00000000..706346ea --- /dev/null +++ b/docs/classes/webcryptopartialpbkdf2.html @@ -0,0 +1,286 @@ + + + + + + WebCryptoPartialPbkdf2 | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebCryptoPartialPbkdf2

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebCryptoPartialPbkdf2 +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

subtleCrypto

+
subtleCrypto: SubtleCrypto
+ +
+
+
+

Methods

+
+ +

derive

+
    +
  • derive(password: string, salt: Buffer, iterations: number, keyLength: number, digest: Pbkdf2Digests): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/webcryptopbkdf2.html b/docs/classes/webcryptopbkdf2.html new file mode 100644 index 00000000..6b625a63 --- /dev/null +++ b/docs/classes/webcryptopbkdf2.html @@ -0,0 +1,286 @@ + + + + + + WebCryptoPbkdf2 | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebCryptoPbkdf2

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebCryptoPbkdf2 +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

subtleCrypto

+
subtleCrypto: SubtleCrypto
+ +
+
+
+

Methods

+
+ +

derive

+
    +
  • derive(password: string, salt: Buffer, iterations: number, keyLength: number, digest: Pbkdf2Digests): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/classes/webcryptosha2hash.html b/docs/classes/webcryptosha2hash.html new file mode 100644 index 00000000..c7f9da13 --- /dev/null +++ b/docs/classes/webcryptosha2hash.html @@ -0,0 +1,276 @@ + + + + + + WebCryptoSha2Hash | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class WebCryptoSha2Hash

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebCryptoSha2Hash +
    • +
+
+
+

Implements

+ +
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

subtleCrypto

+
subtleCrypto: SubtleCrypto
+ +
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(data: Buffer, algorithm?: string): Promise<Buffer>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      data: Buffer
      +
      • +
    • +
      Default value algorithm: string = "sha256"
      +
      • +
    +

    Returns Promise<Buffer>

    +
    • +
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/accountproofinfo.html b/docs/interfaces/accountproofinfo.html new file mode 100644 index 00000000..ab052597 --- /dev/null +++ b/docs/interfaces/accountproofinfo.html @@ -0,0 +1,239 @@ + + + + + + AccountProofInfo | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountProofInfo

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + AccountProofInfo +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

identifier

+
identifier: string
+ +
+
+ +

proof_url

+
proof_url: string
+ +
+
+ +

service

+
service: string
+ +
+
+ +

Optional valid

+
valid: boolean
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/accounttokens.html b/docs/interfaces/accounttokens.html new file mode 100644 index 00000000..168310d9 --- /dev/null +++ b/docs/interfaces/accounttokens.html @@ -0,0 +1,197 @@ + + + + + + AccountTokens | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountTokens

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + AccountTokens +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

tokens

+
tokens: string[]
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/aescipher.html b/docs/interfaces/aescipher.html new file mode 100644 index 00000000..4d6ada75 --- /dev/null +++ b/docs/interfaces/aescipher.html @@ -0,0 +1,262 @@ + + + + + + AesCipher | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AesCipher

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + AesCipher +
    • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

decrypt

+
    +
  • decrypt(algorithm: CipherAlgorithm, key: Buffer, iv: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+ +

encrypt

+
    +
  • encrypt(algorithm: CipherAlgorithm, key: Buffer, iv: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/encryptcontentoptions.html b/docs/interfaces/encryptcontentoptions.html new file mode 100644 index 00000000..6240580b --- /dev/null +++ b/docs/interfaces/encryptcontentoptions.html @@ -0,0 +1,289 @@ + + + + + + EncryptContentOptions | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EncryptContentOptions

+
+
+
+
+
+
+
+
+
+

Specify encryption options, and whether to sign the ciphertext.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional cipherTextEncoding

+
cipherTextEncoding: CipherTextEncoding
+ +
+
+

String encoding format for the cipherText buffer. + Currently defaults to 'hex' for legacy backwards-compatibility. + Only used if the encrypt option is also used. + Note: in the future this should default to 'base64' for the significant + file size reduction.

+
+
+
+
+ +

Optional publicKey

+
publicKey: string
+ +
+
+

Encrypt the data with this key. + If not provided then the current user's app public key is used.

+
+
+
+
+ +

Optional sign

+
sign: boolean | string
+ +
+
+

If set to true the data is signed using ECDSA on SHA256 hashes with the user's + app private key. If a string is specified, it is used as the private key instead + of the user's app private key.

+
+
+
default
+

false

+
+
+
+
+
+ +

Optional wasString

+
wasString: boolean
+ +
+
+

Specifies if the original unencrypted content is a ASCII or UTF-8 string. + For example stringified JSON. + If true, then when the ciphertext is decrypted, it will be returned as + a string type variable, otherwise will be returned as a Buffer.

+
+
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/encryptionoptions.html b/docs/interfaces/encryptionoptions.html new file mode 100644 index 00000000..82bf2e21 --- /dev/null +++ b/docs/interfaces/encryptionoptions.html @@ -0,0 +1,262 @@ + + + + + + EncryptionOptions | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EncryptionOptions

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional cipherTextEncoding

+
cipherTextEncoding: CipherTextEncoding
+ +
+
+

String encoding format for the cipherText buffer. + Currently defaults to 'hex' for legacy backwards-compatibility. + Only used if the encrypt option is also used. + Note: in the future this should default to 'base64' for the significant + file size reduction.

+
+
+
+
+ +

Optional sign

+
sign: boolean | string
+ +
+
+

If set to true the data is signed using ECDSA on SHA256 hashes with the user's + app private key. If a string is specified, it is used as the private key instead + of the user's app private key.

+
+
+
default
+

false

+
+
+
+
+
+ +

Optional wasString

+
wasString: boolean
+ +
+
+

Specifies if the original unencrypted content is a ASCII or UTF-8 string. + For example stringified JSON. + If true, then when the ciphertext is decrypted, it will be returned as + a string type variable, otherwise will be returned as a Buffer.

+
+
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/hmac.html b/docs/interfaces/hmac.html new file mode 100644 index 00000000..c590b06d --- /dev/null +++ b/docs/interfaces/hmac.html @@ -0,0 +1,220 @@ + + + + + + Hmac | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Hmac

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Hmac +
    • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(key: Buffer, data: Buffer): Promise<Buffer>
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/huberrordetails.html b/docs/interfaces/huberrordetails.html new file mode 100644 index 00000000..0b81021e --- /dev/null +++ b/docs/interfaces/huberrordetails.html @@ -0,0 +1,229 @@ + + + + + + HubErrorDetails | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface HubErrorDetails

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + HubErrorDetails +
    • +
+
+
+

Indexable

+
[prop: string]: any
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional message

+
message: string
+ +
+
+ +

statusCode

+
statusCode: number
+ +
+
+ +

statusText

+
statusText: string
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/nodecryptolib.html b/docs/interfaces/nodecryptolib.html new file mode 100644 index 00000000..9cd517d6 --- /dev/null +++ b/docs/interfaces/nodecryptolib.html @@ -0,0 +1,211 @@ + + + + + + NodeCryptoLib | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface NodeCryptoLib

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + NodeCryptoLib +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

lib

+
lib: "crypto"
+ +
+
+ +

name

+
name: "nodeCrypto"
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/pbkdf2.html b/docs/interfaces/pbkdf2.html new file mode 100644 index 00000000..722c5a03 --- /dev/null +++ b/docs/interfaces/pbkdf2.html @@ -0,0 +1,230 @@ + + + + + + Pbkdf2 | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Pbkdf2

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Pbkdf2 +
    • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

derive

+
    +
  • derive(password: string, salt: Buffer, iterations: number, keyLength: number, digest: Pbkdf2Digests): Promise<Buffer>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      password: string
      +
      • +
    • +
      salt: Buffer
      +
      • +
    • +
      iterations: number
      +
      • +
    • +
      keyLength: number
      +
      • +
    • +
      digest: Pbkdf2Digests
      +
      • +
    +

    Returns Promise<Buffer>

    +
    • +
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/priceinfo.html b/docs/interfaces/priceinfo.html new file mode 100644 index 00000000..3f14f083 --- /dev/null +++ b/docs/interfaces/priceinfo.html @@ -0,0 +1,211 @@ + + + + + + PriceInfo | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface PriceInfo

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + PriceInfo +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

amount

+
amount: BN
+ +
+
+ +

units

+
units: string
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/ripemd160digest.html b/docs/interfaces/ripemd160digest.html new file mode 100644 index 00000000..9a21bd7b --- /dev/null +++ b/docs/interfaces/ripemd160digest.html @@ -0,0 +1,217 @@ + + + + + + Ripemd160Digest | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Ripemd160Digest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Ripemd160Digest +
    • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(data: Buffer): Buffer
    • +
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/sha2hash.html b/docs/interfaces/sha2hash.html new file mode 100644 index 00000000..84705ccb --- /dev/null +++ b/docs/interfaces/sha2hash.html @@ -0,0 +1,219 @@ + + + + + + Sha2Hash | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Sha2Hash

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Sha2Hash +
    • +
+
+
+

Implemented by

+ +
+
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

digest

+
    +
  • digest(data: Buffer, algorithm?: "sha256" | "sha512"): Promise<Buffer>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      data: Buffer
      +
      • +
    • +
      Optional algorithm: "sha256" | "sha512"
      +
      • +
    +

    Returns Promise<Buffer>

    +
    • +
+
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/transactioninfo.html b/docs/interfaces/transactioninfo.html new file mode 100644 index 00000000..d5cf83df --- /dev/null +++ b/docs/interfaces/transactioninfo.html @@ -0,0 +1,201 @@ + + + + + + TransactionInfo | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TransactionInfo

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + TransactionInfo +
    • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

block_height

+
block_height: number
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/uploadresponse.html b/docs/interfaces/uploadresponse.html new file mode 100644 index 00000000..96d82b15 --- /dev/null +++ b/docs/interfaces/uploadresponse.html @@ -0,0 +1,211 @@ + + + + + + UploadResponse | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface UploadResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + UploadResponse +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional etag

+
etag: string
+ +
+
+ +

publicURL

+
publicURL: string
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/utxo.html b/docs/interfaces/utxo.html new file mode 100644 index 00000000..c69f3443 --- /dev/null +++ b/docs/interfaces/utxo.html @@ -0,0 +1,239 @@ + + + + + + UTXO | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface UTXO

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + UTXO +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional confirmations

+
confirmations: number
+ +
+
+ +

tx_hash

+
tx_hash: string
+ +
+
+ +

tx_output_n

+
tx_output_n: number
+ +
+
+ +

Optional value

+
value: number
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file diff --git a/docs/interfaces/webcryptolib.html b/docs/interfaces/webcryptolib.html new file mode 100644 index 00000000..844e9ae1 --- /dev/null +++ b/docs/interfaces/webcryptolib.html @@ -0,0 +1,211 @@ + + + + + + WebCryptoLib | blockstack.js 21.1.0 Library Reference + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface WebCryptoLib

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + WebCryptoLib +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

lib

+
lib: SubtleCrypto
+ +
+
+ +

name

+
name: "subtleCrypto"
+ +
+
+
+
+ + +
+
+
+ +
+

Generated using TypeDoc

+
+
+ + + + \ No newline at end of file