Options
All
  • Public
  • Public/Protected
  • All
Menu

accumulate.js

Index

Type aliases

AddAccountAuthorityOperation: { authority: string | AccURL; type: AddAuthority }

Type declaration

AddCreditsArg: { amount: number | BN | string; oracle: number | BN | string; recipient: string | AccURL }

Type declaration

  • amount: number | BN | string
  • oracle: number | BN | string
  • recipient: string | AccURL
AddKeyOperation: { keyHash: string | Uint8Array; type: Add }

Type declaration

  • keyHash: string | Uint8Array
  • type: Add
AddValidatorArg: { owner?: string | AccURL; publicKey: Uint8Array }

Type declaration

  • Optional owner?: string | AccURL
  • publicKey: Uint8Array
BurnTokensArg: { amount: number | BN | string }

Type declaration

  • amount: number | BN | string
CreateDataAccountArg: { authorities?: (string | AccURL)[]; scratch?: boolean; url: string | AccURL }

Type declaration

  • Optional authorities?: (string | AccURL)[]
  • Optional scratch?: boolean
  • url: string | AccURL
CreateIdentityArg: { authorities?: (string | AccURL)[]; keyBookUrl?: string | AccURL; keyHash?: Uint8Array; url: string | AccURL }

Type declaration

  • Optional authorities?: (string | AccURL)[]
  • Optional keyBookUrl?: string | AccURL
  • Optional keyHash?: Uint8Array
  • url: string | AccURL
CreateKeyBookArg: { authorities?: (string | AccURL)[]; publicKeyHash: Uint8Array; url: string | AccURL }

Type declaration

  • Optional authorities?: (string | AccURL)[]
  • publicKeyHash: Uint8Array
  • url: string | AccURL
CreateKeyPageArg: { keys: (string | Uint8Array)[] }

Type declaration

  • keys: (string | Uint8Array)[]
CreateTokenAccountArg: { authorities?: (string | AccURL)[]; scratch?: boolean; tokenUrl: string | AccURL; url: string | AccURL }

Type declaration

  • Optional authorities?: (string | AccURL)[]
  • Optional scratch?: boolean
  • tokenUrl: string | AccURL
  • url: string | AccURL
CreateTokenArg: { authorities?: (string | AccURL)[]; precision: number; properties?: string | AccURL; supplyLimit?: number | BN | string; symbol: string; url: string | AccURL }

Type declaration

  • Optional authorities?: (string | AccURL)[]
  • precision: number
  • Optional properties?: string | AccURL
  • Optional supplyLimit?: number | BN | string
  • symbol: string
  • url: string | AccURL
DisableAccountAuthOperation: { authority: string | AccURL; type: Disable }

Type declaration

EnableAccountAuthOperation: { authority: string | AccURL; type: Enable }

Type declaration

HeaderOptions: { memo?: string; metadata?: Uint8Array; timestamp?: number }

Type declaration

  • Optional memo?: string
  • Optional metadata?: Uint8Array
  • Optional timestamp?: number
IssueTokensArg: { amount: number | BN | string; recipient: string | AccURL }

Type declaration

  • amount: number | BN | string
  • recipient: string | AccURL
Keypair: { publicKey: Uint8Array; secretKey: Uint8Array }

Type declaration

  • publicKey: Uint8Array
  • secretKey: Uint8Array
MinorBlocksQueryOptions: { filterSynthAnchorsOnlyBlocks?: boolean; txFetchMode?: number }

Type declaration

  • Optional filterSynthAnchorsOnlyBlocks?: boolean
  • Optional txFetchMode?: number
QueryOptions: { expand?: boolean; height?: number; prove?: boolean }

Type declaration

  • Optional expand?: boolean
  • Optional height?: number
  • Optional prove?: boolean
QueryPagination: { count: number; start: number }

Type declaration

  • count: number
  • start: number
RemoveAccountAuthorityOperation: { authority: string | AccURL; type: RemoveAuthority }

Type declaration

RemoveKeyOperation: { keyHash: string | Uint8Array; type: Remove }

Type declaration

  • keyHash: string | Uint8Array
  • type: Remove
RemoveValidatorArg: { owner?: string | AccURL; publicKey: Uint8Array }

