## Index

### Enumerations

- BlockchainMode

### Classes

- Asset
- Authority
- Blockchain
- BroadcastAPI
- Client
- DatabaseAPI
- HexBuffer
- Price
- PrivateKey
- PublicKey
- RCAPI
- Signature

### Interfaces

- Account
- AccountCreateOperation
- AccountCreateWithDelegationOperation
- AccountUpdateOperation
- AccountWitnessProxyOperation
- AccountWitnessVoteOperation
- AppliedOperation
- AuthorityType
- BeneficiaryRoute
- BlockHeader
- BlockchainStreamOptions
- CancelTransferFromSavingsOperation
- ChainProperties
- ChangeRecoveryAccountOperation
- ClaimAccountOperation
- ClaimRewardBalanceOperation
- ClientOptions
- Comment
- CommentOperation
- CommentOptionsOperation
- ConvertOperation
- CreateAccountOptions
- CreateClaimedAccountOperation
- CustomBinaryOperation
- CustomJsonOperation
- CustomOperation
- DeclineVotingRightsOperation
- DelegateVestingSharesOperation
- DeleteCommentOperation
- Discussion
- DisqussionQuery
- DynamicGlobalProperties
- DynamicParam
- EscrowApproveOperation
- EscrowDisputeOperation
- EscrowReleaseOperation
- EscrowTransferOperation
- ExtendedAccount
- FeedPublishOperation
- LimitOrderCancelOperation
- LimitOrderCreate2Operation
- LimitOrderCreateOperation
- Manabar
- Operation
- PendingRequest
- Pool
- Pow2Operation
- PowOperation
- PriceCurveParam
- RCAccount
- RCParams
- RCPool
- RPCCall
- RPCError
- RPCRequest
- RPCResponse
- RecoverAccountOperation
- ReportOverProductionOperation
- RequestAccountRecoveryOperation
- ResetAccountOperation
- Resource
- SMTAsset
- SetResetAccountOperation
- SetWithdrawVestingRouteOperation
- SignedBlock
- SignedBlockHeader
- SignedTransaction
- Transaction
- TransactionConfirmation
- TransferFromSavingsOperation
- TransferOperation
- TransferToSavingsOperation
- TransferToVestingOperation
- VestingDelegation
- VoteOperation
- WithdrawVestingOperation
- WitnessProps
- WitnessSetPropertiesOperation
- WitnessUpdateOperation

### Type aliases

- AssetSymbol
- Bignum
- DiscussionQueryCategory
- KeyRole
- OperationName
- PriceType
- Serializer
- VirtualOperationName

### Variables

- AuthoritySerializer
- BeneficiarySerializer
- ChainPropertiesSerializer
- DEFAULT_ADDRESS_PREFIX
- DEFAULT_CHAIN_ID
- NETWORK_ID
- OperationSerializers
- PriceSerializer
- SignedBlockHeaderSerializer
- TransactionSerializer
- VERSION
- VariableBinarySerializer
- fetch

### Functions

- ArraySerializer
- AssetSerializer
- BinarySerializer
- BooleanSerializer
- DateSerializer
- FlatMapSerializer
- Int16Serializer
- Int32Serializer
- Int64Serializer
- Int8Serializer
- ObjectSerializer
- OperationDataSerializer
- OperationSerializer
- OptionalSerializer
- PublicKeySerializer
- StaticVariantSerializer
- StringSerializer
- UInt16Serializer
- UInt32Serializer
- UInt64Serializer
- UInt8Serializer
- VoidSerializer
- buildWitnessUpdateOp
- copy
- decodePrivate
- decodePublic
- defaultBackoff
- doubleSha256
- encodePrivate
- encodePublic
- getVestingSharePrice
- getVests
- isCanonicalSignature
- iteratorStream
- retryingFetch
- ripemd160
- serialize
- sha256
- signTransaction
- sleep
- transactionDigest
- waitForEvent

### Object literals

- Types
- cryptoUtils

## Type aliases

### AssetSymbol

AssetSymbol: "STEEM" | "VESTS" | "SBD" | "TESTS" | "TBD"

- Defined in steem/asset.ts:48

Asset symbol string.

### Bignum

Bignum: string

- Defined in steem/misc.ts:41

Large number that may be unsafe to represent natively in JavaScript.

### DiscussionQueryCategory

DiscussionQueryCategory: "active" | "blog" | "cashout" | "children" | "comments" | "feed" | "hot" | "promoted" | "trending" | "votes" | "created"

- Defined in helpers/database.ts:49

Possible categories for `get_discussions_by_*`.

### KeyRole

KeyRole: "owner" | "active" | "posting" | "memo"

