Skip to content
This repository has been archived by the owner on Dec 20, 2022. It is now read-only.

v3.0.0 - Spec v0.10.0

Compare
Choose a tag to compare
@wilwade wilwade released this 25 Aug 17:53
· 23 commits to main since this release
c1d95b0

[3.0.0] - 2021-08-25

Changed

  • BREAKING: Changed batch.readFile() to pass parsed announcements instead of parquet records to callback
  • BREAKING: Changed createdAt on announcements to BigInt instead of number
  • Changed isSignatureAuthorizedTo to work with SignedAnnouncements
  • Changed isSignatureAuthorizedTo to throw InvalidAnnouncementParameterError when passed an invalid object as announcement
  • Changed AnnouncementWithSignature to take an AnnouncementType instead of a TypedAnnouncement
  • Changed to use bigint for types instead of BigInt
  • Changed content.react() to throw InvalidEmojiStringError when passed an invalid emoji string
  • Changed content.tombstone() to throw InvalidTombstoneAnnouncementTypeError or InvalidTombstoneAnnouncementSignatureError depending on which aspect of the provided target is invalid instead of simply throwing InvalidTombstoneAnnouncementTypeError for both
  • Exported announcement.isValidEmoji() for testing emoji strings
  • Exported announcement.isValidSignature() for testing signature strings
  • Removed statistics from parquet files for signature and hash fields
  • BREAKING: Update to Spec v0.10.0
  • BREAKING: Use BigInt for DSNPUserId
  • BREAKING: Store byte data in parquet as bytes
  • BREAKING: Parquet Schema changes
  • BREAKING: Use Spec v0.10.0 serialization for signatures

Added

  • Added announcement.isTombstoneableType() for testing if a given announcement type can be tombstoned
  • sdk.convertToDSNPUserURI for taking most any value and converting it to the DSNP User URI format
  • sdk.convertToDSNPUserId for taking most any value and converting it to the DSNP User Id format

Fixed

  • Changed isValidAnnouncement to return false for all announcements missing a createdAt big int
  • Updated content.react() to throw InvalidAnnouncementUriError as specified in its documentation
  • Updated Mentions so they require a DSNP User URI per spec instead of an Id
  • batch.openFile and batch.openUrl had an extra promise wrapping

Removed

  • sdk.core.activityContent.serialize: Serialization of activityContent is just JSON.stringify
  • sdk.core.utilities.sortObject: Unused method
  • sdk.convertBigNumberToDSNPUserId: Not supporting BigNumber anymore
  • sdk.convertDSNPUserIdOrURIToBigNumber: Not supporting BigNumber anymore
  • sdk.convertBigNumberToDSNPUserURI: Not supporting BigNumber anymore
  • Removed sdk.convertDSNPUserURIToDSNPUserId: Just use convertToDSNPUserId and convertToDSNPUserURI