Class FIOSDK

Index

Constructors

Properties

config privateKey publicKey rawAbiMissingWarnings technologyProviderId SUFUnit rawAbiMissingWarnings

Accessors

Methods

addBundledTransactions addPublicAddress addPublicAddresses burnFioAddress cancelFundsRequest executePreparedTrx genericAction getAbi getAccount getAccountPubKey getCancelledFioRequests getEncryptKey getFee getFeeForAddBundledTransactions getFeeForAddPublicAddress getFeeForBurnFioAddress getFeeForCancelFundsRequest getFeeForNewFundsRequest getFeeForRecordObtData getFeeForRejectFundsRequest getFeeForRemoveAllPublicAddresses getFeeForRemovePublicAddresses getFeeForTransferFioAddress getFeeForTransferFioDomain getFeeForTransferLockedTokens getFioAddresses getFioBalance getFioDomains getFioNames getFioPublicAddress getFioPublicKey getGranteePermissions getGrantorPermissions getLocks getMultiplier getNfts getObjectPermissions getObtData getOracleFees getPendingFioRequests getPublicAddress getPublicAddresses getReceivedFioRequests getSentFioRequests getTechnologyProviderId isAvailable pushTransaction recordObtData registerFioAddress registerFioDomain registerFioDomainAddress registerOwnerFioAddress registerOwnerFioDomain rejectFundsRequest removeAllPublicAddresses removePublicAddresses renewFioAddress renewFioDomain requestFunds setApiUrls setFioDomainVisibility setSignedTrxReturnOption stakeFioTokens transferFioAddress transferFioDomain transferLockedTokens transferTokens unStakeFioTokens validateChainCode validateFioAddress validateFioDomain validateFioPublicKey validatePublicAddress validateTokenCode SUFToAmount SUFToAmountString accountHash amountToSUF amountToSUFString createPrivateKeyMnemonic derivedPublicKey isChainCodeValid isFioAddressValid isFioDomainValid isFioPublicKeyValid isPublicAddressValid isTokenCodeValid setRawAbiMissingWarnings

Constructors

constructor

new FIOSDK(privateKey, publicKey, apiUrls, fetchJson, registerMockUrl?, technologyProviderId?, returnPreparedTrx?, logger?): FIOSDK
Parameters
- privateKey: string
  the fio private key of the client sending requests to FIO API.
- publicKey: string
  the fio public key of the client sending requests to FIO API.
- apiUrls: string | string[]
  the url or list of urls to the FIO API.
- fetchJson: FetchJson
  the module to use for HTTP Post/Get calls How to instantiate fetchJson parameter:
```
// i.e.
fetch = require('node-fetch')

const fetchJson = async (uri, opts = {}) => {
    return fetch(uri, opts)
}
```
- OptionalregisterMockUrl: null | string
  the url to the mock server
- OptionaltechnologyProviderId: null | string
  Default FIO Address of the wallet which generates transactions.
- OptionalreturnPreparedTrx: null | boolean
  flag indicate that it should return prepared transaction or should be pushed to server.
- Optionallogger: null | FioLogger
  FioLogger FIO logger to handle all requests.
Returns FIOSDK
Deprecated
- Defined in src/FIOSDK.ts:873
new FIOSDK(options): FIOSDK
Parameters
- options: FioSdkOptions
Returns FIOSDK
- Defined in src/FIOSDK.ts:900

Properties

config

config: RequestConfig

privateKey

privateKey: string

the fio private key of the client sending requests to FIO API.

publicKey

publicKey: string

the fio public key of the client sending requests to FIO API.

rawAbiMissingWarnings

rawAbiMissingWarnings: string[]

Stored raw abi missing warnings

technologyProviderId

technologyProviderId: string

Default FIO Address of the wallet which generates transactions.

`Static`SUFUnit

SUFUnit: number = 1000000000

SUFs = Smallest Units of FIO

`Static`rawAbiMissingWarnings

rawAbiMissingWarnings: string[]

Accessors

transactions

get transactions(): {
    createRawTransaction: ((__namedParameters: {
        account: Account;
        action: Action;
        authPermission?: string;
        chainData?: {
            expiration: string;
            ref_block_num: number;
            ref_block_prefix: number;
        };
        data: any;
        publicKey?: string;
        signingAccount?: string;
    }) => Promise<RawRequest>);
    deserialize: ((__namedParameters: {
        abiMap?: Map<string, any>;
        chainId: string;
        serializedTransaction: Uint8Array;
        textDecoder?: TextDecoder;
        textEncoder?: TextEncoder;
    }) => Promise<RawRequest>);
    getActor: ((publicKey?: string) => string);
    getBlock: ((chain: FioInfoResponse) => Promise<GetBlockResult>);
    getChainDataForTx: (() => Promise<{
        chain_id: string;
        expiration: string;
        ref_block_num: number;
        ref_block_prefix: number;
    }>);
    getChainInfo: (() => Promise<FioInfoResponse>);
    getCipherContent: ((contentType: ContentType, content: any, privateKey: string, publicKey: string) => string);
    getUnCipherContent: (<T>(contentType: ContentType, content: string, privateKey: string, publicKey: string) => T);
    serialize: ((__namedParameters: {
        abiMap?: Map<string, any>;
        chainId: string;
        textDecoder?: TextDecoder;
        textEncoder?: TextEncoder;
        transaction: RawRequest;
    }) => Promise<PushTransactionArgs>);
}
Returns {
    createRawTransaction: ((__namedParameters: {
        account: Account;
        action: Action;
        authPermission?: string;
        chainData?: {
            expiration: string;
            ref_block_num: number;
            ref_block_prefix: number;
        };
        data: any;
        publicKey?: string;
        signingAccount?: string;
    }) => Promise<RawRequest>);
    deserialize: ((__namedParameters: {
        abiMap?: Map<string, any>;
        chainId: string;
        serializedTransaction: Uint8Array;
        textDecoder?: TextDecoder;
        textEncoder?: TextEncoder;
    }) => Promise<RawRequest>);
    getActor: ((publicKey?: string) => string);
    getBlock: ((chain: FioInfoResponse) => Promise<GetBlockResult>);
    getChainDataForTx: (() => Promise<{
        chain_id: string;
        expiration: string;
        ref_block_num: number;
        ref_block_prefix: number;
    }>);
    getChainInfo: (() => Promise<FioInfoResponse>);
    getCipherContent: ((contentType: ContentType, content: any, privateKey: string, publicKey: string) => string);
    getUnCipherContent: (<T>(contentType: ContentType, content: string, privateKey: string, publicKey: string) => T);
    serialize: ((__namedParameters: {
        abiMap?: Map<string, any>;
        chainId: string;
        textDecoder?: TextDecoder;
        textEncoder?: TextEncoder;
        transaction: RawRequest;
    }) => Promise<PushTransactionArgs>);
}
- createRawTransaction: ((__namedParameters: {
      account: Account;
      action: Action;
      authPermission?: string;
      chainData?: {
          expiration: string;
          ref_block_num: number;
          ref_block_prefix: number;
      };
      data: any;
      publicKey?: string;
      signingAccount?: string;
  }) => Promise<RawRequest>)
  - - (__namedParameters): Promise<RawRequest>
    - Parameters
      __namedParameters: {
          account: Account;
          action: Action;
          authPermission?: string;
          chainData?: {
              expiration: string;
              ref_block_num: number;
              ref_block_prefix: number;
          };
          data: any;
          publicKey?: string;
          signingAccount?: string;
      }
      account: Account
      action: Action
      OptionalauthPermission?: string
      OptionalchainData?: {
          expiration: string;
          ref_block_num: number;
          ref_block_prefix: number;
      }
      expiration: string
      ref_block_num: number
      ref_block_prefix: number
      data: any
      OptionalpublicKey?: string
      OptionalsigningAccount?: string
      Returns Promise<RawRequest>