- Defined in crypto.ts:191

### OperationName

OperationName: "account_create" | "account_create_with_delegation" | "account_update" | "account_witness_proxy" | "account_witness_vote" | "cancel_transfer_from_savings" | "change_recovery_account" | "claim_account" | "claim_reward_balance" | "comment" | "comment_options" | "convert" | "create_claimed_account" | "custom" | "custom_binary" | "custom_json" | "decline_voting_rights" | "delegate_vesting_shares" | "delete_comment" | "escrow_approve" | "escrow_dispute" | "escrow_release" | "escrow_transfer" | "feed_publish" | "limit_order_cancel" | "limit_order_create" | "limit_order_create2" | "pow" | "pow2" | "recover_account" | "report_over_production" | "request_account_recovery" | "reset_account" | "set_reset_account" | "set_withdraw_vesting_route" | "transfer" | "transfer_from_savings" | "transfer_to_savings" | "transfer_to_vesting" | "vote" | "withdraw_vesting" | "witness_set_properties" | "witness_update"

- Defined in steem/operation.ts:46

Operation name.

### PriceType

PriceType: Price | object

- Defined in steem/asset.ts:178

### Serializer

Serializer: function

- Defined in steem/serializer.ts:42

#### Type declaration

- - (buffer: ByteBuffer, data: any): void

  - #### Parameters

    - ##### buffer: ByteBuffer

    - ##### data: any

    #### Returns void

### VirtualOperationName

VirtualOperationName: "author_reward" | "comment_benefactor_reward" | "comment_payout_update" | "comment_reward" | "curation_reward" | "fill_convert_request" | "fill_order" | "fill_transfer_from_savings" | "fill_vesting_withdraw" | "hardfork" | "interest" | "liquidity_reward" | "return_vesting_delegation" | "shutdown_witness"

- Defined in steem/operation.ts:94

Virtual operation name.

## Variables

### Const AuthoritySerializer

AuthoritySerializer: (Anonymous function) = ObjectSerializer([['weight_threshold', UInt32Serializer],['account_auths', FlatMapSerializer(StringSerializer, UInt16Serializer)],['key_auths', FlatMapSerializer(PublicKeySerializer, UInt16Serializer)],])

- Defined in steem/serializer.ts:183

### Const BeneficiarySerializer

BeneficiarySerializer: (Anonymous function) = ObjectSerializer([['account', StringSerializer],['weight', UInt16Serializer],])

- Defined in steem/serializer.ts:189

### Const ChainPropertiesSerializer

ChainPropertiesSerializer: (Anonymous function) = ObjectSerializer([['account_creation_fee', AssetSerializer],['maximum_block_size', UInt32Serializer],['sbd_interest_rate', UInt16Serializer],])

- Defined in steem/serializer.ts:208

### Const DEFAULT_ADDRESS_PREFIX

DEFAULT_ADDRESS_PREFIX: "STM" = "STM"

- Defined in client.ts:59

Main steem network address prefix.

### Const DEFAULT_CHAIN_ID

DEFAULT_CHAIN_ID: Buffer = Buffer.from('0000000000000000000000000000000000000000000000000000000000000000', 'hex')

- Defined in client.ts:54

Main steem network chain id.

### Const NETWORK_ID

NETWORK_ID: Buffer = Buffer.from([0x80])

- Defined in crypto.ts:51

Network id used in WIF-encoding.

### Const OperationSerializers

OperationSerializers: object

- Defined in steem/serializer.ts:222

#### Type declaration

- ##### [name: string]: Serializer

### Const PriceSerializer

PriceSerializer: (Anonymous function) = ObjectSerializer([['base', AssetSerializer],['quote', AssetSerializer],])

- Defined in steem/serializer.ts:194

### Const SignedBlockHeaderSerializer

SignedBlockHeaderSerializer: (Anonymous function) = ObjectSerializer([['previous', BinarySerializer(20)],['timestamp', DateSerializer],['witness', StringSerializer],['transaction_merkle_root', BinarySerializer(20)],['extensions', ArraySerializer(VoidSerializer)],['witness_signature', BinarySerializer(65)],])

- Defined in steem/serializer.ts:199

### Const TransactionSerializer

TransactionSerializer: (Anonymous function) = ObjectSerializer([['ref_block_num', UInt16Serializer],['ref_block_prefix', UInt32Serializer],['expiration', DateSerializer],['operations', ArraySerializer(OperationSerializer)],['extensions', ArraySerializer(StringSerializer)],])

- Defined in steem/serializer.ts:546

### Const VERSION

VERSION: string = packageVersion

