Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Xlm
    • StellarToken

Index

Constructors

constructor

Properties

homeDomain

homeDomain: string

tokenConfig

tokenConfig: StellarTokenConfig

Static maxMemoId

maxMemoId: string = "0xFFFFFFFFFFFFFFFF"

Static maxTrustlineLimit

maxTrustlineLimit: string = "9223372036854775807"

Static tokenPattern

tokenPattern: RegExp = /[A-Z]{1,12}-G[A-Z0-9]{55}/

Static tokenPatternSeparator

tokenPatternSeparator: "-" = "-"

Accessors

code

  • get code(): string

coin

  • get coin(): string

decimalPlaces

  • get decimalPlaces(): number

issuer

  • get issuer(): string

name

  • get name(): string

network

  • get network(): string

type

  • get type(): string

Static coinTokenPatternSeparator

  • get coinTokenPatternSeparator(): string

Methods

allowsAccountConsolidations

  • allowsAccountConsolidations(): boolean

baseUnitsToBigUnits

  • baseUnitsToBigUnits(baseUnits: string | number): string

bigUnitsToBaseUnits

  • bigUnitsToBaseUnits(bigUnits: string | number): string

deriveKeyWithSeed

  • deriveKeyWithSeed(__namedParameters: object): object

enterprises

explainTransaction

  • explainTransaction(params: ExplainTransactionOptions, callback?: NodeCallback<TransactionExplanation>): Bluebird<TransactionExplanation>

federationLookupByAccountId

  • federationLookupByAccountId(accountId: string): Bluebird<Record>

federationLookupByName

  • federationLookupByName(address: string): Bluebird<Record>

feeEstimate

generateKeyPair

  • generateKeyPair(seed: Buffer): KeyPair

getAddressDetails

  • getAddressDetails(address: string): AddressDetails

getBaseFactor

  • getBaseFactor(): number

getBaseTransactionFee

  • getBaseTransactionFee(): Bluebird<number>

getBitGoFederationServer

  • getBitGoFederationServer(): FederationServer

getChain

  • getChain(): string

getExtraPrebuildParams

getFamily

  • getFamily(): string

getFederationServerUrl

  • getFederationServerUrl(): string

getFullName

  • getFullName(): string

getHorizonUrl

  • getHorizonUrl(): string

getMinimumReserve

  • getMinimumReserve(): Bluebird<number>

getPrvFromRaw

  • getPrvFromRaw(prv: string): string

getPubFromRaw

  • getPubFromRaw(pub: string): string

getTokenNameFromStellarAsset

  • getTokenNameFromStellarAsset(asset: stellar.Asset): string

initiateRecovery

  • initiateRecovery(params: RecoveryOptions): Bluebird<stellar.Keypair[]>

isValidAddress

  • isValidAddress(address: string): boolean

isValidMemo

  • isValidMemo(__namedParameters: object): boolean

isValidMemoId

  • isValidMemoId(memoId: string): boolean

isValidMofNSetup

  • isValidMofNSetup(__namedParameters: object): boolean

isValidPrv

  • isValidPrv(prv: string): boolean

isValidPub

  • isValidPub(pub: string): boolean

isValidStellarUsername

  • isValidStellarUsername(username: string): boolean

keyIdsForSigning

  • keyIdsForSigning(): number[]

keychains

markets

newWalletObject

  • newWalletObject(walletParams: any): Wallet

normalizeAddress

  • normalizeAddress(__namedParameters: object): string

parseTransaction

pendingApprovals

postProcessPrebuild

preCreateBitGo

presignTransaction

recover

  • recover(params: RecoveryOptions, callback: NodeCallback<RecoveryTransaction>): Bluebird<RecoveryTransaction>
  • Builds a funds recovery transaction without BitGo

    Parameters

    • params: RecoveryOptions
      • userKey: [encrypted] Stellar private key
      • backupKey: [encrypted] Stellar private key, or public key if the private key is held by a KRS provider
      • walletPassphrase: necessary if one of the private keys is encrypted
      • rootAddress: base address of the wallet to recover funds from
      • krsProvider: necessary if backup key is held by KRS
      • recoveryDestination: target address to send recovered funds to
    • callback: NodeCallback<RecoveryTransaction>

    Returns Bluebird<RecoveryTransaction>

signMessage

  • signMessage(key: KeyPair, message: string | Buffer, callback?: NodeCallback<Buffer>): Bluebird<Buffer>

signTransaction

  • signTransaction(params: SignTransactionOptions, callback?: NodeCallback<HalfSignedTransaction>): Bluebird<HalfSignedTransaction>

supplementGenerateWallet

  • supplementGenerateWallet(walletParams: SupplementGenerateWalletOptions): Bluebird<SupplementGenerateWalletOptions>
  • Extend walletParams with extra params required for generating an XLM wallet

    Stellar wallets have three keychains on them. Two are generated by the platform, and the last is generated by the user. Initially, we need a root prv to generate the account, which must be distinct from all three keychains on the wallet. If a root prv is not provided, a random one is generated.

    Parameters

    • walletParams: SupplementGenerateWalletOptions

    Returns Bluebird<SupplementGenerateWalletOptions>

supportsBlockTarget

  • supportsBlockTarget(): boolean

transactionDataAllowed

  • transactionDataAllowed(): boolean

url

  • url(suffix: string): string

valuelessTransferAllowed

  • valuelessTransferAllowed(): boolean

verifyAddress

  • verifyAddress(__namedParameters: object): boolean

verifyRecoveryTransaction

verifySignature

  • verifySignature(pub: string, message: string | Buffer, signature: Buffer): any

verifyTransaction

  • verifyTransaction(options: VerifyTransactionOptions, callback?: NodeCallback<boolean>): Bluebird<boolean>

verifyTrustlineTxOperations

  • verifyTrustlineTxOperations(operations: stellar.Operation[], txParams: TransactionParams): void

wallets

webhooks

Static createInstance

Static createTokenConstructor

Generated using TypeDoc