- deserialize: ((__namedParameters: {
      abiMap?: Map<string, any>;
      chainId: string;
      serializedTransaction: Uint8Array;
      textDecoder?: TextDecoder;
      textEncoder?: TextEncoder;
  }) => Promise<RawRequest>)
  - - (__namedParameters): Promise<RawRequest>
    - Parameters
      __namedParameters: {
          abiMap?: Map<string, any>;
          chainId: string;
          serializedTransaction: Uint8Array;
          textDecoder?: TextDecoder;
          textEncoder?: TextEncoder;
      }
      OptionalabiMap?: Map<string, any>
      chainId: string
      serializedTransaction: Uint8Array
      OptionaltextDecoder?: TextDecoder
      OptionaltextEncoder?: TextEncoder
      Returns Promise<RawRequest>
- getActor: ((publicKey?: string) => string)
  - - (publicKey?): string
    - Parameters
      publicKey: string = ''
      Returns string
- getBlock: ((chain: FioInfoResponse) => Promise<GetBlockResult>)
  - - (chain): Promise<GetBlockResult>
    - Parameters
      chain: FioInfoResponse
      Returns Promise<GetBlockResult>
- getChainDataForTx: (() => Promise<{
      chain_id: string;
      expiration: string;
      ref_block_num: number;
      ref_block_prefix: number;
  }>)
  - - (): Promise<{
          chain_id: string;
          expiration: string;
          ref_block_num: number;
          ref_block_prefix: number;
      }>
    - Returns Promise<{
          chain_id: string;
          expiration: string;
          ref_block_num: number;
          ref_block_prefix: number;
      }>
- getChainInfo: (() => Promise<FioInfoResponse>)
  - - (): Promise<FioInfoResponse>
    - Returns Promise<FioInfoResponse>
- getCipherContent: ((contentType: ContentType, content: any, privateKey: string, publicKey: string) => string)
  - - (contentType, content, privateKey, publicKey): string
    - Parameters
      contentType: ContentType
      content: any
      privateKey: string
      publicKey: string
      Returns string
- getUnCipherContent: (<T>(contentType: ContentType, content: string, privateKey: string, publicKey: string) => T)
  - - <T>(contentType, content, privateKey, publicKey): T
    - Type Parameters
      T = any
      Parameters
      contentType: ContentType
      content: string
      privateKey: string
      publicKey: string
      Returns T
- serialize: ((__namedParameters: {
      abiMap?: Map<string, any>;
      chainId: string;
      textDecoder?: TextDecoder;
      textEncoder?: TextEncoder;
      transaction: RawRequest;
  }) => Promise<PushTransactionArgs>)
  - - (__namedParameters): Promise<PushTransactionArgs>
    - Parameters
      __namedParameters: {
          abiMap?: Map<string, any>;
          chainId: string;
          textDecoder?: TextDecoder;
          textEncoder?: TextEncoder;
          transaction: RawRequest;
      }
      OptionalabiMap?: Map<string, any>
      chainId: string
      OptionaltextDecoder?: TextDecoder
      OptionaltextEncoder?: TextEncoder
      transaction: RawRequest
      Returns Promise<PushTransactionArgs>
- Defined in src/FIOSDK.ts:727

`Static`abiMap

get abiMap(): ApiMap
Returns ApiMap
- Defined in src/FIOSDK.ts:723

Methods

addBundledTransactions

addBundledTransactions(fioAddress, bundleSets, maxFee, technologyProviderId?, expirationOffset?): Promise<AddBundledTransactionsResponse>
Parameters
- fioAddress: string
  FIO Address to transfer. The owner will be the public key associated with the FIO SDK instance.
- bundleSets: number
  Number of sets of bundles to add to FIO Address.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
- OptionalexpirationOffset: null | number
  Expiration time offset for this transaction in seconds. Default is 180 seconds. Increasing number of seconds gives transaction more lifetime term.
Returns Promise<AddBundledTransactionsResponse>
Deprecated
Adds bundles of transactions to FIO Address.
- Defined in src/FIOSDK.ts:1471
addBundledTransactions(options): Promise<AddBundledTransactionsResponse>
Adds bundles of transactions to FIO Address.
Parameters
- options: AddBundledTransactionsOptions
Returns Promise<AddBundledTransactionsResponse>
- Defined in src/FIOSDK.ts:1490

addPublicAddress

addPublicAddress(fioAddress, chainCode, tokenCode, publicAddress, maxFee, technologyProviderId?): Promise<AddPublicAddressesResponse>
Parameters
- fioAddress: string
  FIO Address which will be mapped to public address.
- chainCode: string
  Blockchain code for blockchain hosting this token.
- tokenCode: string
  Token code to be used with that public address.
- publicAddress: string
  The public address to be added to the FIO Address for the specified token.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<AddPublicAddressesResponse>
Deprecated
This call allows a public address of the specific blockchain type to be added to the FIO Address.
- Defined in src/FIOSDK.ts:1604
addPublicAddress(options): Promise<AddPublicAddressesResponse>
This call allows a public address of the specific blockchain type to be added to the FIO Address.
Parameters
- options: AddPublicAddressOptions
Returns Promise<AddPublicAddressesResponse>
- Defined in src/FIOSDK.ts:1623

addPublicAddresses

addPublicAddresses(fioAddress, publicAddresses, maxFee, technologyProviderId?): Promise<AddPublicAddressesResponse>
Parameters
- fioAddress: string
  FIO Address which will be mapped to public addresses.
- publicAddresses: PublicAddress[]
  Array of public addresses to be added to the FIO Address for the specified token.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<AddPublicAddressesResponse>
Deprecated
This call allows a public addresses of the specific blockchain type to be added to the FIO Address.
- Defined in src/FIOSDK.ts:1826
addPublicAddresses(options): Promise<AddPublicAddressesResponse>
This call allows a public addresses of the specific blockchain type to be added to the FIO Address.
Parameters
- options: AddPublicAddressesOptions
Returns Promise<AddPublicAddressesResponse>
- Defined in src/FIOSDK.ts:1841

burnFioAddress

burnFioAddress(fioAddress, maxFee, technologyProviderId?): Promise<BurnFioAddressResponse>
Parameters
- fioAddress: string
  FIO Address to burn. The owner will be the public key associated with the FIO SDK instance.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<BurnFioAddressResponse>
Deprecated
Burns a FIO Address on the FIO blockchain.
- Defined in src/FIOSDK.ts:1345
burnFioAddress(options): Promise<BurnFioAddressResponse>
Burns a FIO Address on the FIO blockchain.
Parameters
- options: BurnFioAddressOptions
Returns Promise<BurnFioAddressResponse>
- Defined in src/FIOSDK.ts:1359

cancelFundsRequest

cancelFundsRequest(fioRequestId, maxFee, technologyProviderId?): Promise<CancelFundsRequestResponse>
Parameters
- fioRequestId: number
  The id of the request.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<CancelFundsRequestResponse>
Deprecated
This call cancels the specified fio funds request.
- Defined in src/FIOSDK.ts:1653
cancelFundsRequest(options): Promise<CancelFundsRequestResponse>
This call cancels the specified fio funds request.
Parameters
- options: CancelFundsRequestOptions
Returns Promise<CancelFundsRequestResponse>
- Defined in src/FIOSDK.ts:1666

executePreparedTrx

executePreparedTrx(endPoint, preparedTrx): Promise<any>
Execute prepared transaction.
Parameters
- endPoint: EndPoint
  endpoint.