- Defined in client.ts:49

Library version.

### Const VariableBinarySerializer

VariableBinarySerializer: (Anonymous function) = BinarySerializer()

- Defined in steem/serializer.ts:138

### Const fetch

fetch: any = global['fetch']

- Defined in utils.ts:40

## Functions

### Const ArraySerializer

- ArraySerializer(itemSerializer: Serializer): (Anonymous function)

- - Defined in steem/serializer.ts:150

  #### Parameters

  - ##### itemSerializer: Serializer

  #### Returns (Anonymous function)

### Const AssetSerializer

- AssetSerializer(buffer: ByteBuffer, data: Asset | string | number): void

- - Defined in steem/serializer.ts:101

  Serialize asset.

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: Asset | string | number

  #### Returns void

### Const BinarySerializer

- BinarySerializer(size?: undefined | number): (Anonymous function)

- - Defined in steem/serializer.ts:123

  #### Parameters

  - ##### Optional size: undefined | number

  #### Returns (Anonymous function)

### Const BooleanSerializer

- BooleanSerializer(buffer: ByteBuffer, data: boolean): void

- - Defined in steem/serializer.ts:84

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: boolean

  #### Returns void

### Const DateSerializer

- DateSerializer(buffer: ByteBuffer, data: string): void

- - Defined in steem/serializer.ts:111

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: string

  #### Returns void

### Const FlatMapSerializer

- FlatMapSerializer(keySerializer: Serializer, valueSerializer: Serializer): (Anonymous function)

- - Defined in steem/serializer.ts:140

  #### Parameters

  - ##### keySerializer: Serializer

  - ##### valueSerializer: Serializer

  #### Returns (Anonymous function)

### Const Int16Serializer

- Int16Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:56

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const Int32Serializer

- Int32Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:60

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const Int64Serializer

- Int64Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:64

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const Int8Serializer

- Int8Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:52

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const ObjectSerializer

- ObjectSerializer(keySerializers: Array<[string, Serializer]>): (Anonymous function)

- - Defined in steem/serializer.ts:159

  #### Parameters

  - ##### keySerializers: Array<[string, Serializer]>

  #### Returns (Anonymous function)

### Const OperationDataSerializer

- OperationDataSerializer(operationId: number, definitions: Array<[string, Serializer]>): (Anonymous function)

- - Defined in steem/serializer.ts:214

  #### Parameters

  - ##### operationId: number

  - ##### definitions: Array<[string, Serializer]>

  #### Returns (Anonymous function)

### Const OperationSerializer

- OperationSerializer(buffer: ByteBuffer, operation: Operation): void

- - Defined in steem/serializer.ts:533

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### operation: Operation

  #### Returns void

### Const OptionalSerializer

- OptionalSerializer(valueSerializer: Serializer): (Anonymous function)

- - Defined in steem/serializer.ts:172

  #### Parameters

  - ##### valueSerializer: Serializer

  #### Returns (Anonymous function)

### Const PublicKeySerializer

- PublicKeySerializer(buffer: ByteBuffer, data: PublicKey | string | null): void

- - Defined in steem/serializer.ts:115

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: PublicKey | string | null

  #### Returns void

### Const StaticVariantSerializer

- StaticVariantSerializer(itemSerializers: Serializer[]): (Anonymous function)

- - Defined in steem/serializer.ts:88

  #### Parameters

  - ##### itemSerializers: Serializer[]

  #### Returns (Anonymous function)

### Const StringSerializer

- StringSerializer(buffer: ByteBuffer, data: string): void

- - Defined in steem/serializer.ts:48

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: string

  #### Returns void

### Const UInt16Serializer

- UInt16Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:72

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const UInt32Serializer

- UInt32Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:76

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const UInt64Serializer

- UInt64Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:80

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const UInt8Serializer

- UInt8Serializer(buffer: ByteBuffer, data: number): void

- - Defined in steem/serializer.ts:68

  #### Parameters

  - ##### buffer: ByteBuffer

  - ##### data: number

  #### Returns void

### Const VoidSerializer

- VoidSerializer(buffer: ByteBuffer): never

- - Defined in steem/serializer.ts:44

  #### Parameters

  - ##### buffer: ByteBuffer

  #### Returns never

### buildWitnessUpdateOp

- buildWitnessUpdateOp(owner: string, props: WitnessProps): WitnessSetPropertiesOperation

- - Defined in utils.ts:139

  #### Parameters

  - ##### owner: string

  - ##### props: WitnessProps

  #### Returns WitnessSetPropertiesOperation

### copy

- copy<T>(object: T): T

