xpx_chain_sdk library

Classes

AbstractTransaction
Account
AccountInfo
AccountMetadataTransaction
Create/ modify a AccountMetadataTransaction entry contains information about metadata .
AccountNames
AccountProperties
AccountPropertiesAddressModification
AccountPropertiesAddressTransaction
AccountPropertiesEntityTypeModification
AccountPropertiesEntityTypeTransaction
AccountPropertiesMosaicModification
AccountPropertiesMosaicTransaction
AccountPropertyType
The property type of an account.
AccountRoutesApi
AddExchangeOfferTransaction
AddOffer
Address
AddressAlias
AddressAliasTransaction
AddressMetadata
Metadata specialization for address/account.
AggregateTransaction
Aggregate Complete send transactions in batches to different Account. Aggregate Bonded propose many transactions between different Account.
AggregateTransactionCosignature
AggregateTransactionCosignature
Alias
AliasTransaction
ApiClient
AssetId
BasicMetadataTransaction
Create/ modify a BasicMetadataTransaction entry contains information about metadata .
BlockchainRoutesApi
BlockchainScore
BlockchainStorageInfo
BlockInfo
ByteUtils
A utility class that provides functions for converting Bytes.
CommunicationTimestamps
Config
CosignatureSignedTransaction
CosignatureTransaction
Cosign an aggregate bonded transaction. CosignatureTransaction are used to sign announced aggregate bonded transactions with missing cosignatures.
Deadline
EncryptedMessage
An encrypted message model defines a secure message that has been encrypted using the Symbol's SDK libraries.
EncryptedPrivateKey
EncryptedPrivateKey model
ExchangeConfirmation
ExchangeOfferTransaction
ExchangeRoutesApi
Field
Key value storage for metadata fields.
HexUtils
A utility class that provides functions for converting hex strings.
LockFundsTransaction
A deposit before announcing aggregate bonded transactions. Alias: LockFundsTransaction
MerklePathItem
MerkleProofInfoPayload
Message
MessageType
Metadata
Metadata is an array of key/value pairs which can be associated with an address/namespace/mosaic.
MetadataEntry
MetadataEntry can be associated with an account/namespace/mosaic.
MetadataFieldOrder
MetadataQueryParams
MetadataRoutesApi
MetadataSortingField
ModifyMultisigAccountTransaction
Create or modify a multisig contract. Announce a modify multisig account transaction to: a) Transform an account to multisig account. b) Change the configurable properties of a multisig account. c) Add or delete cosignatories from a multisig account.
Mosaic
MosaicAliasTransaction
MosaicDefinitionTransaction
Register a new mosaic. Announce a MosaicDefinitionTransaction to create a new Mosaic.
MosaicId
MosaicInfo
MosaicLevy
MosaicLevy structure describes mosaic Levy.
MosaicMetadataTransaction
Create/ modify a AccountMetadataTransaction entry contains information about metadata .
MosaicName
MosaicNonce
The mosaic nonce structure.
MosaicProperties
MosaicProperties structure describes mosaic properties.
MosaicProperty
MosaicRichList
MosaicRichList structure describes mosaic properties.
MosaicRoutesApi
MosaicSupplyChangeTransaction
Change an existent mosaic supply. Announce a MosaicSupplyChangeTransaction to increase or decrease a mosaic’s supply.
Multisig
MultisigAccountGraphInfo
MultisigAccountInfo
MultisigCosignatoryModification
NamespaceId
NamespaceInfo
NamespaceMetadataTransaction
Create/ modify a AccountMetadataTransaction entry contains information about metadata .
NamespaceName
NamespaceRoutesApi
NetworkInfo
NetworkRoutesApi
NetworkType
NetworkVersion
NodeInfo
NodeRoutesApi
Offer
OfferInfo
OfferType
Order
Order_v2
PageQueryParams
The query params structure describes pagination by page number and page size.
Pagination
Password
PlainMessage
PublicAccount
QueryParam
QueryParams
The query params structure describes pagination params for requests.
RegisterNamespaceTransaction
Register a namespace to organize your assets. Announce a RegisterNamespaceTransaction to register and re-rent a namespace.
RemoveExchangeOfferTransaction
RemoveOffer
SignedTransaction
SimpleWallet
SiriusClient
Transaction
TransactionFieldOrder
TransactionIds
TransactionMapping
TransactionQueryParams
TransactionRoutesApi
TransactionSearchMosaic
TransactionSortingField
TransactionStatus
TransactionType
TransactionWithPagination
TransferTransaction
Send mosaics and messages between two accounts. Announce a TransferTransaction to send Mosaic or Message between two Account.
Uint64
Represents a 64-bit unsigned integer.
UserExchangeInfo
Wallet
WalletCrypto

