xpx_chain_sdk 0.0.4+1

  • Readme
  • Changelog
  • Example
  • Installing
  • 60

Vue logo

ProximaX Sirius Blockchain Dart SDK

Official ProximaX Sirius Blockchain SDK Library in Dart.

The ProximaX Sirius Chain Dart SDK works as a lightweight Dart library for interacting with the Sirius Blockchain. It provides a complete library set coverage, and supports synchronous and asynchronous requests.

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  xpx_chain_sdk: 0.0.4+1

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:xpx_chain_sdk/xpx_sdk.dart';

Wiki and Examples #

Examples are in the examples folder

For more examples, go to our wiki

Contribution #

We'd love to get more people involved in the project. Please feel free to raise any issues or PR and we'll review your contribution.

Copyright (c) 2019 ProximaX Limited

0.0.4+1 #

New Features #

[UPDATE] Update Sirius chain 0.5.0

0.0.3+5 #

New Features #

[ADD] ModifyMultisigAccountTransaction support.

[ADD] Get ModifyMultisigInfo.

[ADD] LockFunds support.

[ADD] Get LockFundsTransactionInfo.

[ADD] Getter publicKey and address from Account class.

[ADD] Get aggregateBondedTransactions.

[ADD] AnnounceAggregateBonded and AnnounceAggregateBondedCosignature.

[ADD] CosignatureTransaction class.

Updates #

[UPDATE] Reformat style.

[UPDATE] Update example.

[UPDATE] refactor AggregateTransaction class.

[UPDATE] rename AccountPropertyDTO to _AccountPropertyDTO.

[UPDATE] xpx_crypto to 0.0.2+2.

Fixed bugs #

[UPDATE] fixed bug in TableArrayAttribute.

0.0.3+4 #

Updates #

[UPDATE] latest published versions for http dependency.

0.0.3+3 #

Updates #

[UPDATE] Reformat style.

[UPDATE] Update example.

Fixed bugs #

[FIXED] fixed bug in Deadline null

[FIXED] fixed bug in MosaicSupplyChangeTransaction

[FIXED] fixed bug in duration MosaicDefinition

[FIXED] fixed bug in duration namespace

[FIXED] fixed bug in _MessageDTO null

[FIXED] fixed bug in parentId null

[FIXED] fixed bug in List _MosaicNameDTO

[FIXED] fixed bug in List _MosaicInfoDTO

[FIXED] fixed bug in List _BlockInfoDTO

[FIXED] fixed bug in BlockInfoDTO

0.0.3+2 #

Updates #

[UPDATE] Reformat style.

[UPDATE] rename Config Class.

[UPDATE] refactor Client Class to ApiClient.

[UPDATE] examples.

0.0.3+1 #

  • Initial version, created by Eleazar Garrido.

New Features #

[ADD] Get Account MultiSig Info.

[ADD] Get Account MultiSign Graph Info.

[ADD] Get Transaction Status.

[ADD] Get Transactions Statuses.

Updates #

[UPDATE] Documentation fixes.

[UPDATE] Reformat style.

[UPDATE] dependencies.

[UPDATE] examples.

Fixed bugs #

[FIXED] Undefined name 'HEX'.

[DELETED] removed unused functions.

example/README.md

Examples #

this directory contains some basic examples of Dart's xpx-chain-SDK

a) example for get info: example_account.dart

b) example for announces transactions: example_transfer.dart

  • For more information, see the wiki section of the package.

  • For use cases consult: Xpx-Dart-Flutter

