ternoa-js

Functions

batchAllTx

batchAllTx(txHexes: `0x${string}`[]): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>

- Defined in blockchain/index.ts:284
name
batchAllTx

summary
Create a batchAll transaction of dispatch calls.

Parameters
- txHexes: `0x${string}`[]
  
  Transactions to execute in the batch call
Returns Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>
Submittable extrinsic unsigned

batchAllTxHex

batchAllTxHex(txHexes: `0x${string}`[]): Promise<`0x${string}`>

- Defined in blockchain/index.ts:296
name
batchAllTxHex

summary
Create a batchAll transaction of dispatch calls in hex format.

Parameters
- txHexes: `0x${string}`[]
  
  Transactions to execute in the batch call
Returns Promise<`0x${string}`>
Hex of the submittable extrinsic unsigned

batchTx

batchTx(txHexes: `0x${string}`[]): Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>

- Defined in blockchain/index.ts:261
name
batchTx

summary
Create a batch transaction of dispatch calls.

Parameters
- txHexes: `0x${string}`[]
  
  Transactions to execute in the batch call
Returns Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>
Submittable extrinsic unsigned

batchTxHex

batchTxHex(txHexes: `0x${string}`[]): Promise<`0x${string}`>

- Defined in blockchain/index.ts:273
name
batchTxHex

summary
Create a batch transaction of dispatch calls in hex format.

Parameters
- txHexes: `0x${string}`[]
  
  Transactions to execute in the batch call
Returns Promise<`0x${string}`>
Hex of the submittable extrinsic unsigned

checkBalanceForTransfer

checkBalanceForTransfer(address: string, value: number | BN): Promise<void>

- Defined in balance/index.ts:23
name
checkBalanceForTransfer

summary
Check if an account as enough funds to ensure a transfer

Parameters
- address: string
  
  Public address of the account to check balance for transfer
- value: number | BN
  
  Token amount to transfer
Returns Promise<void>

checkFundsForTxFees

checkFundsForTxFees(tx: SubmittableExtrinsic<"promise", ISubmittableResult>): Promise<void>

- Defined in fee/index.ts:74
name
checkFundsForTxFees

summary
Check if a signed transaction sender has enough funds to pay transaction gas fees on transaction submit.

Parameters
- tx: SubmittableExtrinsic<"promise", ISubmittableResult>
  
  Signed transaction object
Returns Promise<void>

checkTxAvailable

checkTxAvailable(txPallet: string, txExtrinsic: string): Promise<boolean>

- Defined in blockchain/index.ts:153
name
checkTxAvailable

summary
Check if the pallet module and the subsequent extrinsic method exist in the Api instance.

Parameters
- txPallet: string
  
  Pallet module of the transaction
- txExtrinsic: string
  
  Subsequent extrinsic method of the transaction
Returns Promise<boolean>
Boolean, true if the pallet module and the subsequent extrinsic method exist, throw an Error otherwise

consts

consts(section: string, constantName: string): Promise<Codec>

- Defined in blockchain/index.ts:116
name
consts

summary
Generic function to get a chain constant.

example
```
console.log(api.consts.balances.existentialDeposit.toString())
```
Parameters
- section: string
  
  The section required to get the chain constant (eg. "balances")
- constantName: string
  
  The constantName depending on the section (eg. "existentialDeposit")
Returns Promise<Codec>
The constant value

createTxHex

createTxHex(txPallet: string, txExtrinsic: string, txArgs?: any[]): Promise<`0x${string}`>

- Defined in blockchain/index.ts:185
name
createTxHex

summary
Create a transaction in hex format.

Parameters
- txPallet: string
  
  Pallet module of the transaction
- txExtrinsic: string
  
  Subsequent extrinsic method of the transaction
- txArgs: any[] = []
  
  Arguments of the transaction
Returns Promise<`0x${string}`>
Hex value of the transaction

generateSeed

generateSeed(): Promise<{ address: string; seed: string }>

- Defined in account/index.ts:9
name
generateSeed

summary
Generate a new account

Returns Promise<{ address: string; seed: string }>
An object with the seed and the public address

getApi

