the fio private key of the client sending requests to FIO API.
the fio public key of the client sending requests to FIO API.
the url to the FIO API.
the module to use for HTTP Post/Get calls (see above for example)
the url to the mock server
Default FIO Address of the wallet which generates transactions.
the fio private key of the client sending requests to FIO API.
the fio public key of the client sending requests to FIO API.
Default FIO Address of the wallet which generates transactions.
SUFs = Smallest Units of FIO
This call allows a public address of the specific blockchain type to be added to the FIO Address.
FIO Address which will be mapped to public address.
Blockchain code for blockchain hosting this token.
Token code to be used with that public address.
The public address to be added to the FIO Address for the specified token.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
FIO Address of the wallet which generates this transaction.
This call allows a public addresses of the specific blockchain type to be added to the FIO Address.
FIO Address which will be mapped to public addresses.
Array of public addresses to be added to the FIO Address for the specified token.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
FIO Address of the wallet which generates this transaction.
Compute and return fee amount for specific call and specific user
Name of API call end point, e.g. add_pub_address.
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
Compute and return fee amount for specific call and specific user
FIO Address incurring the fee and owned by signer.
Compute and return fee amount for specific call and specific user
Payee FIO Address incurring the fee and owned by signer.
Compute and return fee amount for specific call and specific user
Compute and return fee amount for specific call and specific user
Payer FIO Address incurring the fee and owned by signer.
Retrieves balance of FIO tokens
FIO public key.
Returns FIO Addresses and FIO Domains owned by this public key.
FIO public key of owner.
Returns the FIO token public address for specified FIO Address.
FIO Address for which fio token public address is to be returned.
Retrieves the FIO public key assigned to the FIOSDK instance.
Retrives OBT metadata data stored using record send.
Number of request to return. If omitted, all requests will be returned.
First request from list to return. If omitted, 0 is assumed.
Code of the token to filter results
Polls for any pending requests sent to public key associated with the FIO SDK instance.
Number of request to return. If omitted, all requests will be returned.
First request from list to return. If omitted, 0 is assumed.
Returns a token public address for specified token code and FIO Address.
FIO Address for which the token public address is to be returned.
Blockchain code for which public address is to be returned.
Token code for which public address is to be returned.
Polls for any sent requests sent by public key associated with the FIO SDK instance.
Number of request to return. If omitted, all requests will be returned.
First request from list to return. If omitted, 0 is assumed.
Returns technologyProviderId or default
Checks if a FIO Address or FIO Domain is available for registration.
FIO Address or FIO Domain to check.
Allows advance user to send their own content directly to FIO contracts
Account name
Name of action
JSON object with params for action
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
ID of funds request, if this Record Send transaction is in response to a previously received funds request. Send empty if no FIO Request ID
FIO Address of the payer. This address initiated payment.
FIO Address of the payee. This address is receiving payment.
Public address on other blockchain of user sending funds.
Public address on other blockchain of user receiving funds.
Amount sent.
Blockchain code for blockchain hosting this token.
Code of the token represented in Amount requested, i.e. BTC.
Status of this OBT. Allowed statuses are: sent_to_blockchain.
Other Blockchain Transaction ID (OBT ID), i.e Bitcoin transaction ID.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
FIO Address of the wallet which generates this transaction.
Public address on other blockchain of user receiving funds.
Registers a FIO Address on the FIO blockchain. The owner will be the public key associated with the FIO SDK instance.
FIO Address to register.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
FIO Address of the wallet which generates this transaction.
Registers a FIO Domain on the FIO blockchain.
FIO Domain to register. The owner will be the public key associated with the FIO SDK instance.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
FIO Address of the wallet which generates this transaction.
Registers a Fio Address on behalf of the owner FIO Public key parameter. Owner FIO Public key owns the FIO address
FIO Address to register.
Owner FIO Public Key.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
FIO Address of the wallet which generates this transaction.
Reject funds request.
Existing funds request Id
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by [getFee] for correct value.
FIO Address of the wallet which generates this transaction.
Renew a FIO Address on the FIO blockchain.
FIO Address to renew.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
FIO Address of the wallet which generates this transaction.
Renew a FIO Domain on the FIO blockchain.
FIO Domain to renew.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by @ [getFee] for correct value.
FIO Address of the wallet which generates this transaction.
Create a new funds request on the FIO chain.
FIO Address of the payer. This address will receive the request and will initiate payment.
FIO Address of the payee. This address is sending the request and will receive payment.
Payee's public address where they want funds sent.
Amount requested.
Blockchain code for blockchain hosting this token.
Code of the token represented in amount requested.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by [getFee] for correct value.
Public address on other blockchain of user sending funds.
FIO Address of the wallet which generates this transaction.
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.
FIO Domain to change visibility.
1 - allows anyone to register FIO Address, 0 - only owner of domain can register FIO Address.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
FIO Address of the wallet which generates this transaction.
Transfers FIO tokens from public key associated with the FIO SDK instance to the payeePublicKey.
FIO public Address of the one receiving the tokens.
Amount sent in SUFs.
Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.
FIO Address of the wallet which generates this transaction.
Convert FIO SUFs to a FIO Token amount
FIO Token amount
Convert a FIO Token Amount to FIO SUFs
2.568 FIO should be 2568000000 SUFs
FIO SUFs
Create a FIO private key.
mnemonic used to generate a random unique private key.
New FIO private key
Create a FIO public key.
FIO private key.
FIO public key derived from the FIO private key.
Is the Chain Code Valid?
Chain Code is Valid
Is the FIO Address Valid?
Fio Address is Valid
Is the FIO Domain Valid?
FIO Domain is Valid
Is the FIO Public Key Valid?
FIO Public Key is Valid
Is the Public Address Valid?
Public Address is Valid
Is the Token Code Valid?
Token Code is Valid
Generated using TypeDoc
// how to instantiate fetchJson parameter i.e. fetch = require('node-fetch')
const fetchJson = async (uri, opts = {}) => { return fetch(uri, opts) }