- preparedTrx: unknown
Returns Promise<any>
- Defined in src/FIOSDK.ts:1104

genericAction

genericAction<T>(action, ...args): GenericActions[typeof GenericAction[T]]["response"]
Type Parameters
- T extends
      | "getFioPublicKey"
      | "getMultiplier"
      | "getAbi"
      | "getEncryptKey"
      | "getFee"
      | "recordObtData"
      | "registerFioAddress"
      | "registerFioDomain"
      | "registerFioDomainAddress"
      | "renewFioAddress"
      | "renewFioDomain"
      | "setFioDomainVisibility"
      | "transferTokens"
      | "getAccount"
      | "registerOwnerFioAddress"
      | "transferLockedTokens"
      | "registerOwnerFioDomain"
      | "burnFioAddress"
      | "transferFioAddress"
      | "transferFioDomain"
      | "addBundledTransactions"
      | "addPublicAddress"
      | "addPublicAddresses"
      | "removePublicAddresses"
      | "getLocks"
      | "cancelFundsRequest"
      | "removeAllPublicAddresses"
      | "getObtData"
      | "getGranteePermissions"
      | "getGrantorPermissions"
      | "getObjectPermissions"
      | "rejectFundsRequest"
      | "requestFunds"
      | "isAvailable"
      | "getFioBalance"
      | "getFioNames"
      | "getFioDomains"
      | "getFioAddresses"
      | "getPendingFioRequests"
      | "getReceivedFioRequests"
      | "getCancelledFioRequests"
      | "getSentFioRequests"
      | "getPublicAddress"
      | "getFioPublicAddress"
      | "getPublicAddresses"
      | "getNfts"
      | "stakeFioTokens"
      | "unStakeFioTokens"
      | "getOracleFees"
      | "getFeeForRecordObtData"
      | "getFeeForNewFundsRequest"
      | "getFeeForRejectFundsRequest"
      | "getFeeForBurnFioAddress"
      | "getFeeForTransferFioAddress"
      | "getFeeForTransferFioDomain"
      | "getFeeForAddBundledTransactions"
      | "getFeeForAddPublicAddress"
      | "getFeeForCancelFundsRequest"
      | "getFeeForRemovePublicAddresses"
      | "getFeeForRemoveAllPublicAddresses"
      | "getFeeForTransferLockedTokens"
      | "pushTransaction"
      | "getAccountPubKey"
      | GenericAction
Parameters
- action: T
- Rest...args: GenericActions[typeof GenericAction[T]]["options"]
Returns GenericActions[typeof GenericAction[T]]["response"]
- Defined in src/FIOSDK.ts:3083

getAbi

getAbi(accountName): Promise<AbiResponse>
Parameters
- accountName: string
Returns Promise<AbiResponse>
Deprecated
- Defined in src/FIOSDK.ts:3243
getAbi(options): Promise<AbiResponse>
Parameters
- options: GetAbiOptions
Returns Promise<AbiResponse>
- Defined in src/FIOSDK.ts:3244

getAccount

getAccount(actor): Promise<AccountResponse>
Parameters
- actor: string
  FIO account.
Returns Promise<AccountResponse>
Deprecated
Retrieves info on account for this actor
- Defined in src/FIOSDK.ts:2156
getAccount(options): Promise<AccountResponse>
Retrieves info on account for this actor
Parameters
- options: GetAccountOptions
Returns Promise<AccountResponse>
- Defined in src/FIOSDK.ts:2162

getAccountPubKey

getAccountPubKey(account): Promise<GetAccountPubKeyResponse>
Parameters
- account: string
Returns Promise<GetAccountPubKeyResponse>
Deprecated
Description
Method to get public key by account name.
- Defined in src/FIOSDK.ts:3053
getAccountPubKey(options): Promise<GetAccountPubKeyResponse>
Parameters
- options: GetAccountPubKeyOptions
Returns Promise<GetAccountPubKeyResponse>
Description
Method to get public key by account name.
- Defined in src/FIOSDK.ts:3057

getCancelledFioRequests

getCancelledFioRequests(options): Promise<undefined | CancelledFioRequestsDecryptedResponse>
Polls for any cancelled requests sent by public key associated with the FIO SDK instance.
Parameters
- options: GetCancelledFioRequestsOptions
Returns Promise<undefined | CancelledFioRequestsDecryptedResponse>
- Defined in src/FIOSDK.ts:2352

getEncryptKey

getEncryptKey(fioAddress): Promise<GetEncryptKeyResponse>
Parameters
- fioAddress: string
  FIO public key
Returns Promise<GetEncryptKeyResponse>
Deprecated
Description
Method returns FIO Public Key that was set for encrypt/decrypt data. By default, it is the same as FIO Handle wallet public key.
- Defined in src/FIOSDK.ts:3070
getEncryptKey(options): Promise<GetEncryptKeyResponse>
Parameters
- options: GetEncryptKeyOptions
Returns Promise<GetEncryptKeyResponse>
Description
Method returns FIO Public Key that was set for encrypt/decrypt data. By default, it is the same as FIO Handle wallet public key.
- Defined in src/FIOSDK.ts:3076

getFee

getFee(endPoint, fioAddress?): Promise<FioFeeResponse>
Parameters
- endPoint: EndPoint
  Name of API call end point, e.g. add_pub_address.