getApi(): Promise<ApiPromise>

- Defined in blockchain/index.ts:39
name
getApi

summary
Get initialized substrate Api instance.

Returns Promise<ApiPromise>
Promise containing the actual Api instance, a wrapper around the RPC and interfaces of the chain.

getApiEndpoint

getApiEndpoint(): Promise<string>

- Defined in blockchain/index.ts:58
name
getApiEndpoint

summary
Provides the wss api endpoint

Returns Promise<string>
String, the api endpoint connected with.

getBalance

getBalance(address: string): Promise<BN>

- Defined in balance/index.ts:12
name
getBalance

summary
Get the free balance of an account

Parameters
- address: string
  
  Public address of the account to get free balance for
Returns Promise<BN>
The free balance of the account

getCapsuleMintFee

getCapsuleMintFee(): Promise<BN>

- Defined in capsule/index.ts:10
name
getCapsuleMintFee

summary
Get the amount of caps needed to mint a capsule.

Returns Promise<BN>
Capsule mint fee

getKeyringFromSeed

getKeyringFromSeed(seed: string): Promise<KeyringPair>

- Defined in account/index.ts:22
name
getKeyringFromSeed

summary
Create a keyring from a seed

Parameters
- seed: string
Returns Promise<KeyringPair>
A keyring pair

getMarketplaceMintFee

getMarketplaceMintFee(): Promise<BN>

- Defined in marketplace/index.ts:10
name
getMarketplaceMintFee

summary
Get the amount of caps needed to mint a marketplace.

Returns Promise<BN>
Marketplace mint fee

getNftMintFee

getNftMintFee(): Promise<BN>

- Defined in nft/index.ts:10
name
getNftMintFee

summary
Get the amount of caps needed to mint an NFT.

Returns Promise<BN>
NFT mint fee

getTxFees

getTxFees(txHex: `0x${string}`, address: string): Promise<BN>

- Defined in fee/index.ts:63
name
getTxFees

summary
Get the total fees for a transaction hex.

Parameters
- txHex: `0x${string}`
  
  Hex of the transaction
- address: string
  
  Public address of the sender
Returns Promise<BN>
Total estimated fee which is the sum of the chain gas fee and the treasury fee

getTxGasFee

getTxGasFee(txHex: `0x${string}`, address: string): Promise<Balance>

- Defined in fee/index.ts:18
name
getTxGasFee

summary
Get the gas fee estimation for a transaction.

Parameters
- txHex: `0x${string}`
  
  Transaction hex
- address: string
  
  Public address of the sender
Returns Promise<Balance>
Transaction fee estimation

getTxTreasuryFee

getTxTreasuryFee(txHex: `0x${string}`): Promise<BN>

- Defined in fee/index.ts:32
name
getTxTreasuryFee

summary
Get the fee needed by Ternoa treasury for specific transaction services.

description
Some Ternoa's services required additional fees on top of chain gas fees, for example: minting a marketplace, minting an NFT or creating a capsule.

Parameters
- txHex: `0x${string}`
  
  Transaction hex
Returns Promise<BN>
Fee estimation

initializeApi

initializeApi(chain?: string): Promise<void>

- Defined in blockchain/index.ts:23
name
initializeApi

summary
Initialize substrate api with selected or default wss endpoint.

description
The default chainEndpoint is "wss://staging.chaos.ternoa.com"

Parameters
- chain: string = chainEndpoint
  
  Chain endpoint
Returns Promise<void>

isApiConnected

isApiConnected(): boolean

- Defined in blockchain/index.ts:49
name
isApiConnected

summary
Check if the Api instance existed and if it is connected.

Returns boolean
Boolean, true if the underlying provider is connected, false otherwise

isTransactionSuccess

isTransactionSuccess(result: ISubmittableResult): { indexInterrupted?: number; success: boolean }

- Defined in blockchain/index.ts:128
name
isTransactionSuccess

summary
Check if a transaction result is successful.

Parameters
- result: ISubmittableResult
  
  Generic result passed as a parameter in a transaction callback
