updateMasterKey static method

Future<void> updateMasterKey(
  1. {required String masterKey,
  2. bool ifDukpt = false}
)

Updates the master key of the newPOS.

The master key is used to encrypt and decrypt data, so it is important to keep it safe.

Parameters:

  • masterKey (required): The new master key. Must be a 16-character string.
  • ifDukpt (required): A boolean value that indicates whether the master key should be encrypted with the DUKPT algorithm. If true, the master key will be encrypted with DUKPT. If false, the master key will not be encrypted.

Example:

// Update the master key without DUKPT encryption
await FlutterNewposSdk.updateMasterKey(masterKey: 'my_new_master_key');

// Update the master key with DUKPT encryption
await FlutterNewposSdk.updateMasterKey(masterKey: 'my_new_master_key', ifDukpt: true);

Implementation details:

  1. Invokes the updateMasterKey method of the FlutterPos plugin, passing the new master key and the ifDukpt value.
  2. Gets the first result from the OnUpdateMasterKeySuccess event stream of the plugin.
  3. If the result is true, the master key has been updated successfully and the function displays a message of success.
  4. If no result is received from the stream within the timeout, the function displays an error message and throws a FlutterPosException with the code UPDATE_MASTER_KEY_TIMEOUT.
  5. If any other error occurs, the function throws a FlutterPosException with the code UPDATE_MASTER_KEY_FAILED.

Return:

The updateMasterKey function returns a Future<void>, which completes when the master key has been updated successfully or when an error occurs.

Additional notes:

  • The masterKey parameter must be a 16-character string.
  • The ifDukpt parameter must be a boolean value.
  • The function throws a FlutterPosException if the update is unsuccessful.

Implementation

static Future<void> updateMasterKey({
  required String masterKey,
  bool ifDukpt = false,
}) async {
  /// Stream method
  final stream = FlutterNewposSdk._methodStream.stream
      .where((m) => m.method == 'OnUpdateMasterKeySuccess')
      .map((m) {
    return m.arguments as bool;
  });
  try {
    await _invokeMethod(
      'updateMasterKey',
      {
        'masterKey': masterKey,
        'ifDukpt': ifDukpt,
      },
    );
    final result = await getFirstResultInStream(
      stream,
      const Duration(seconds: 5),
    );

    final success = result ?? false;

    if (success) {
      await displayText(text: 'MasterKey was updated');
    } else {
      throw const FlutterPosException(
        code: 'UPDATE_MASTER_KEY_FAILED',
        message: 'Unknown error updating master key',
      );
    }
  } on TimeoutException {
    await displayText(text: 'Try update master key again');
    throw const FlutterPosException(
      code: 'UPDATE_MASTER_KEY_TIMEOUT',
      message: 'Timeout to update master key',
    );
  } catch (e) {
    throw const FlutterPosException(
      code: 'UPDATE_MASTER_KEY_FAILED',
      message: 'Unknown error updating master key',
    );
  }
}