core

Candid Dart Core

English | 简体中文

Provide the did2dart method to process Candid content, and quickly generate corresponding Dart code.

The generated code includes:

• IDL
• Service and related methods
• Candid's Objects and Methods.

The generated code depends on agent_dart

• Quick Start
  • Add Dependencies
• Example
• License

Quick Start

Add Dependencies

• Run the following command (recommended)

# With Dart
dart pub add candid_dart_core

# With Flutter
flutter pub add candid_dart_core

• Manually add it to the pubspec.yaml file in your project

dev_dependencies:
  candid_dart_core: any

Example

import 'package:candid_dart_core/core.dart';

void main() {
  final code = did2dart(
    'test.did',
    '''
service : () -> {
    echo: (nat)->(nat) query;
}
            ''',
    GenOption(
      freezed: false,
      makeCollectionsUnmodifiable: false,
      equal: true,
      copyWith: true,
    ),
  );
  print(code);
}

License

MIT License

Copyright (c) 2022 AstroxNetwork

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.