- OptionalfioAddress: null | string
  if endPointName is RenewFioAddress, FIO Address incurring the fee and owned by signer. if endPointName is RenewFioDomain, FIO Domain incurring the fee and owned by signer. if endPointName is RecordObtData, Payer FIO Address incurring the fee and owned by signer.
  
  Omit for:
  - register_fio_domain
  - register_fio_address
  - transfer_tokens_pub_key
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2628
getFee(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2643

getFeeForAddBundledTransactions

getFeeForAddBundledTransactions(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2845
getFeeForAddBundledTransactions(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForAddBundledTransactionsOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2851

getFeeForAddPublicAddress

getFeeForAddPublicAddress(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2719
getFeeForAddPublicAddress(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForAddPublicAddressOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2725

getFeeForBurnFioAddress

getFeeForBurnFioAddress(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2803
getFeeForBurnFioAddress(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForBurnFioAddressOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2809

getFeeForCancelFundsRequest

getFeeForCancelFundsRequest(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2740
getFeeForCancelFundsRequest(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForCancelFundsRequestOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2746

getFeeForNewFundsRequest

getFeeForNewFundsRequest(payeeFioAddress): Promise<FioFeeResponse>
Parameters
- payeeFioAddress: string
  Payee FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2677
getFeeForNewFundsRequest(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForNewFundsRequestOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2683

getFeeForRecordObtData

getFeeForRecordObtData(payerFioAddress): Promise<FioFeeResponse>
Parameters
- payerFioAddress: string
  Payer FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2656
getFeeForRecordObtData(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForRecordObtDataOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2662

getFeeForRejectFundsRequest

getFeeForRejectFundsRequest(payerFioAddress): Promise<FioFeeResponse>
Parameters
- payerFioAddress: string
  Payer FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2698
getFeeForRejectFundsRequest(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForRejectFundsRequestOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2704

getFeeForRemoveAllPublicAddresses

getFeeForRemoveAllPublicAddresses(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2782
getFeeForRemoveAllPublicAddresses(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForRemoveAllPublicAddressesOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2788

getFeeForRemovePublicAddresses

getFeeForRemovePublicAddresses(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2761
getFeeForRemovePublicAddresses(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForRemovePublicAddressesOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2767

getFeeForTransferFioAddress

getFeeForTransferFioAddress(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2824
getFeeForTransferFioAddress(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForTransferFioAddressOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2830

getFeeForTransferFioDomain

getFeeForTransferFioDomain(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2866
getFeeForTransferFioDomain(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForTransferFioDomainOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2872

getFeeForTransferLockedTokens

getFeeForTransferLockedTokens(fioAddress): Promise<FioFeeResponse>
Parameters
- fioAddress: string
  FIO Address incurring the fee and owned by signer.
Returns Promise<FioFeeResponse>
Deprecated
Compute and return fee amount for specific call and specific user
- Defined in src/FIOSDK.ts:2581
getFeeForTransferLockedTokens(options): Promise<FioFeeResponse>
Compute and return fee amount for specific call and specific user
Parameters
- options: GetFeeForTransferLockedTokensOptions
Returns Promise<FioFeeResponse>
- Defined in src/FIOSDK.ts:2587

getFioAddresses

getFioAddresses(fioPublicKey, limit?, offset?): Promise<FioAddressesResponse>
Parameters
- fioPublicKey: string
  FIO public key of owner.
- Optionallimit: null | number
  Number of request to return. If omitted, all requests will be returned.
- Optionaloffset: null | number
  First request from list to return. If omitted, 0 is assumed.
Returns Promise<FioAddressesResponse>
Deprecated
Returns FIO Addresses owned by this public key.
- Defined in src/FIOSDK.ts:2234
getFioAddresses(options): Promise<FioAddressesResponse>
Returns FIO Addresses owned by this public key.
Parameters
- options: GetFioAddressesOptions
Returns Promise<FioAddressesResponse>
- Defined in src/FIOSDK.ts:2246

getFioBalance

getFioBalance(fioPublicKey?): Promise<BalanceResponse>
Parameters
- OptionalfioPublicKey: null | string
  FIO public key.
Returns Promise<BalanceResponse>
Deprecated
Retrieves balance of FIO tokens
- Defined in src/FIOSDK.ts:2194
getFioBalance(options): Promise<BalanceResponse>
Retrieves balance of FIO tokens
Parameters
- options: GetFioBalanceOptions
Returns Promise<BalanceResponse>
- Defined in src/FIOSDK.ts:2200

getFioDomains

getFioDomains(fioPublicKey, limit?, offset?): Promise<FioDomainsResponse>
Parameters
- fioPublicKey: string
  FIO public key of owner.
- Optionallimit: null | number
  Number of request to return. If omitted, all requests will be returned.
- Optionaloffset: null | number
  First request from list to return. If omitted, 0 is assumed.
Returns Promise<FioDomainsResponse>
Deprecated
Returns FIO domains owned by this public key.
- Defined in src/FIOSDK.ts:2264
getFioDomains(options): Promise<FioDomainsResponse>
Returns FIO domains owned by this public key.
Parameters
- options: GetFioDomainsOptions
Returns Promise<FioDomainsResponse>
- Defined in src/FIOSDK.ts:2276

getFioNames

getFioNames(fioPublicKey): Promise<FioNamesResponse>
Parameters
- fioPublicKey: string
  FIO public key of owner.
Returns Promise<FioNamesResponse>
Deprecated
Returns FIO Addresses and FIO Domains owned by this public key.
- Defined in src/FIOSDK.ts:2213
getFioNames(options): Promise<FioNamesResponse>
Returns FIO Addresses and FIO Domains owned by this public key.
Parameters
- options: GetFioNamesOptions
Returns Promise<FioNamesResponse>
- Defined in src/FIOSDK.ts:2219

getFioPublicAddress

getFioPublicAddress(fioAddress): Promise<PublicAddressResponse>
Parameters
- fioAddress: string
  FIO Address for which fio token public address is to be returned.
Returns Promise<PublicAddressResponse>
Deprecated
Returns the FIO token public address for specified FIO Address.
- Defined in src/FIOSDK.ts:2429
getFioPublicAddress(options): Promise<PublicAddressResponse>
Returns the FIO token public address for specified FIO Address.
Parameters
- options: GetFioPublicAddressOptions
Returns Promise<PublicAddressResponse>
- Defined in src/FIOSDK.ts:2435

getFioPublicKey

getFioPublicKey(): string
Retrieves the FIO public key assigned to the FIOSDK instance.

Returns string
- Defined in src/FIOSDK.ts:1071

getGranteePermissions

getGranteePermissions(granteeAccount, limit?, offset?): Promise<PermissionsResponse>
Parameters
- granteeAccount: string
  string account name of the grantee account
- Optionallimit: number
  Number of request to return. If omitted, all requests will be returned.
- Optionaloffset: number
  First request from list to return. If omitted, 0 is assumed.
Returns Promise<PermissionsResponse>
Deprecated
Gets FIO permissions for the specified grantee account.
- Defined in src/FIOSDK.ts:1972
getGranteePermissions(options): Promise<PermissionsResponse>
Gets FIO permissions for the specified grantee account.
Parameters
- options: GetGranteePermissionsOptions
Returns Promise<PermissionsResponse>
- Defined in src/FIOSDK.ts:1984

getGrantorPermissions

getGrantorPermissions(grantorAccount, limit?, offset?): Promise<PermissionsResponse>
Parameters
- grantorAccount: string
  string account name of the grantor account
- Optionallimit: null | number
  Number of request to return. If omitted, all requests will be returned.
- Optionaloffset: null | number
  First request from list to return. If omitted, 0 is assumed.
Returns Promise<PermissionsResponse>
Deprecated
Gets FIO permissions for the specified grantor account.
- Defined in src/FIOSDK.ts:2002
getGrantorPermissions(options): Promise<PermissionsResponse>
Gets FIO permissions for the specified grantor account.
Parameters
- options: GetGrantorPermissionsOptions
Returns Promise<PermissionsResponse>
- Defined in src/FIOSDK.ts:2014

getLocks

getLocks(fioPublicKey): Promise<LocksResponse>
Parameters
- fioPublicKey: string
  FIO public key.
Returns Promise<LocksResponse>
Deprecated
Retrieves info on locks for this pub key
- Defined in src/FIOSDK.ts:2137
getLocks(options): Promise<LocksResponse>
Retrieves info on locks for this pub key
Parameters
- options: GetLocksOptions
Returns Promise<LocksResponse>
- Defined in src/FIOSDK.ts:2143

getMultiplier

getMultiplier(): number
Returns number
- Defined in src/FIOSDK.ts:2994

getNfts

getNfts(options, limit?, offset?): Promise<NftsResponse>
Parameters
- options: {
      chainCode?: null | string;
      contractAddress?: null | string;
      fioAddress?: null | string;
      hash?: null | string;
      tokenId?: null | string;
  }
  Detects the way how to get the data.
  - OptionalchainCode?: null | string
    Chain code where NFT contract resides.
  - OptionalcontractAddress?: null | string
    NFT contract address.
  - OptionalfioAddress?: null | string
    FIO Address.
  - Optionalhash?: null | string
    SHA-256 hash of NFT asset, e.g. media url.
  - OptionaltokenId?: null | string
    NFT token ID.
- Optionallimit: null | number
  Number of records to return. If omitted, all records will be returned. Due to table read timeout, a value of less than 1,000 is recommended.
- Optionaloffset: null | number
  First record from list to return. If omitted, 0 is assumed.
Returns Promise<NftsResponse>
Deprecated
Returns all mapped NFTs which have the specified contract address and token id or FIO Address or hash.
- Defined in src/FIOSDK.ts:2458
getNfts(options): Promise<NftsResponse>
Returns all mapped NFTs which have the specified contract address and token id or FIO Address or hash.
Parameters
- options: GetNftsOptions
  Detects the way how to get the data.
Returns Promise<NftsResponse>
- Defined in src/FIOSDK.ts:2482

getObjectPermissions

getObjectPermissions(permissionName, objectName, limit?, offset?): Promise<PermissionsResponse>
Parameters
- permissionName: string
  string permission name ex register_address_on_domain
- objectName: string
- Optionallimit: null | number
  Number of request to return. If omitted, all requests will be returned.
- Optionaloffset: null | number
  First request from list to return. If omitted, 0 is assumed.
Returns Promise<PermissionsResponse>
Deprecated
Gets FIO permissions for the specified permission name and object name account.
- Defined in src/FIOSDK.ts:2033
getObjectPermissions(options): Promise<PermissionsResponse>
Gets FIO permissions for the specified permission name and object name account.
Parameters
- options: GetObjectPermissionsOptions
Returns Promise<PermissionsResponse>
- Defined in src/FIOSDK.ts:2047

getObtData

getObtData(options): Promise<GetObtDataDecryptedResponse>
Retrieves OBT metadata data stored using record send.
Parameters
- options: GetObtDataOptions
Returns Promise<GetObtDataDecryptedResponse>
- Defined in src/FIOSDK.ts:1954

getOracleFees

getOracleFees(publicKey?): Promise<FioOracleFeesResponse>
Parameters
- OptionalpublicKey: null | string
Returns Promise<FioOracleFeesResponse>
Deprecated
Return oracle fees amount
- Defined in src/FIOSDK.ts:2601
getOracleFees(options): Promise<FioOracleFeesResponse>
Parameters
- options: GetOracleFeesOptions
Returns Promise<FioOracleFeesResponse>
- Defined in src/FIOSDK.ts:2603

getPendingFioRequests

getPendingFioRequests(options): Promise<undefined | PendingFioRequestsDecryptedResponse>
Polls for any pending requests sent to public key associated with the FIO SDK instance.
Parameters
- options: GetPendingFioRequestsOptions
Returns Promise<undefined | PendingFioRequestsDecryptedResponse>
- Defined in src/FIOSDK.ts:2293

getPublicAddress

getPublicAddress(fioAddress, chainCode, tokenCode): Promise<PublicAddressResponse>
Parameters
- fioAddress: string
  FIO Address for which the token public address is to be returned.
- chainCode: string
  Blockchain code for which public address is to be returned.
- tokenCode: string
  Token code for which public address is to be returned.
Returns Promise<PublicAddressResponse>
Deprecated
Returns a token public address for specified token code and FIO Address.
- Defined in src/FIOSDK.ts:2371
getPublicAddress(options): Promise<PublicAddressResponse>
Returns a token public address for specified token code and FIO Address.
Parameters
- options: GetPublicAddressOptions
Returns Promise<PublicAddressResponse>
- Defined in src/FIOSDK.ts:2383

getPublicAddresses

getPublicAddresses(fioAddress, limit?, offset?): Promise<PublicAddressesResponse>
Parameters
- fioAddress: string
  FIO Address for which the token public address is to be returned.
- Optionallimit: null | number
  Number of results to return. If omitted, all results will be returned.
- Optionaloffset: null | number
  First result from list to return. If omitted, 0 is assumed.
Returns Promise<PublicAddressesResponse>
Deprecated
Returns all public addresses for specified FIO Address.
- Defined in src/FIOSDK.ts:2401
getPublicAddresses(options): Promise<PublicAddressesResponse>
Returns all public addresses for specified FIO Address.
Parameters
- options: GetPublicAddressesOptions
Returns Promise<PublicAddressesResponse>
- Defined in src/FIOSDK.ts:2413

getReceivedFioRequests

getReceivedFioRequests(options): Promise<undefined | ReceivedFioRequestsDecryptedResponse>
Polls for any received requests sent to public key associated with the FIO SDK instance.
Parameters
- options: GetReceivedFioRequestsOptions
Returns Promise<undefined | ReceivedFioRequestsDecryptedResponse>
- Defined in src/FIOSDK.ts:2313

getSentFioRequests

getSentFioRequests(options): Promise<undefined | SentFioRequestsDecryptedResponse>
Polls for any sent requests sent by public key associated with the FIO SDK instance.
Parameters
- options: GetSentFioRequestsOptions
Returns Promise<undefined | SentFioRequestsDecryptedResponse>
- Defined in src/FIOSDK.ts:2333

getTechnologyProviderId

getTechnologyProviderId(technologyProviderId?): string
Returns technologyProviderId or default
Parameters
- OptionaltechnologyProviderId: null | string
Returns string
- Defined in src/FIOSDK.ts:1078

isAvailable

isAvailable(fioName): Promise<AvailabilityResponse>
Parameters
- fioName: string
  FIO Address or FIO Domain to check.
Returns Promise<AvailabilityResponse>
Deprecated
Checks if a FIO Address or FIO Domain is available for registration.
- Defined in src/FIOSDK.ts:2175
isAvailable(options): Promise<AvailabilityResponse>
Checks if a FIO Address or FIO Domain is available for registration.
Parameters
- options: IsAvailableOptions
Returns Promise<AvailabilityResponse>
- Defined in src/FIOSDK.ts:2181

pushTransaction

pushTransaction(options): Promise<any>
Allows advance user to send their own content directly to FIO contracts
Parameters
- options: PushTransactionOptions
Returns Promise<any>
- Defined in src/FIOSDK.ts:3008

recordObtData

recordObtData(options): Promise<RecordObtDataResponse>
Records information on the FIO blockchain about a transaction that occurred on other blockchain, i.e. 1 BTC was sent on Bitcoin Blockchain, and both sender and receiver have FIO Addresses. OBT stands for Other Blockchain Transaction
Parameters
- options: RecordObtDataOptions
Returns Promise<RecordObtDataResponse>
- Defined in src/FIOSDK.ts:1929

registerFioAddress

registerFioAddress(fioAddress, maxFee, technologyProviderId?, expirationOffset?): Promise<RegisterFioAddressResponse>
Parameters
- fioAddress: string
  FIO Address to register.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
- OptionalexpirationOffset: null | number
  Expiration time offset for this transaction in seconds. Default is 180 seconds. Increasing number of seconds gives transaction more lifetime term.
Returns Promise<RegisterFioAddressResponse>
Deprecated
Registers a FIO Address on the FIO blockchain. The owner will be the public key associated with the FIO SDK instance.
- Defined in src/FIOSDK.ts:1127
registerFioAddress(options): Promise<RegisterFioAddressResponse>
Registers a FIO Address on the FIO blockchain. The owner will be the public key associated with the FIO SDK instance.
Parameters
- options: RegisterFioAddressOptions
Returns Promise<RegisterFioAddressResponse>
- Defined in src/FIOSDK.ts:1144

registerFioDomain

registerFioDomain(fioDomain, maxFee, technologyProviderId?, expirationOffset?): Promise<RegisterFioDomainResponse>
Parameters
- fioDomain: string
  FIO Domain to register. The owner will be the public key associated with the FIO SDK instance.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
- OptionalexpirationOffset: null | number
  Expiration time offset for this transaction in seconds. Default is 180 seconds. Increasing number of seconds gives transaction more lifetime term.
Returns Promise<RegisterFioDomainResponse>
Deprecated
Registers a FIO Domain on the FIO blockchain.
- Defined in src/FIOSDK.ts:1257
registerFioDomain(options): Promise<RegisterFioDomainResponse>
Registers a FIO Domain on the FIO blockchain.
Parameters
- options: RegisterFioDomainOptions
Returns Promise<RegisterFioDomainResponse>
- Defined in src/FIOSDK.ts:1275

registerFioDomainAddress

registerFioDomainAddress(options): Promise<RegisterFioAddressResponse>
Registers a FIO Address and FIO domain on behalf of the owner FIO Public key parameter. Owner FIO Public key owns the FIO address
Parameters
- options: RegisterFioDomainAddressOptions
Returns Promise<RegisterFioAddressResponse>
- Defined in src/FIOSDK.ts:1229

registerOwnerFioAddress

registerOwnerFioAddress(fioAddress, ownerPublicKey, maxFee, technologyProviderId?, expirationOffset?): Promise<RegisterFioAddressResponse>
Parameters
- fioAddress: string
  FIO Address to register.
- ownerPublicKey: string
  Owner FIO Public Key.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
- OptionalexpirationOffset: null | number
  Expiration time offset for this transaction in seconds. Default is 180 seconds. Increasing number of seconds gives transaction more lifetime term.
Returns Promise<RegisterFioAddressResponse>
Deprecated
Registers a Fio Address on behalf of the owner FIO Public key parameter. Owner FIO Public key owns the FIO address
- Defined in src/FIOSDK.ts:1175
registerOwnerFioAddress(options): Promise<RegisterFioAddressResponse>
Registers a Fio Address on behalf of the owner FIO Public key parameter. Owner FIO Public key owns the FIO address
Parameters
- options: RegisterOwnerFioAddressOptions
Returns Promise<RegisterFioAddressResponse>
- Defined in src/FIOSDK.ts:1194

registerOwnerFioDomain

registerOwnerFioDomain(fioDomain, ownerPublicKey, maxFee, technologyProviderId?, expirationOffset?): Promise<RegisterFioDomainResponse>
Parameters
- fioDomain: string
  FIO Domain to register. The owner will be the public key associated with the FIO SDK instance.
- ownerPublicKey: string
  Owner FIO Public Key.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
- OptionalexpirationOffset: null | number
  Expiration time offset for this transaction in seconds. Default is 180 seconds. Increasing number of seconds gives transaction more lifetime term.
Returns Promise<RegisterFioDomainResponse>
Deprecated
Registers a FIO Domain on behalf of the owner FIO Public key parameter. Owner FIO Public key owns the FIO domain.
- Defined in src/FIOSDK.ts:1303
registerOwnerFioDomain(options): Promise<RegisterFioDomainResponse>
Registers a FIO Domain on behalf of the owner FIO Public key parameter. Owner FIO Public key owns the FIO domain.
Parameters
- options: RegisterOwnerFioDomainOptions
Returns Promise<RegisterFioDomainResponse>
- Defined in src/FIOSDK.ts:1322

rejectFundsRequest

rejectFundsRequest(fioRequestId, maxFee, technologyProviderId?): Promise<RejectFundsResponse>
Parameters
- fioRequestId: number
  Existing funds requestId
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<RejectFundsResponse>
Deprecated
Reject funds request.
- Defined in src/FIOSDK.ts:2066
rejectFundsRequest(options): Promise<RejectFundsResponse>
Reject funds request.
Parameters
- options: RejectFundsRequestOptions
Returns Promise<RejectFundsResponse>
- Defined in src/FIOSDK.ts:2079

removeAllPublicAddresses

removeAllPublicAddresses(fioAddress, maxFee, technologyProviderId?): Promise<RemoveAllPublicAddressesResponse>
Parameters
- fioAddress: string
  FIO Address which will be mapped to public address.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<RemoveAllPublicAddressesResponse>
Deprecated
This call allows a user to remove all addresses from the specified FIO Address, all addresses except the FIO address will be removed.
- Defined in src/FIOSDK.ts:1786
removeAllPublicAddresses(options): Promise<RemoveAllPublicAddressesResponse>
This call allows a user to remove all addresses from the specified FIO Address, all addresses except the FIO address will be removed.
Parameters
- options: RemoveAllPublicAddressesOptions
Returns Promise<RemoveAllPublicAddressesResponse>
- Defined in src/FIOSDK.ts:1800

removePublicAddresses

removePublicAddresses(fioAddress, publicAddresses, maxFee, technologyProviderId?): Promise<RemovePublicAddressesResponse>
Parameters
- fioAddress: string
  FIO Address which will be mapped to public address.
- publicAddresses: PublicAddress[]
  a list of publicAddresses, each containing chain_code, token_code, and public_address.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<RemovePublicAddressesResponse>
Deprecated
This call allows an any number of public addresses matching the blockchain code, the token code and the public address to be removed from the FIO Address.
- Defined in src/FIOSDK.ts:1693
removePublicAddresses(options): Promise<RemovePublicAddressesResponse>
This call allows an any number of public addresses matching the blockchain code, the token code and the public address to be removed from the FIO Address.
Parameters
- options: RemovePublicAddressesOptions
Returns Promise<RemovePublicAddressesResponse>
- Defined in src/FIOSDK.ts:1710

renewFioAddress

renewFioAddress(fioAddress, maxFee, technologyProviderId?): Promise<RenewFioAddressResponse>
Parameters
- fioAddress: string
  FIO Address to renew.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<RenewFioAddressResponse>
Deprecated
Renew a FIO Address on the FIO blockchain.
- Defined in src/FIOSDK.ts:1520
renewFioAddress(options): Promise<RenewFioAddressResponse>
Renew a FIO Address on the FIO blockchain.
Parameters
- options: RenewFioAddressOptions
Returns Promise<RenewFioAddressResponse>
- Defined in src/FIOSDK.ts:1533

renewFioDomain

renewFioDomain(fioDomain, maxFee, technologyProviderId?, expirationOffset?): Promise<RenewFioDomainResponse>
Parameters
- fioDomain: string
  FIO Domain to renew.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
- OptionalexpirationOffset: null | number
  Expiration time offset for this transaction in seconds. Default is 180 seconds. Increasing number of seconds gives transaction more lifetime term.
Returns Promise<RenewFioDomainResponse>
Deprecated
Renew a FIO Domain on the FIO blockchain.
- Defined in src/FIOSDK.ts:1560
renewFioDomain(options): Promise<RenewFioDomainResponse>
Renew a FIO Domain on the FIO blockchain.
Parameters
- options: RenewFioDomainOptions
Returns Promise<RenewFioDomainResponse>
- Defined in src/FIOSDK.ts:1576

requestFunds

requestFunds(options): Promise<RequestFundsResponse>
Create a new funds request on the FIO chain.
Parameters
- options: RequestFundsOptions
Returns Promise<RequestFundsResponse>
- Defined in src/FIOSDK.ts:2115

setApiUrls

setApiUrls(apiUrls): void
Set transactions baseUrls
Parameters
- apiUrls: string[]
Returns void
- Defined in src/FIOSDK.ts:1094

setFioDomainVisibility

setFioDomainVisibility(fioDomain, isPublic, maxFee, technologyProviderId?): Promise<SetFioDomainVisibilityResponse>
Parameters
- fioDomain: string
  FIO Domain to change visibility.
- isPublic: boolean
  true - allows anyone to register FIO Address, false - only owner of domain can register FIO Address.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<SetFioDomainVisibilityResponse>
Deprecated
By default, all FIO Domains are non-public, meaning only the owner can register FIO Addresses on that domain. Setting them to public allows anyone to register a FIO Address on that domain.
- Defined in src/FIOSDK.ts:1870
setFioDomainVisibility(options): Promise<SetFioDomainVisibilityResponse>
By default, all FIO Domains are non-public, meaning only the owner can register FIO Addresses on that domain. Setting them to public allows anyone to register a FIO Address on that domain.
Parameters
- options: SetFioDomainVisibilityOptions
Returns Promise<SetFioDomainVisibilityResponse>
- Defined in src/FIOSDK.ts:1888

setSignedTrxReturnOption

setSignedTrxReturnOption(returnPreparedTrx): void
Set returnPreparedTrx
Parameters
- returnPreparedTrx: boolean
Returns void
- Defined in src/FIOSDK.ts:1087

stakeFioTokens

stakeFioTokens(amount, fioAddress?, maxFee?, technologyProviderId?): Promise<TransactionResponse>
Parameters
- amount: number
  Amount of SUFs to stake.
- OptionalfioAddress: null | string
  FIO Address if using bundled transactions to pay. May be left empty if paying a fee instead.
- OptionalmaxFee: null | number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the entity which generates this transaction. TPID rewards will be paid to this address. Set to empty if not known.
Returns Promise<TransactionResponse>
Deprecated
Stake FIO Tokens.
- Defined in src/FIOSDK.ts:2892
stakeFioTokens(options): Promise<TransactionResponse>
Stake FIO Tokens.
Parameters
- options: StakeFioTokensOptions
Returns Promise<TransactionResponse>
- Defined in src/FIOSDK.ts:2909

transferFioAddress

transferFioAddress(fioAddress, newOwnerKey, maxFee, technologyProviderId?): Promise<TransferFioAddressResponse>
Parameters
- fioAddress: string
  FIO Address to transfer. The owner will be the public key associated with the FIO SDK instance.
- newOwnerKey: string
  FIO Public Key of the new owner.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<TransferFioAddressResponse>
Deprecated
Transfers a FIO Address on the FIO blockchain.
- Defined in src/FIOSDK.ts:1427
transferFioAddress(options): Promise<TransferFioAddressResponse>
Transfers a FIO Address on the FIO blockchain.
Parameters
- options: TransferFioAddressOptions
Returns Promise<TransferFioAddressResponse>
- Defined in src/FIOSDK.ts:1443

transferFioDomain

transferFioDomain(fioDomain, newOwnerKey, maxFee, technologyProviderId?): Promise<TransferFioDomainResponse>
Parameters
- fioDomain: string
  FIO Domain to transfer. The owner will be the public key associated with the FIO SDK instance.
- newOwnerKey: string
  FIO Public Key of the new owner.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<TransferFioDomainResponse>
Deprecated
Transfers a FIO Domain on the FIO blockchain.
- Defined in src/FIOSDK.ts:1385
transferFioDomain(options): Promise<TransferFioDomainResponse>
Transfers a FIO Domain on the FIO blockchain.
Parameters
- options: TransferFioDomainOptions
Returns Promise<TransferFioDomainResponse>
- Defined in src/FIOSDK.ts:1401

transferLockedTokens

transferLockedTokens(payeePublicKey, canVote, periods, amount, maxFee, technologyProviderId?): Promise<TransferLockedTokensResponse>
Parameters
- payeePublicKey: string
  this is the fio public key for the user to receive locked tokens.
- canVote: boolean
  true if these locked tokens can be voted, false if these locked tokens are not to be voted.
- periods: LockPeriod[]
  this is an array of lock periods defining the duration and percent of each period, must be in time order.
- amount: number
  this is the amount in SUFs to be transferred.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<TransferLockedTokensResponse>
Deprecated
This call allows a user to transfer locked tokens to the specified fio public key
- Defined in src/FIOSDK.ts:1739
transferLockedTokens(options): Promise<TransferLockedTokensResponse>
This call allows a user to transfer locked tokens to the specified fio public key
Parameters
- options: TransferLockedTokensOptions
Returns Promise<TransferLockedTokensResponse>
- Defined in src/FIOSDK.ts:1760

transferTokens

transferTokens(payeeFioPublicKey, amount, maxFee, technologyProviderId?): Promise<TransferTokensResponse>
Parameters
- payeeFioPublicKey: string
  FIO public Address of the one receiving the tokens.
- amount: number
  Amount sent in SUFs.
- maxFee: number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the wallet which generates this transaction.
Returns Promise<TransferTokensResponse>
Deprecated
Transfers FIO tokens from public key associated with the FIO SDK instance to the payeePublicKey.
- Defined in src/FIOSDK.ts:2543
transferTokens(options): Promise<TransferTokensResponse>
Transfers FIO tokens from public key associated with the FIO SDK instance to the payeePublicKey.
Parameters
- options: TransferTokensOptions
Returns Promise<TransferTokensResponse>
- Defined in src/FIOSDK.ts:2559

unStakeFioTokens

unStakeFioTokens(amount, fioAddress?, maxFee?, technologyProviderId?): Promise<TransactionResponse>
Parameters
- amount: number
  Amount of SUFs to unstake.
- OptionalfioAddress: null | string
  FIO Address if using bundled transactions to pay. May be left empty if paying a fee instead.
- OptionalmaxFee: null | number
  Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
- OptionaltechnologyProviderId: null | string
  FIO Address of the entity which generates this transaction. TPID rewards will be paid to this address. Set to empty if not known.
Returns Promise<TransactionResponse>
Deprecated
Unstake FIO Tokens.
- Defined in src/FIOSDK.ts:2948
unStakeFioTokens(options): Promise<TransactionResponse>
Unstake FIO Tokens.
Parameters
- options: UnStakeFioTokensOptions
Returns Promise<TransactionResponse>
- Defined in src/FIOSDK.ts:2965

validateChainCode

validateChainCode(chainCode): boolean
Is the Chain Code Valid?
Parameters
- chainCode: string
Returns boolean
Chain Code is Valid
- Defined in src/FIOSDK.ts:949

validateFioAddress

validateFioAddress(fioAddress): boolean
Is the FIO Address Valid?
Parameters
- fioAddress: string
Returns boolean
Fio Address is Valid
- Defined in src/FIOSDK.ts:991

validateFioDomain

validateFioDomain(fioDomain): boolean
Is the FIO Domain Valid?
Parameters
- fioDomain: string
Returns boolean
FIO Domain is Valid
- Defined in src/FIOSDK.ts:1012

validateFioPublicKey

validateFioPublicKey(fioPublicKey): boolean
Is the FIO Public Key Valid?
Parameters
- fioPublicKey: string
Returns boolean
FIO Public Key is Valid
- Defined in src/FIOSDK.ts:1033

validatePublicAddress

validatePublicAddress(publicAddress): boolean
Is the Public Address Valid?
Parameters
- publicAddress: string
Returns boolean
Public Address is Valid
- Defined in src/FIOSDK.ts:1054

validateTokenCode

validateTokenCode(tokenCode): boolean
Is the Token Code Valid?
Parameters
- tokenCode: string
Returns boolean
Token Code is Valid
- Defined in src/FIOSDK.ts:970

`Static`SUFToAmount

SUFToAmount(suf): number
Convert FIO SUFs to a FIO Token amount
Parameters
- suf: string | number
  {string | number}
Returns number
FIO Token amount
- Defined in src/FIOSDK.ts:672

`Static`SUFToAmountString

SUFToAmountString(suf): string
Convert FIO SUFs to a FIO Token amount
Parameters
- suf: string | number
  {string | number}
Returns string
FIO Token amount
- Defined in src/FIOSDK.ts:710

`Static`accountHash

accountHash(fioPublicKey): {
accountnm: string;
}
hash a pub key
Parameters
- fioPublicKey: string
  FIO private key.
Returns {
accountnm: string;
}
FIO account derived from pub key.
- accountnm: string
- Defined in src/FIOSDK.ts:534

`Static`amountToSUF

amountToSUF(amount): number
Convert a FIO Token Amount to FIO SUFs
Parameters
- amount: number
  2.568 FIO should be 2568000000 SUFs
Returns number
FIO SUFs
- Defined in src/FIOSDK.ts:650

`Static`amountToSUFString

amountToSUFString(amount): string
Convert a FIO Token Amount to FIO SUFs
Parameters
- amount: string | number
  2.568 FIO should be 2568000000 SUFs
Returns string
FIO SUFs
- Defined in src/FIOSDK.ts:685

`Static`createPrivateKeyMnemonic

createPrivateKeyMnemonic(mnemonic): Promise<{
fioKey: any;
mnemonic: string;
}>
Create a FIO private key.

Private key generation in the SDK is available for testing purposes only. Do not generate private keys for production application using this method. Instead pass securely generated private keys or seed phrase to the SDK constructor.
Parameters
- mnemonic: string
  mnemonic used to generate a random unique private key.
Returns Promise<{
fioKey: any;
mnemonic: string;
}>
New FIO private key
Example
```
real flame win provide layer trigger soda erode upset rate beef wrist fame design merit
```
- Defined in src/FIOSDK.ts:503

`Static`derivedPublicKey

derivedPublicKey(fioPrivateKey): {
publicKey: string;
}
Create a FIO public key.
Parameters
- fioPrivateKey: string
  FIO private key.
Returns {
publicKey: string;
}
FIO public key derived from the FIO private key.
- publicKey: string
- Defined in src/FIOSDK.ts:522

`Static`isChainCodeValid

isChainCodeValid(chainCode): true
Parameters
- chainCode: string
Returns true
Chain Code is Valid

Deprecated
use FIOSDK#validateChainCode Is the Chain Code Valid?
- Defined in src/FIOSDK.ts:547

`Static`isFioAddressValid

isFioAddressValid(fioAddress): true
Parameters
- fioAddress: string
Returns true
Fio Address is Valid

Deprecated
use FIOSDK#validateFioAddress Is the FIO Address Valid?
- Defined in src/FIOSDK.ts:581

`Static`isFioDomainValid

isFioDomainValid(fioDomain): true
Parameters
- fioDomain: string
Returns true
FIO Domain is Valid

Deprecated
use FIOSDK#validateFioDomain Is the FIO Domain Valid?
- Defined in src/FIOSDK.ts:598

`Static`isFioPublicKeyValid

isFioPublicKeyValid(fioPublicKey): true
Parameters
- fioPublicKey: string
Returns true
FIO Public Key is Valid

Deprecated
use FIOSDK#validateFioPublicKey Is the FIO Public Key Valid?
- Defined in src/FIOSDK.ts:615

`Static`isPublicAddressValid

isPublicAddressValid(publicAddress): true
Parameters
- publicAddress: string
Returns true
Public Address is Valid

Deprecated
use FIOSDK#validatePublicAddress Is the Public Address Valid?
- Defined in src/FIOSDK.ts:632

`Static`isTokenCodeValid

isTokenCodeValid(tokenCode): true
Parameters
- tokenCode: string
Returns true
Token Code is Valid

Deprecated
use FIOSDK#validateTokenCode Is the Token Code Valid?
- Defined in src/FIOSDK.ts:564

`Static`setRawAbiMissingWarnings

setRawAbiMissingWarnings(rawAbiName, fioSdkInstance): void
Set stored raw abi missing warnings
Parameters
- rawAbiName: string
- fioSdkInstance: FIOSDK
Returns void
- Defined in src/FIOSDK.ts:717

Class FIOSDK

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FIOSDK

Deprecated

Parameters

Returns FIOSDK

Properties

config

privateKey

publicKey

rawAbiMissingWarnings

technologyProviderId

StaticSUFUnit

StaticrawAbiMissingWarnings

Accessors

transactions

createRawTransaction: ((__namedParameters: { account: Account; action: Action; authPermission?: string; chainData?: { expiration: string; ref_block_num: number; ref_block_prefix: number; }; data: any; publicKey?: string; signingAccount?: string; }) => Promise<RawRequest>)

Parameters

account: Account

action: Action

OptionalauthPermission?: string

OptionalchainData?: { expiration: string; ref_block_num: number; ref_block_prefix: number; }

expiration: string

ref_block_num: number

ref_block_prefix: number

data: any

OptionalpublicKey?: string

OptionalsigningAccount?: string

Returns Promise<RawRequest>

deserialize: ((__namedParameters: { abiMap?: Map<string, any>; chainId: string; serializedTransaction: Uint8Array; textDecoder?: TextDecoder; textEncoder?: TextEncoder; }) => Promise<RawRequest>)

Parameters

OptionalabiMap?: Map<string, any>

chainId: string

serializedTransaction: Uint8Array

OptionaltextDecoder?: TextDecoder

OptionaltextEncoder?: TextEncoder

Returns Promise<RawRequest>

getActor: ((publicKey?: string) => string)

Parameters

Returns string

getBlock: ((chain: FioInfoResponse) => Promise<GetBlockResult>)

Parameters

Returns Promise<GetBlockResult>

getChainDataForTx: (() => Promise<{ chain_id: string; expiration: string; ref_block_num: number; ref_block_prefix: number; }>)

Returns Promise<{ chain_id: string; expiration: string; ref_block_num: number; ref_block_prefix: number; }>

getChainInfo: (() => Promise<FioInfoResponse>)

Returns Promise<FioInfoResponse>

getCipherContent: ((contentType: ContentType, content: any, privateKey: string, publicKey: string) => string)

Parameters

Returns string

getUnCipherContent: (<T>(contentType: ContentType, content: string, privateKey: string, publicKey: string) => T)

Type Parameters

Parameters

Returns T

serialize: ((__namedParameters: { abiMap?: Map<string, any>; chainId: string; textDecoder?: TextDecoder; textEncoder?: TextEncoder; transaction: RawRequest; }) => Promise<PushTransactionArgs>)

Parameters

OptionalabiMap?: Map<string, any>

chainId: string

OptionaltextDecoder?: TextDecoder

OptionaltextEncoder?: TextEncoder

transaction: RawRequest

Returns Promise<PushTransactionArgs>

StaticabiMap

Returns ApiMap

Methods

addBundledTransactions

Parameters

Returns Promise<AddBundledTransactionsResponse>

Deprecated

Parameters

Returns Promise<AddBundledTransactionsResponse>

addPublicAddress

Parameters

`Static`SUFUnit

`Static`rawAbiMissingWarnings

createRawTransaction: ((__namedParameters: {
account: Account;
action: Action;
authPermission?: string;
chainData?: {
expiration: string;
ref_block_num: number;
ref_block_prefix: number;
};
data: any;
publicKey?: string;
signingAccount?: string;
}) => Promise<RawRequest>)

`Optional`authPermission?: string

`Optional`chainData?: {
expiration: string;
ref_block_num: number;
ref_block_prefix: number;
}

`Optional`publicKey?: string

`Optional`signingAccount?: string

deserialize: ((__namedParameters: {
abiMap?: Map<string, any>;
chainId: string;
serializedTransaction: Uint8Array;
textDecoder?: TextDecoder;
textEncoder?: TextEncoder;
}) => Promise<RawRequest>)

`Optional`abiMap?: Map<string, any>

`Optional`textDecoder?: TextDecoder

`Optional`textEncoder?: TextEncoder

getChainDataForTx: (() => Promise<{
chain_id: string;
expiration: string;
ref_block_num: number;
ref_block_prefix: number;
}>)

Returns Promise<{
chain_id: string;
expiration: string;
ref_block_num: number;
ref_block_prefix: number;
}>

serialize: ((__namedParameters: {
abiMap?: Map<string, any>;
chainId: string;
textDecoder?: TextDecoder;
textEncoder?: TextEncoder;
transaction: RawRequest;
}) => Promise<PushTransactionArgs>)

`Optional`abiMap?: Map<string, any>

`Optional`textDecoder?: TextDecoder

`Optional`textEncoder?: TextEncoder

`Static`abiMap