Returns { indexInterrupted?: number; success: boolean }
Object containing a boolean success field indicating if transaction is successful and a indexInterrupted field to indicate where the transaction stopped in case of a batch
- Optional indexInterrupted?: number
- success: boolean

isValidAddress

isValidAddress(address: string): boolean

- Defined in blockchain/index.ts:307
name
isValidAddress

summary
Check if an address is a valid Ternoa address.

Parameters
- address: string
Returns boolean
Boolean, true if the address is valid, false otherwise

query

query(module: string, call: string, args?: any[], callback?: (result: any) => void): Promise<Codec>

- Defined in blockchain/index.ts:91
name
query

summary
Generic function to make a chain query.

example
```
// you can query without any args
const data = await query('balances', 'totalIssuance');

// or you can pass args parameters to the storage query
const data = await query('system', 'account', ['5GesFQSwhmuMKAHcDrfm21Z5xrq6kW93C1ch2Xosq1rXx2Eh']);
```
Parameters
- module: string
  
  The section required to make the chain query (eg. "system")
- call: string
  
  The call depending on the section (eg. "account")
- args: any[] = []
  
  Array of args for the call
- Optional callback: (result: any) => void
  
  Callback function to enable subscription, if not given, no subscription will be made
  - - (result: any): void
    - Parameters
      - result: any
      Returns void
Returns Promise<Codec>
Result of the query storage call

runTx

runTx(txPallet: string, txExtrinsic: string, txArgs: any[], keyring?: IKeyringPair, callback?: (result: ISubmittableResult) => void): Promise<`0x${string}`>

- Defined in blockchain/index.ts:242
name
runTx

summary
Create, sign and submit a transaction on blockchain.

Parameters
- txPallet: string
  
  Pallet module of the transaction
- txExtrinsic: string
  
  Subsequent extrinsic method of the transaction
- txArgs: any[]
  
  Arguments of the transaction
- Optional keyring: IKeyringPair
  
  Keyring pair to sign the data, if not given, an unsigned transaction to be signed will be returned
- Optional callback: (result: ISubmittableResult) => void
  
  Callback function to enable subscription, if not given, no subscription will be made
  - - (result: ISubmittableResult): void
    - Parameters
      - result: ISubmittableResult
      Returns void
Returns Promise<`0x${string}`>
Hash of the transaction, or an unsigned transaction to be signed if no keyring pair is passed

safeDisconnect

safeDisconnect(): Promise<void>

- Defined in blockchain/index.ts:67
name
safeDisconnect

summary
Disconnect safely from the underlying provider, halting all network traffic

Returns Promise<void>

signTx

signTx(keyring: IKeyringPair, txHex: `0x${string}`): Promise<`0x${string}`>

- Defined in blockchain/index.ts:197
name
signTx

summary
Sign a transaction.

Parameters
- keyring: IKeyringPair
  
  Keyring pair to sign the data
- txHex: `0x${string}`
  
  Tx hex of the unsigned transaction to be signed
Returns Promise<`0x${string}`>
Hex value of the signed transaction

submitTx

submitTx(txHex: `0x${string}`, callback?: (result: ISubmittableResult) => void): Promise<`0x${string}`>

- Defined in blockchain/index.ts:210
name
submitTx

summary
Send a signed transaction on the blockchain.

Parameters
- txHex: `0x${string}`
  
  Transaction hex of the signed transaction to be submitted
- Optional callback: (result: ISubmittableResult) => void
  
  Callback function to enable subscription, if not given, no subscription will be made
  - - (result: ISubmittableResult): void
    - Parameters
      - result: ISubmittableResult
      Returns void
Returns Promise<`0x${string}`>
Hash of the transaction

transfer

transfer(from: string, to: string, value: number | BN, keyring?: IKeyringPair, callback?: (result: ISubmittableResult) => void): Promise<`0x${string}`>

- Defined in balance/index.ts:41
name
transfer

summary
Transfer some liquid free balance to another account

Parameters
- from: string
  
  Public address of the account to get balance for
- to: string
  
  Public address of the account to transfer amount to
- value: number | BN
  
  Token amount to transfer
- Optional keyring: IKeyringPair
  
  Keyring pair to sign the data