- - Defined in utils.ts:84

  Return a deep copy of a JSON-serializable object.

  #### Type parameters

  - #### T

  #### Parameters

  - ##### object: T

  #### Returns T

### decodePrivate

- decodePrivate(encodedKey: string): Buffer

- - Defined in crypto.ts:109

  Decode bs58+doubleSha256-checksum encoded private key.

  #### Parameters

  - ##### encodedKey: string

  #### Returns Buffer

### decodePublic

- decodePublic(encodedKey: string): object

- - Defined in crypto.ts:85

  Decode bs58+ripemd160-checksum encoded public key.

  #### Parameters

  - ##### encodedKey: string

  #### Returns object

  - ##### key: Buffer

  - ##### prefix: string

### Const defaultBackoff

- defaultBackoff(tries: number): number

- - Defined in client.ts:314

  Default backoff function. `min(tries*10^2, 10 seconds)`

  #### Parameters

  - ##### tries: number

  #### Returns number

### doubleSha256

- doubleSha256(input: Buffer | string): Buffer

- - Defined in crypto.ts:70

  Return 2-round sha256 hash of input.

  #### Parameters

  - ##### input: Buffer | string

  #### Returns Buffer

### encodePrivate

- encodePrivate(key: Buffer): string

- - Defined in crypto.ts:100

  Encode bs58+doubleSha256-checksum private key.

  #### Parameters

  - ##### key: Buffer

  #### Returns string

### encodePublic

- encodePublic(key: Buffer, prefix: string): string

- - Defined in crypto.ts:77

  Encode public key with bs58+ripemd160-checksum.

  #### Parameters

  - ##### key: Buffer

  - ##### prefix: string

  #### Returns string

### getVestingSharePrice

- getVestingSharePrice(props: DynamicGlobalProperties): Price

- - Defined in steem/misc.ts:235

  Return the vesting share price.

  #### Parameters

  - ##### props: DynamicGlobalProperties

  #### Returns Price

### getVests

- getVests(account: Account, subtract_delegated?: boolean, add_received?: boolean): number

- - Defined in steem/misc.ts:247

  Returns the vests of specified account. Default: Subtract delegated & add received

  #### Parameters

  - ##### account: Account

  - ##### Default value subtract_delegated: boolean = true

  - ##### Default value add_received: boolean = true

  #### Returns number

### isCanonicalSignature

- isCanonicalSignature(signature: Buffer): boolean

- - Defined in crypto.ts:122

  Return true if signature is canonical, otherwise false.

  #### Parameters

  - ##### signature: Buffer

  #### Returns boolean

### iteratorStream

- iteratorStream<T>(iterator: AsyncIterableIterator<T>): ReadableStream

- - Defined in utils.ts:63

  Return a stream that emits iterator values.

  #### Type parameters

  - #### T

  #### Parameters

  - ##### iterator: AsyncIterableIterator<T>

  #### Returns ReadableStream

### retryingFetch

- retryingFetch(url: string, opts: any, timeout: number, backoff: function, fetchTimeout?: undefined | function): Promise<any>

- - Defined in utils.ts:91

  Fetch API wrapper that retries until timeout is reached.

  #### Parameters

  - ##### url: string

  - ##### opts: any

  - ##### timeout: number

  - ##### backoff: function

    - - (tries: number): number

      - #### Parameters

        - ##### tries: number

        #### Returns number

  - ##### Optional fetchTimeout: undefined | function

  #### Returns Promise<any>

### ripemd160

- ripemd160(input: Buffer | string): Buffer

- - Defined in crypto.ts:56

  Return ripemd160 hash of input.

  #### Parameters

  - ##### input: Buffer | string

  #### Returns Buffer

### serialize

- serialize(serializer: Serializer, data: any): Buffer

- - Defined in utils.ts:133

  #### Parameters

  - ##### serializer: Serializer

  - ##### data: any

  #### Returns Buffer

### sha256

- sha256(input: Buffer | string): Buffer

- - Defined in crypto.ts:63

  Return sha256 hash of input.

  #### Parameters

  - ##### input: Buffer | string

  #### Returns Buffer

### signTransaction

- signTransaction(transaction: Transaction, keys: PrivateKey | PrivateKey[], chainId?: Buffer): SignedTransaction

- - Defined in crypto.ts:338

  Return copy of transaction with signature appended to signatures array.

  #### Parameters

  - ##### transaction: Transaction

    Transaction to sign.

  - ##### keys: PrivateKey | PrivateKey[]

    Key(s) to sign transaction with.

  - ##### Default value chainId: Buffer = DEFAULT_CHAIN_ID

  #### Returns SignedTransaction

### sleep

- sleep(ms: number): Promise<void>