Contributing #

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Copyright (c) 2019 ProximaX Limited

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  xpx_chain_sdk: ^0.0.4+1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:xpx_chain_sdk/imp/buffer/buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_aggregate.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_alias.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_lockFunds.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_mosaic_definition.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_mosaic_supply_change.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_multisig.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_register_namespace.dart';
import 'package:xpx_chain_sdk/imp/buffer/schema/buffer_schema_transfer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/aggregate_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/alias_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/lock_funds_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/modify_contract_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/modify_metadata_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/modify_multisig_account_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/mosaic_alias_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/mosaic_definition_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/mosaic_supply_change_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/register_namespace_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/secret_lock_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/secret_proof_transaction_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/transactions_buffer.dart';
import 'package:xpx_chain_sdk/imp/buffer/transactions/transfer_transaction_buffer.dart';
import 'package:xpx_chain_sdk/xpx_sdk.dart';
import 'package:xpx_chain_sdk/xpx_sdk_all_errors.dart';
import 'package:xpx_chain_sdk/xpx_sdk_consts.dart';
import 'package:xpx_chain_sdk/xpx_sdk_endian.dart';
import 'package:xpx_chain_sdk/xpx_sdk_helper.dart';
import 'package:xpx_chain_sdk/xpx_sdk_utils.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
35
Health:
Code health derived from static analysis. [more]
80
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
60
Learn more about scoring.

We analyzed this package on Dec 6, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Health suggestions

Fix lib/imp/buffer/transactions/transfer_transaction_buffer.dart. (-9.54 points)

Analysis of lib/imp/buffer/transactions/transfer_transaction_buffer.dart reported 20 hints, including:

line 5 col 38: Unnecessary new keyword.

line 11 col 50: Avoid const keyword.

line 17 col 53: Avoid const keyword.

line 29 col 7: Unnecessary new keyword.

line 83 col 34: Unnecessary new keyword.

Fix lib/imp/buffer/transactions/mosaic_definition_transaction_buffer.dart. (-6.78 points)

Analysis of lib/imp/buffer/transactions/mosaic_definition_transaction_buffer.dart reported 14 hints, including:

line 5 col 38: Unnecessary new keyword.

line 11 col 51: Avoid const keyword.

line 18 col 51: Avoid const keyword.

line 31 col 7: Unnecessary new keyword.

line 84 col 34: Unnecessary new keyword.

Fix lib/src/model/transaction/message.dart. (-2.48 points)

Analysis of lib/src/model/transaction/message.dart reported 5 hints:

line 35 col 13: Unnecessary new keyword.

line 39 col 14: Unnecessary new keyword.

line 43 col 14: Unnecessary new keyword.

line 45 col 12: Unnecessary new keyword.

line 73 col 11: Unnecessary new keyword.

Fix additional 9 files with analysis or formatting issues. (-2.99 points)

Additional issues in the following files:

  • lib/src/model/mosaic/mosaic_model.dart (3 hints)
  • lib/src/model/namespace/namespace_model.dart (2 hints)
  • lib/xpx_sdk_all_errors.dart (1 hint)
  • lib/imp/buffer/schema/buffer_schema.dart (Run dartfmt to format lib/imp/buffer/schema/buffer_schema.dart.)
  • lib/src/api/api_account_routes.dart (Run dartfmt to format lib/src/api/api_account_routes.dart.)
  • lib/src/api/transaction_routes_api.dart (Run dartfmt to format lib/src/api/transaction_routes_api.dart.)
  • lib/src/model/account/account_dto.dart (Run dartfmt to format lib/src/model/account/account_dto.dart.)
  • lib/src/model/account/account_properties_dto.dart (Run dartfmt to format lib/src/model/account/account_properties_dto.dart.)
  • lib/src/model/account/address_model.dart (Run dartfmt to format lib/src/model/account/address_model.dart.)

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.6.1 <3.0.0
base32 ^1.0.1 1.1.1
convert ^2.1.1 2.1.1
fixnum ^0.10.9 0.10.11
flat_buffers ^1.11.0 1.11.0
http ^0.12.0+2 0.12.0+2
xpx_crypto ^0.0.2+2 0.0.2+2
Transitive dependencies
async 2.4.0
charcode 1.1.2
collection 1.14.12
http_parser 3.1.3
meta 1.1.8
path 1.6.4
pedantic 1.9.0
pointycastle 1.0.2
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
build_runner >=0.8.10 <2.0.0
build_web_compilers >=0.3.6 <2.0.0