quantum-coin-js-sdk

v1.0.26

Published

10 days ago

Quantum Coin - Q SDK in JavaScript

Downloads

474

0High
0Medium
0Low

quantumcoin

pqc cryptography quantum coins quantum coin quantumcoin blockchain

quantum-coin-js-sdk

Quantum Coin JS SDK provides functionality to interact with the Quantum Coin Blockchain using the Relay APIs. Example Project

Example

Requires Node.js version v20.18.1 or higher

Installation:
npm install quantum-coin-js-sdk --save

//Adding reference:
var qcsdk = require('quantum-coin-js-sdk');

//Initialize the SDK first before invoking any other function
var clientConfigVal = new qcsdk.Config("https://sdk.readrelay.quantumcoinapi.com", "https://sdk.writerelay.quantumcoinapi.com", 123123, "", ""); //TMainnet Block Explorer: https://QuantumScan.com
 
qcsdk.initialize(clientConfigVal).then((initResult) => {
  
}

Example Project: https://github.com/quantumcoinproject/quantum-coin-js-sdk/tree/main/example

quantum-coin-js-sdk
- ~Config
  - new Config(readUrl, writeUrl, chainId, readApiKey, writeApiKey)
  - .readUrl : string
  - .writeUrl : string
  - .chainId : number
  - .readApiKey : string
  - .writeApiKey : string
- ~Wallet
  - new Wallet(address, privateKey, publicKey)
  - .address : string
  - .privateKey : Array.<number>
  - .publicKey : Array.<number>
- ~BlockDetails
  - .blockNumber : number
- ~LatestBlockDetailsResult
  - .resultCode : number
  - .blockDetails : BlockDetails
  - .response : Object
  - .requestId : string
  - .err : Error
- ~AccountDetails
  - .address : string
  - .balance : string
  - .nonce : number
  - .blockNumber : number
- ~AccountDetailsResult
  - .resultCode : number
  - .accountDetails : AccountDetails
  - .response : Object
  - .requestId : string
  - .err : Error
- ~SignResult
  - .resultCode : number
  - .txnHash : string
  - .txnData : string
- ~SendResult
  - .resultCode : number
  - .txnHash : string
  - .response : Object
  - .requestId : string
  - .err : Error
- ~TransactionReceipt
  - .cumulativeGasUsed : string
  - .effectiveGasPrice : string
  - .gasUsed : string
  - .status : string
  - .hash : string
  - .type : string
- ~TransactionDetails
  - .blockHash : string
  - .blockNumber : number
  - .from : string
  - .gas : string
  - .gasPrice : string
  - .hash : string
  - .input : string
  - .nonce : number
  - .to : string
  - .value : string
  - .receipt : TransactionReceipt
- ~TransactionDetailsResult
  - .resultCode : number
  - .transactionDetails : TransactionDetails
  - .response : Object
  - .requestId : string
  - .err : Error
- ~AccountTransactionCompact
  - .blockNumber : number
  - .from : string
  - .hash : string
  - .to : string
  - .value : string
  - .status : string
- ~ListAccountTransactionsResponse
  - .pageCount : number
  - .items : AccountTransactionCompact | Array
- ~AccountTransactionsResult
  - .resultCode : number
  - .listAccountTransactionsResponse : ListAccountTransactionsResponse
  - .response : Object
  - .requestId : string
  - .err : Error
- ~TransactionSigningRequest
  - new TransactionSigningRequest(wallet, toAddress, valueInWei, nonce, data, gasLimit, remarks)
  - .wallet : Wallet
  - .toAddress : string
  - .valueInWei : string | BigInt
  - .nonce : number
  - .data : string
  - .gasLimit : number
  - .remarks : string
- ~PackUnpackResult
  - new PackUnpackResult(error, result)
  - .error : string
  - .result : string
- ~initialize(clientConfig) ΓçÆ Promise.<boolean>
- ~isAddressValid(address) ΓçÆ boolean
- ~newWallet() ΓçÆ Wallet
- ~newWalletSeed() ΓçÆ array
- ~openWalletFromSeedWords(seedWordList) ΓçÆ Wallet
- ~deserializeEncryptedWallet(walletJsonString, passphrase) ΓçÆ Wallet
- ~serializeEncryptedWallet(wallet, passphrase) ΓçÆ string
- ~verifyWallet(wallet) ΓçÆ boolean
- ~serializeWallet(wallet) ΓçÆ string
- ~deserializeWallet(walletJson) ΓçÆ Wallet
- ~postTransaction(txnData) ΓçÆ Promise.<SendResult>
- ~getLatestBlockDetails() ΓçÆ Promise.<LatestBlockDetailsResult>
- ~getAccountDetails(address) ΓçÆ Promise.<AccountDetailsResult>
- ~getTransactionDetails(txnHash) ΓçÆ Promise.<TransactionDetailsResult>
- ~listAccountTransactions(address, pageNumber) ΓçÆ Promise.<ListAccountTransactionsResponse>
- ~signSendCoinTransaction(wallet, toAddress, coins, nonce) ΓçÆ SignResult
- ~signTransaction(wallet, toAddress, coins, nonce, data) ΓçÆ SignResult
- ~hexStringToUint8Array(hex) ΓçÆ Uint8Array
- ~signRawTransaction(transactionSigningRequest) ΓçÆ SignResult
- ~sendCoins(wallet, toAddress, coins, nonce) ΓçÆ Promise.<SendResult>
- ~publicKeyFromSignature(digest, signature) ΓçÆ string
- ~publicKeyFromPrivateKey(privateKey) ΓçÆ string
- ~addressFromPublicKey(publicKey) ΓçÆ string
- ~combinePublicKeySignature(publicKey, signature) ΓçÆ string
- ~packMethodData(abiJSON, methodName, ...args) ΓçÆ PackUnpackResult
- ~unpackMethodData(abiJSON, methodName, hexData) ΓçÆ PackUnpackResult
- ~packCreateContractData(abiJSON, bytecode, ...args) ΓçÆ PackUnpackResult
- ~createAddress(address, nonce) ΓçÆ string | null
- ~createAddress2(address, salt, initHash) ΓçÆ string | null

quantum-coin-js-sdk~Config

This is the configuration class required to initialize and interact with Quantum Coin blockchain

Kind: inner class of quantum-coin-js-sdk
Access: public

~Config
- new Config(readUrl, writeUrl, chainId, readApiKey, writeApiKey)
- .readUrl : string
- .writeUrl : string
- .chainId : number
- .readApiKey : string
- .writeApiKey : string

new Config(readUrl, writeUrl, chainId, readApiKey, writeApiKey)

Creates a config class

| Param | Type | Description | | --- | --- | --- | | readUrl | string | The Read API URL pointing to a read relay. See https://github.com/quantumcoinproject/quantum-coin-go/tree/dogep/relay. The following URLs are community maintained. Please use your own relay service. Mainnet: https://sdk.readrelay.quantumcoinapi.com | | writeUrl | string | The Write API URL pointing to a write relay. See https://github.com/quantumcoinproject/quantum-coin-go/tree/dogep/relay. The following URLs are community maintained. Please use your own relay service. Mainnet: https://sdk.writerelay.quantumcoinapi.com | | chainId | number | The chain id of the blockchain. Mainnet chainId is 123123. Testnet T4 chainId is 310324. | | readApiKey | string | Optional parameter if authorization is enabled for the relay service. API Key for authorization. Defaults to null which indicates no authorization. | | writeApiKey | string | Optional parameter if authorization is enabled for the relay service. API Key for authorization. Defaults to null which indicates no authorization. |

config.readUrl : string

The Read API URL pointing to a read relay. See https://github.com/quantumcoinproject/quantum-coin-go/tree/dogep/relay

Kind: instance property of Config
Access: public

config.writeUrl : string

The Read API URL pointing to a read relay. See https://github.com/quantumcoinproject/quantum-coin-go/tree/dogep/relay

Kind: instance property of Config
Access: public

config.chainId : number

The chain id of the blockchain. Mainnet chainId is 123123. Testnet T4 chainId is 310324.

Kind: instance property of Config
Access: public

config.readApiKey : string

API Key for authorization if authorization is enabled for the relay service. Defaults to null which indicates no authorization.

Kind: instance property of Config
Access: public

config.writeApiKey : string

API Key for authorization if authorization is enabled for the relay service. Defaults to null which indicates no authorization.

Kind: instance property of Config
Access: public

quantum-coin-js-sdk~Wallet

This class represents a Wallet. Use the verifyWallet function to verify if a wallet is valid. Verifying the wallet is highly recommended, especially if it comes from an untrusted source. For more details on the underlying cryptography of the Wallet, see https://github.com/QuantumCoinProject/hybrid-pqc

Kind: inner class of quantum-coin-js-sdk
Access: public

~Wallet
- new Wallet(address, privateKey, publicKey)
- .address : string
- .privateKey : Array.<number>
- .publicKey : Array.<number>

new Wallet(address, privateKey, publicKey)

Creates a Wallet class. The constructor does not verify the wallet. To verify a wallet, call the verifyWallet function explicitly.

| Param | Type | Description | | --- | --- | --- | | address | string | Address of the wallet | | privateKey | Array.<number> | Private Key byte array of the wallet | | publicKey | Array.<number> | The chain id of the blockchain. Mainnet chainId is 123123. Testnet T4 chainId is 310324. |

wallet.address : string

Address of the wallet. Is 66 bytes in length including 0x (if the wallet is valid).

Kind: instance property of Wallet
Access: public

wallet.privateKey : Array.<number>

Private Key byte array of the wallet. Is 4064 bytes in length (if the wallet is valid).

Kind: instance property of Wallet
Access: public

wallet.publicKey : Array.<number>

Public Key byte array of the wallet. Is 1408 bytes in length (if the wallet is valid).

Kind: instance property of Wallet
Access: public

quantum-coin-js-sdk~BlockDetails

This class represents a Block.

Kind: inner class of quantum-coin-js-sdk
Access: public

blockDetails.blockNumber : number

Block Number of the block

Kind: instance property of BlockDetails
Access: public

quantum-coin-js-sdk~LatestBlockDetailsResult

This class represents a result from invoking the getLatestBlock function.

Kind: inner class of quantum-coin-js-sdk
Access: public

~LatestBlockDetailsResult
- .resultCode : number
- .blockDetails : BlockDetails
- .response : Object
- .requestId : string
- .err : Error

latestBlockDetailsResult.resultCode : number

Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.

Kind: instance property of LatestBlockDetailsResult
Access: public

latestBlockDetailsResult.blockDetails : BlockDetails

An object of type BlockDetails representing the block. This value is null if the value of resultCode is not 0.

Kind: instance property of LatestBlockDetailsResult
Access: public

latestBlockDetailsResult.response : Object

An object of representing the raw Response returned by the service. For details, see https://developer.mozilla.org/en-US/docs/Web/API/Response. This value can be null if the value of resultCode is not 0.

Kind: instance property of LatestBlockDetailsResult
Access: public

latestBlockDetailsResult.requestId : string

An unique id to represent the request. This can be null if request failed before it could be sent.

Kind: instance property of LatestBlockDetailsResult
Access: public

latestBlockDetailsResult.err : Error

An error object if the operation resulted in an error and there was no response. This property is defined only if the resultCode is -10000.

Kind: instance property of LatestBlockDetailsResult
Access: public

quantum-coin-js-sdk~AccountDetails

This class represents an Account.

Kind: inner class of quantum-coin-js-sdk
Access: public

~AccountDetails
- .address : string
- .balance : string
- .nonce : number
- .blockNumber : number

accountDetails.address : string

Address of the wallet. Is 66 bytes in length including 0x.

Kind: instance property of AccountDetails
Access: public

accountDetails.balance : string

Balance of the account in wei. To convert this to ethers, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei

Kind: instance property of AccountDetails
Access: public

accountDetails.nonce : number

A monotonically increasing number representing the nonce of the account. After each transaction from the account that gets registered in the blockchain, the nonce increases by 1.

Kind: instance property of AccountDetails
Access: public

accountDetails.blockNumber : number

The block number as of which the Account details was retrieved.

Kind: instance property of AccountDetails
Access: public

quantum-coin-js-sdk~AccountDetailsResult

This class represents a result from invoking the getAccountDetails function.

Kind: inner class of quantum-coin-js-sdk
Access: public

~AccountDetailsResult
- .resultCode : number
- .accountDetails : AccountDetails
- .response : Object
- .requestId : string
- .err : Error

accountDetailsResult.resultCode : number

Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.

Kind: instance property of AccountDetailsResult
Access: public

accountDetailsResult.accountDetails : AccountDetails

An object of type AccountDetails representing the block. This value is null if the value of resultCode is not 0.

Kind: instance property of AccountDetailsResult
Access: public

accountDetailsResult.response : Object

Kind: instance property of AccountDetailsResult
Access: public

accountDetailsResult.requestId : string

An unique id to represent the request. This can be null if request failed before it could be sent.

Kind: instance property of AccountDetailsResult
Access: public

accountDetailsResult.err : Error

An error object if the operation resulted in an error and there was no response. This property is defined only if the resultCode is -10000.

Kind: instance property of AccountDetailsResult
Access: public

quantum-coin-js-sdk~SignResult

This class represents a result from invoking the signSendCoinTransaction function.

Kind: inner class of quantum-coin-js-sdk
Access: public

~SignResult
- .resultCode : number
- .txnHash : string
- .txnData : string

signResult.resultCode : number

Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.

Kind: instance property of SignResult
Access: public

signResult.txnHash : string

Hash of the Transaction, to uniquely identify it. Is 66 bytes in length including 0x. This value is null if the value of resultCode is not 0.

Kind: instance property of SignResult
Access: public

signResult.txnData : string

A payload representing the signed transaction. To actually send a transaction, this payload can then be taken to to a different device that is connected to the blockchain relay and then sent using the postTransaction function. This value is null if the value of resultCode is not 0.

Kind: instance property of SignResult
Access: public

quantum-coin-js-sdk~SendResult

This class represents a result from invoking the sendCoins function.

Kind: inner class of quantum-coin-js-sdk
Access: public

~SendResult
- .resultCode : number
- .txnHash : string
- .response : Object
- .requestId : string
- .err : Error

sendResult.resultCode : number

Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.

Kind: instance property of SendResult
Access: public

sendResult.txnHash : string

Hash of the Transaction, to uniquely identify it. Is 66 bytes in length including 0x. This value is null if the value of resultCode is not 0.

Kind: instance property of SendResult
Access: public

sendResult.response : Object

Kind: instance property of SendResult
Access: public

sendResult.requestId : string

An unique id to represent the request. This can be null if request failed before it could be sent.

Kind: instance property of SendResult
Access: public

sendResult.err : Error

An error object if the operation resulted in an error and there was no response. This property is defined only if the resultCode is -10000.

Kind: instance property of SendResult
Access: public

quantum-coin-js-sdk~TransactionReceipt

This class represents a Receipt of a transaction that is registered in the blockchain. The transactionReceipt field can be null unless the transaction is registered with the blockchain. While the transaction is pending, this field will be null. You should consider the transaction as succeeded only if the status field's value is 0x1 (success).

Kind: inner class of quantum-coin-js-sdk
Access: public

~TransactionReceipt
- .cumulativeGasUsed : string
- .effectiveGasPrice : string
- .gasUsed : string
- .status : string
- .hash : string
- .type : string

transactionReceipt.cumulativeGasUsed : string

A hexadecimal string representing the total amount of gas used when this transaction was executed in the block.

Kind: instance property of TransactionReceipt
Access: public

transactionReceipt.effectiveGasPrice : string

A hexadecimal string representing the sum of the base fee and tip paid per unit of gas.

Kind: instance property of TransactionReceipt
Access: public

transactionReceipt.gasUsed : string

A hexadecimal string representing the amount of gas used by this specific transaction alone.

Kind: instance property of TransactionReceipt
Access: public

transactionReceipt.status : string

A hexadecimal string representing either 0x1 (success) or 0x0 (failure). Failed transactions can also incur gas fee. You should consider the transaction as succeeded only if the status value is 0x1 (success).

Kind: instance property of TransactionReceipt
Access: public

transactionReceipt.hash : string

Hash of the Transaction, to uniquely identify it. Is 66 bytes in length including 0x.

Kind: instance property of TransactionReceipt
Access: public

transactionReceipt.type : string

A hexadecimal string representing the transaction type. 0x0 is DefaultFeeTxType.

Kind: instance property of TransactionReceipt
Access: public

quantum-coin-js-sdk~TransactionDetails

This class represents details of a transaction. You should consider the transaction as succeeded only if the status field of the receipt object is 0x1 (success).

Kind: inner class of quantum-coin-js-sdk
Access: public

~TransactionDetails
- .blockHash : string
- .blockNumber : number
- .from : string
- .gas : string
- .gasPrice : string
- .hash : string
- .input : string
- .nonce : number
- .to : string
- .value : string
- .receipt : TransactionReceipt

transactionDetails.blockHash : string

A hexadecimal string representing the hash of the block that registered the transaction. This field can be null if the transaction was not registered in the blockchain.