- Optional callback: (result: ISubmittableResult) => void
  
  Callback function to enable subscription, if not given, no subscription will be made
  - - (result: ISubmittableResult): void
    - Parameters
      - result: ISubmittableResult
      Returns void
Returns Promise<`0x${string}`>
Hash of the transaction or the hex value of the signable tx

transferAll

transferAll(to: string, keepAlive?: boolean, keyring?: IKeyringPair, callback?: (result: ISubmittableResult) => void): Promise<`0x${string}`>

- Defined in balance/index.ts:63
name
transferAll

summary
Transfer the entire transferable balance from the caller account

Parameters
- to: string
  
  Public address of the account to transfer amount to
- keepAlive: boolean = true
  
  Ensure that the transfer does not kill the account, it retains the Existential Deposit
- Optional keyring: IKeyringPair
  
  Keyring pair to sign the data
- Optional callback: (result: ISubmittableResult) => void
  
  Callback function to enable subscription, if not given, no subscription will be made
  - - (result: ISubmittableResult): void
    - Parameters
      - result: ISubmittableResult
      Returns void
Returns Promise<`0x${string}`>
Hash of the transaction or the hex value of the signable tx

transferKeepAlive

transferKeepAlive(from: string, to: string, value: number | BN, keyring?: IKeyringPair, callback?: (result: ISubmittableResult) => void): Promise<`0x${string}`>

- Defined in balance/index.ts:83
name
transferKeepAlive

summary
Transfer some liquid free balance to another account with a check that the transfer will not kill the origin account

Parameters
- from: string
  
  Public address of the account to get balance for
- to: string
  
  Public address of the account to transfer amount to
- value: number | BN
  
  Token amount to transfer
- Optional keyring: IKeyringPair
  
  Keyring pair to sign the data
- Optional callback: (result: ISubmittableResult) => void
  
  Callback function to enable subscription, if not given, no subscription will be made
  - - (result: ISubmittableResult): void
    - Parameters
      - result: ISubmittableResult
      Returns void
Returns Promise<`0x${string}`>
Hash of the transaction or the hex value of the signable tx

unFormatBalance

unFormatBalance(_input: number): Promise<BN>

- Defined in blockchain/index.ts:322
name
unFormatBalance

summary
Format balance from number to BN.

Parameters
- _input: number
  
  Number input
Returns Promise<BN>
BN output

Index

Functions

Functions

batchAllTx

Parameters

txHexes: `0x${string}`[]

Returns Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>

batchAllTxHex

Parameters

txHexes: `0x${string}`[]

Returns Promise<`0x${string}`>

batchTx

Parameters

txHexes: `0x${string}`[]

Returns Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>

batchTxHex

Parameters

txHexes: `0x${string}`[]

Returns Promise<`0x${string}`>

checkBalanceForTransfer

Parameters

address: string

value: number | BN

Returns Promise<void>

checkFundsForTxFees

Parameters

tx: SubmittableExtrinsic<"promise", ISubmittableResult>

Returns Promise<void>

checkTxAvailable

Parameters

txPallet: string

txExtrinsic: string

Returns Promise<boolean>

consts

Parameters

section: string

constantName: string

Returns Promise<Codec>

createTxHex

Parameters

txPallet: string

txExtrinsic: string

txArgs: any[] = []

Returns Promise<`0x${string}`>

generateSeed

Returns Promise<{ address: string; seed: string }>

getApi

Returns Promise<ApiPromise>

getApiEndpoint

Returns Promise<string>

getBalance

Parameters

address: string

Returns Promise<BN>

getCapsuleMintFee

Returns Promise<BN>

getKeyringFromSeed

Parameters

seed: string

Returns Promise<KeyringPair>

getMarketplaceMintFee

Returns Promise<BN>

getNftMintFee

Returns Promise<BN>

getTxFees

Parameters

txHex: `0x${string}`

address: string

Returns Promise<BN>

getTxGasFee

Parameters

txHex: `0x${string}`

address: string

Returns Promise<Balance>

getTxTreasuryFee

Parameters

txHex: `0x${string}`

Returns Promise<BN>

initializeApi

Parameters