- - Defined in utils.ts:54

  Sleep for N milliseconds.

  #### Parameters

  - ##### ms: number

  #### Returns Promise<void>

### transactionDigest

- transactionDigest(transaction: Transaction | SignedTransaction, chainId?: Buffer): Buffer

- - Defined in crypto.ts:318

  Return the sha256 transaction digest.

  #### Parameters

  - ##### transaction: Transaction | SignedTransaction

  - ##### Default value chainId: Buffer = DEFAULT_CHAIN_ID

    The chain id to use when creating the hash.

  #### Returns Buffer

### waitForEvent

- waitForEvent<T>(emitter: EventEmitter, eventName: string | symbol): Promise<T>

- - Defined in utils.ts:45

  Return a promise that will resove when a specific event is emitted.

  #### Type parameters

  - #### T

  #### Parameters

  - ##### emitter: EventEmitter

  - ##### eventName: string | symbol

  #### Returns Promise<T>

## Object literals

### Const Types

Types: object

- Defined in steem/serializer.ts:554

### Array

Array: ArraySerializer = ArraySerializer

- Defined in steem/serializer.ts:555

### Asset

Asset: AssetSerializer = AssetSerializer

- Defined in steem/serializer.ts:556

### Authority

Authority: (Anonymous function) = AuthoritySerializer

- Defined in steem/serializer.ts:557

### Binary

Binary: BinarySerializer = BinarySerializer

- Defined in steem/serializer.ts:558

### Boolean

Boolean: BooleanSerializer = BooleanSerializer

- Defined in steem/serializer.ts:559

### Date

Date: DateSerializer = DateSerializer

- Defined in steem/serializer.ts:560

### FlatMap

FlatMap: FlatMapSerializer = FlatMapSerializer

- Defined in steem/serializer.ts:561

### Int16

Int16: Int16Serializer = Int16Serializer

- Defined in steem/serializer.ts:562

### Int32

Int32: Int32Serializer = Int32Serializer

- Defined in steem/serializer.ts:563

### Int64

Int64: Int64Serializer = Int64Serializer

- Defined in steem/serializer.ts:564

### Int8

Int8: Int8Serializer = Int8Serializer

- Defined in steem/serializer.ts:565

### Object

Object: ObjectSerializer = ObjectSerializer

- Defined in steem/serializer.ts:566

### Operation

Operation: OperationSerializer = OperationSerializer

- Defined in steem/serializer.ts:567

### Optional

Optional: OptionalSerializer = OptionalSerializer

- Defined in steem/serializer.ts:568

### Price

Price: (Anonymous function) = PriceSerializer

- Defined in steem/serializer.ts:569

### PublicKey

PublicKey: PublicKeySerializer = PublicKeySerializer

- Defined in steem/serializer.ts:570

### StaticVariant

StaticVariant: StaticVariantSerializer = StaticVariantSerializer

- Defined in steem/serializer.ts:571

### String

String: StringSerializer = StringSerializer

- Defined in steem/serializer.ts:572

### Transaction

Transaction: (Anonymous function) = TransactionSerializer

- Defined in steem/serializer.ts:573

### UInt16

UInt16: UInt16Serializer = UInt16Serializer

- Defined in steem/serializer.ts:574

### UInt32

UInt32: UInt32Serializer = UInt32Serializer

- Defined in steem/serializer.ts:575

### UInt64

UInt64: UInt64Serializer = UInt64Serializer

- Defined in steem/serializer.ts:576

### UInt8

UInt8: UInt8Serializer = UInt8Serializer

- Defined in steem/serializer.ts:577

### Void

Void: VoidSerializer = VoidSerializer

- Defined in steem/serializer.ts:578

### Const cryptoUtils

cryptoUtils: object

- Defined in crypto.ts:359

Misc crypto utility functions.

### decodePrivate

decodePrivate: decodePrivate

- Defined in crypto.ts:360

### doubleSha256

doubleSha256: doubleSha256

- Defined in crypto.ts:361

### encodePrivate

encodePrivate: encodePrivate

- Defined in crypto.ts:362

### encodePublic

encodePublic: encodePublic

- Defined in crypto.ts:363

### isCanonicalSignature

isCanonicalSignature: isCanonicalSignature

- Defined in crypto.ts:364

### ripemd160

ripemd160: ripemd160

- Defined in crypto.ts:365

### sha256

sha256: sha256

- Defined in crypto.ts:366

### signTransaction

signTransaction: signTransaction

- Defined in crypto.ts:367

### transactionDigest

transactionDigest: transactionDigest

- Defined in crypto.ts:368

Generated using TypeDoc