Type declaration

  • Optional owner?: string | AccURL
  • publicKey: Uint8Array
SendTokensArg: { hash?: Uint8Array; meta?: Uint8Array; to: TokenRecipientArg[] }

Type declaration

SetThresholdKeyPageOperation: { threshold: number; type: SetThreshold }

Type declaration

Signature: { signature: Uint8Array; signerInfo: SignerInfo }

Type declaration

SignerInfo: { publicKey: Uint8Array; type: SignatureType; url: AccURL; version: number }

Type declaration

TokenRecipient: { amount: BN; url: AccURL }

Type declaration

TokenRecipientArg: { amount: number | BN | string; url: string | AccURL }

Type declaration

  • amount: number | BN | string
  • url: string | AccURL
TxQueryOptions: { ignorePending?: boolean; wait?: number } & QueryOptions
TxRequest: { checkOnly?: boolean; isEnvelope?: boolean; memo?: string; metadata?: string; origin: string; payload: string; signature: string; signer: { publicKey: string; signatureType?: string; timestamp: number; url: string; useSimpleHash: boolean; version: number }; txHash?: string }

Type declaration

  • Optional checkOnly?: boolean
  • Optional isEnvelope?: boolean
  • Optional memo?: string
  • Optional metadata?: string
  • origin: string
  • payload: string
  • signature: string
  • signer: { publicKey: string; signatureType?: string; timestamp: number; url: string; useSimpleHash: boolean; version: number }
    • publicKey: string
    • Optional signatureType?: string
    • timestamp: number
    • url: string
    • useSimpleHash: boolean
    • version: number
  • Optional txHash?: string
UpdateAllowedKeyPageOperation: { allow?: TransactionType[]; deny?: TransactionType[]; type: UpdateAllowed }

Type declaration

UpdateKeyArg: { newKeyHash: Uint8Array }

Type declaration

  • newKeyHash: Uint8Array
UpdateKeyOperation: { newKeyHash: string | Uint8Array; oldKeyHash: string | Uint8Array; type: Update }

Type declaration

  • newKeyHash: string | Uint8Array
  • oldKeyHash: string | Uint8Array
  • type: Update
UpdateValidatorKeyArg: { newPublicKey: Uint8Array; publicKey: Uint8Array }

Type declaration

  • newPublicKey: Uint8Array
  • publicKey: Uint8Array
WaitTxOptions: { ignoreSyntheticTxs?: boolean; pollInterval?: number; timeout?: number }

Options for waiting on transaction delivering.

Type declaration

  • Optional ignoreSyntheticTxs?: boolean

    If set to true, only the user tx status is checked. If set to false, will also wait on the associated synthetic txs to be delivered. Default: false

  • Optional pollInterval?: number

    Interval between each tx status poll. Duration in ms. Default: 500ms.

  • Optional timeout?: number

    Timeout after which status polling is aborted. Duration in ms. Default: 30000ms (30s)

WriteDataArg: { data: Uint8Array[]; scratch?: boolean }

Type declaration

  • data: Uint8Array[]
  • Optional scratch?: boolean

Properties

BN: typeof BN

Variables

ACME_ORACLE_URL: AccURL = ...

The URL of the ACME token

ACME_TOKEN_URL: AccURL = ...

The URL of the ACME token

Functions

  • bigNumberMarshalBinary(bn: BN, field?: number): Buffer
  • booleanMarshalBinary(b: boolean, field?: number): Buffer
  • bytesMarshalBinary(val: Uint8Array, field?: number): Buffer
  • Parameters

    • val: Uint8Array
    • Optional field: number

    Returns Buffer

  • fieldMarshalBinary(field: number, val: Uint8Array): Buffer
  • hashMarshalBinary(val: Uint8Array, field?: number): Buffer
  • Parameters

    • val: Uint8Array
    • Optional field: number

    Returns Buffer

  • signatureTypeMarshalJSON(sigType: SignatureType): "ed25519" | "rcd1"
  • stringMarshalBinary(val: string, field?: number): Buffer
  • uvarintMarshalBinary(val: number | BN, field?: number): Buffer
  • Parameters

    • val: number | BN
    • Optional field: number

    Returns Buffer

Generated using TypeDoc