Constants

accountLinkTransactionSize → const int
accountMetadataVersionV2 → const int
accountPropertiesAddressModificationSize → const int
accountPropertiesEntityModificationSize → const int
accountPropertiesMosaicModificationSize → const int
accountPropertyAddressHeader → const int
accountPropertyEntityTypeHeader → const int
accountPropertyMosaicHeader → const int
accountRestrictionAddressVersion → const int
accountRestrictionEntityTypeVersion → const int
accountRestrictionMosaicVersion → const int
add → const MultisigCosignatoryModificationType
addExchangeOfferHeaderSize → const int
addExchangeOfferSize → const int
addExchangeOfferVersion → const int
addressAliasVersion → const int
addressDecodeSize → const int
addressEncodeSize → const int
addressSize → const int
aggregateBondedHeader → const int
aggregateBondedVersion → const int
aggregateCompletedVersion → const int
aliasActionSize → const int
aliasTransactionHeader → const int
amountSize → const int
baseInt64Size → const int
chainConfigVersion → const int
chainUpgradeVersion → const int
deadLineSize → const int
decrease → const MosaicSupplyType
defaultFeeCalculationStrategy → const FeeCalculationStrategy
defaultMosaicLevyOnePercentValue → const int
durationSize → const int
encoder → const JsonEncoder
exchangeOfferHeaderSize → const int
exchangeOfferSize → const int
exchangeOfferVersion → const int
getSupplyMutable → const int
getTransferable → const int
hash256 → const int
hashTypeSize → const int
increase → const MosaicSupplyType
keySize → const int
linkAccountVersion → const int
linkActionSize → const int
lockSize → const int
lockVersion → const int
maxFeeSize → const int
messageSizeSize → const int
metadataAddressVersion → const int
metadataHeaderSize → const int
metadataMosaicVersion → const int
metadataNamespaceVersion → const int
metadataTypeSize → const int
metadataV2HeaderSize → const int
minApprovalSize → const int
minRemovalSize → const int
modificationsSizeSize → const int
modifyContractHeaderSize → const int
modifyMetadataVersion → const int
modifyMultisigAccountVersion → const int
modifyMultisigHeaderSize → const int
mosaicAliasVersion → const int
mosaicDefinitionTransactionHeaderSize → const int
mosaicDefinitionVersion → const int
mosaicIdSize → const int
mosaicMetadataVersionV2 → const int
mosaicModifyLevyVersion → const int
mosaicNonceSize → const int
mosaicOptionalPropertySize → const int
mosaicPropertiesHeaderSize → const int
mosaicPropertyIdSize → const int
mosaicPropertySize → const int
mosaicRemoveLevyVersion → const int
mosaicsSizeSize → const int
mosaicSupplyChangeTransactionSize → const int
mosaicSupplyChangeVersion → const int
mosaicSupplyDirectionSize → const int
namespaceBit → const int
namespaceMetadataVersionV2 → const int
namespaceNameSizeSize → const int
namespaceSize → const int
namespaceTypeSize → const int
numChecksumBytes → const int
offersCountSize → const int
offerTypeSize → const int
privateKeySize → const int
proofSizeSize → const int
propertyModificationTypeSize → const int
propertyTypeSize → const int
publicKeySize → const int
registerNamespaceHeaderSize → const int
registerNamespaceVersion → const int
remove → const MultisigCosignatoryModificationType
removeExchangeOfferHeaderSize → const int
removeExchangeOfferSize → const int
removeExchangeOfferVersion → const int
secretLockSize → const int
secretLockVersion → const int
secretProofHeaderSize → const int
secretProofVersion → const int
signatureSize → const int
signerSize → const int
sizeSize → const int
transactionHeaderSize → const int
transferHeaderSize → const int
transferVersion → const int
typeSize → const int
versionSize → const int
xpxDivisibility → const int
xpxMaxRelativeValue → const int
xpxMaxValue → const int

Properties

