Commercio.network Dart SDK Documentation

# Docs helper

Docs helper allows to easily perform all the operations related to the commercio.network docs module.

# Provided operations

  1. Creates a new transaction that allows to share the document associated with the given metadata, document id, recipients and with the sender wallet. Optional fields are contentUri, doSign, checksum, fee and the broadcasting mode.

    If encryptedData is specified, encrypts the proper data and optional aesKey for the specified recipients and then sends the transaction to the blockchain. If doSign is provided then also the checksum field is required.

    static Future<TransactionResult> shareDocument({
  required String id,
  required CommercioDocMetadata metadata,
  required List<String> recipients,
  required Wallet wallet,
  String? contentUri,
  CommercioDoSign? doSign,
  CommercioDocChecksum? checksum,
  Uint8List? aesKey,
  Set<CommercioEncryptedData>? encryptedData,
  StdFee? fee,
  BroadcastingMode? mode,
  http.Client? client,
})
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14

    Example:

    final txResult = await DocsHelper.shareDocument(
  wallet: wallet,
  id: Uuid().v4(),
  recipients: ['did:com:14ttg3eyu88jda8udvxpwjl2pwxemh72w0grsau'],
  metadata: CommercioDocMetadata(
    contentUri: 'https://example.com/document.pdf',
    schemaType: '-',
  ),
);
    1
    2
    3
    4
    5
    6
    7
    8
    9

  2. Create a new transaction that allows to share a list of previously generated documents commercioDocsList signing the transaction with wallet. Optionally fee and broadcasting mode parameters can be specified.

    static Future<List<CommercioDoc>> getSentDocuments({
  required String address,
  required NetworkInfo networkInfo,
  http.Client? client,
})
    1
    2
    3
    4
    5

    Example:

    final commercioDoc = await CommercioDocHelper.fromWallet(
  wallet: wallet,
  id: Uuid().v4(),
  recipients: ['did:com:14ttg3eyu88jda8udvxpwjl2pwxemh72w0grsau'],
  metadata: CommercioDocMetadata(
    contentUri: 'https://example.com/document.pdf',
    schemaType: '-',
  ),
);

final txResult = await DocsHelper.shareDocumentsList([commercioDoc], wallet);
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11

  3. Returns the list of all the CommercioDoc that the specified address has sent

    static Future<List<CommercioDoc>> getSentDocuments({
  required String address,
  required NetworkInfo networkInfo,
  http.Client? client,
})
    1
    2
    3
    4
    5

    Example:

    final documents = await DocsHelper.getSentDocuments(
  address: wallet.bech32Address,
  networkInfo: networkInfo,
);
    1
    2
    3
    4

  4. Returns the list of all the CommercioDoc that the specified address has received

    static Future<List<CommercioDoc>> getReceivedDocuments({
  required String address,
  required NetworkInfo networkInfo,
  http.Client? client,
})
    1
    2
    3
    4
    5

    Example:

    final documents = await DocsHelper.getSentDocuments({
  @required String address,
  @required NetworkInfo networkInfo,
  http.Client client,
});
    1
    2
    3
    4
    5

  5. Creates a new transaction which tells the recipient that the document having the specified documentId and present inside the transaction with txHash has been properly seen; optionally proof of reading, fee and broadcasting mode.

    static Future<TransactionResult> sendDocumentReceipt({
  required String recipient,
  required String txHash,
  required String documentId,
  required Wallet wallet,
  String? proof,
  StdFee? fee,
  BroadcastingMode? mode,
  http.Client? client,
})
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10

  6. Creates a new transaction which sends a list of previously generated receipts commercioDocReceiptsList. Optionally fee and broadcasting mode parameters can be specified.

    static Future<TransactionResult> sendDocumentReceiptsList(
   List<CommercioDocReceipt> commercioDocReceiptsList,
   Wallet wallet, {
   StdFee? fee,
   BroadcastingMode? mode,
   http.Client? client,
})
    1
    2
    3
    4
    5
    6
    7

  7. Returns the list of all the CommercioDocReceipt that have been sent from the given address

    static Future<List<CommercioDocReceipt>> getSentReceipts({
  required String address,
  required NetworkInfo networkInfo,
  http.Client? client,
})
    1
    2
    3
    4
    5

  8. Returns the list of all the CommercioDocRecepit that have been received from the given address

    static Future<List<CommercioDocReceipt>> getReceivedReceipts({
  required String address,
  required NetworkInfo networkInfo,
  http.Client? client,
})
    1
    2
    3
    4
    5

# Usage examples

final info = NetworkInfo(
  bech32Hrp: 'did:com:',
  lcdUrl: Uri.parse('http://localhost:1317'),
);

final senderMnemonic = ['will', 'hard', ..., 'man'];
final senderWallet = Wallet.derive(senderMnemonic, info);

final recipientMnemonic = ['crisp', 'become', ..., 'cereal'];
final recipientWallet = Wallet.derive(recipientMnemonic, info);
final recipientDid = recipientWallet.bech32Address;

final docId = Uuid().v4();
final checksum = CommercioDocChecksum(
  value: "a00ab326fc8a3dd93ec84f7e7773ac2499b381c4833e53110107f21c3b90509c",
  algorithm: CommercioDocChecksumAlgorithm.SHA256,
);
final doSign = CommercioDoSign(
  storageUri: "http://www.commercio.network",
  signerIstance: "did:com:1cc65t29yuwuc32ep2h9uqhnwrregfq230lf2rj",
  sdnData: {
    CommercioSdnData.COMMON_NAME,
    CommercioSdnData.SURNAME,
  },
  vcrId: "xxxxx",
  certificateProfile: "xxxxx",
);

try {
  // --- Share a document
  final response = await DocsHelper.shareDocument(
    id: docId,
    contentUri: 'https://example.com/document',
    metadata: CommercioDocMetadata(
      contentUri: 'https://example.com/document/metadata',
      schema: CommercioDocMetadataSchema(
        uri: 'https://example.com/custom/metadata/schema',
        version: '1.0.0',
      ),
    ),
    recipients: [recipientDid],
    wallet: senderWallet,
    checksum: checksum,
    encryptedData: const {CommercioEncryptedData.CONTENT_URI},
    doSign: doSign,
    fee: const StdFee(
      gas: '200000',
      amount: [StdCoin(denom: 'ucommercio', amount: '10000')],
    ),
  );

  // --- Send receipt
  final senderDid = senderWallet.bech32Address;

  await DocsHelper.sendDocumentReceipt(
    recipient: senderDid,
    txHash: response.hash,
    documentId: docId,
    wallet: recipientWallet,
  );
} catch (error) {
  // Handle error
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

← CommercioDocHelper →