buyOffer OfferType
final
configNetworkType int
getter/setter pair
defaultApiClient ApiClient
getter/setter pair
errCosignatureTxHash Exception
final
errEmptyModifications Exception
final
errEmptyNamespaceIds Exception
final
errInvalidHexadecimal Exception
final
errInvalidMosaicProperties Exception
final
errInvalidNamespaceName Exception
Namespace errors
final
errInvalidOwnerPublicKey Exception
final
errInvalidPublicKey Exception
Accounts errors
final
errInvalidSignature Exception
final
errNullAddOffers Exception
final
errNullConfirmations Exception
final
errNullDuration Exception
final
errNullId Exception
final
errNullInnerTransactions Exception
final
errNullMessage Exception
final
errNullMosaicAmount Exception
final
errNullMosaicId Exception
Mosaic errors
final
errNullMosaicProperties Exception
final
errNullMosaics Exception
final
errNullOrZeroHeight Exception
Blockchain errors
final
errNullOrZeroLimit Exception
final
errNullRecipient Exception
Transactions errors
final
errNullRemoveOffers Exception
final
errNullSignature Exception
final
errNullSupplyType Exception
final
errorInvalidMosaicsOffer Exception
Various
final
errPropertyId Exception
final
errTransactionSigner Exception
final
errUnknownOfferType Exception
final
errUnknownPropertyType Exception
final
errUnknownTransactionType Exception
final
prxNamespaceId NamespaceId
final
regList RegExp
final
regMap RegExp
final
regValidNamespace RegExp
final
sellOffer OfferType
final
storageNamespaceId NamespaceId
final
streamingNamespaceId NamespaceId
final
timestampNemesisBlock DateTime
getter/setter pair
xpxMosaicId MosaicId
final
xpxNamespaceId NamespaceId
final

Functions

addExchangeOfferToArrayToBuffer(Builder builder, List<AddOffer> offers) int
addUint8List(Uint8List a, Uint8List b) Uint8List
calculateFee(int transactionByteSize, [FeeCalculationStrategy feeCalculationStratgy = defaultFeeCalculationStrategy]) Uint64
cosignatoryModificationArrayToBuffer(Builder builder, List<MultisigCosignatoryModification> modifications) int
createTransaction(int type, String transactionData, NetworkType networkType, Uint64 deadlineUint64) Transaction
createTransactionFromPayload(String transactionBinary) Transaction
decodeHexRaw(String hex) String
decodeHexUtf8(String hex) String
deserializeDTO(dynamic value) Transaction?
equalsBigInts(BigInt first, BigInt second) bool
exchangeOfferToArrayToBuffer(Builder builder, List<ExchangeConfirmation> offers) int
extractLevels(NamespaceInfoDTO ref) List<Uint64?>
extractMessage(MessageType messageType, String payload) Message
extractNetwork(String versionHex) NetworkType
extractNetworkType(int version) int
extractNumberFromHex(String hexValue) int
extractValueSizeDelta(String hexValue) int
extractVersion(int version) int
fixAggregate(List<Transaction> allTransaction) List<Transaction>
generateNamespaceId(String name, Uint64 parentId) Uint64
generateNamespacePath(String name) Uint64
generateNamespaceId create NamespaceId from namespace string name (ex: prx or domain.subdom.subdome)
getAliasType(int value) AliasType
getPropertyId(int? value) MosaicPropertyId?
hasBits(Uint64 number, int bits) bool
hexDecodeStringOdd(String s) Uint8List
hexReverse(String hexString) String
hexToInt(String hex) int
hexToUint8List(String hexString) Uint8List
internalGetTransactions(ApiClient client, String path, List<QueryParam> queryParams, Object? postBody, {bool firstLevel = true}) Future<List<Transaction>>
internalGetTransactionsWithPagination(ApiClient client, String path, List<QueryParam> queryParams, {bool firstLevel = true}) Future<TransactionWithPagination>
parseInnerTransactionFromBinary(String innerTransactionBinary) List<String>
randombytes(int len) Uint8List
randombytesArray(Uint8List x) Uint8List
randombytesArrayLen(Uint8List x, int len) Uint8List
readonly(dynamic _) Null
Used to avoid to serialize properties to json
removeExchangeOfferToArrayToBuffer(Builder builder, List<RemoveOffer> offers) int
reverse(String hexString) String
reverseUint8List(List<int> bytes) Uint8List
signCosignatureTransactionRwa(CosignatureTransaction tx, Account a) Future<CosignatureSignedTransaction>
signCosignatureTransactionRwaWithHash(String hash, Account a) Future<CosignatureSignedTransaction>
signTransactionWith(Transaction tx, Account a, String generationHash) Future<SignedTransaction>
signTransactionWithCosignatures(Transaction tx, Account a, List<Account> cosignatories, String generationHash) Future<SignedTransaction>
signTransactionWithTxnPayload(String txnPayload, Account a, String generationHash) Future<SignedTransaction>
toAggregateTransactionBytes(Transaction tx) Uint8List
txnDeserialize(dynamic value, String targetType) → dynamic
uint8ListToHex(Uint8List uint8List) String
xpx(int amount) Mosaic
xpxRelative(int amount) Mosaic

Exceptions / Errors

ApiException