Skip to content

Latest commit

 

History

History
272 lines (204 loc) · 11.8 KB

CHANGELOG.md

File metadata and controls

272 lines (204 loc) · 11.8 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

  • KukaiConnector class to handle Kukai wallet connections.
  • OnWalletDisconnected event handling in TezosAuthenticator.
  • Refactor of wallet and connector interfaces to improve modularity and flexibility, including:
    • New focused wallet interfaces (IWalletConnection, IWalletAccount, IWalletTransaction, IWalletContract, IWalletEventProvider) for better separation of concerns.
    • WalletConnectorFactory to replace BeaconConnectorFactory, reflecting a more generic wallet connection approach.
  • Introduced TezosLogger class to replace Logger.cs for improved and cleaner logging and to avoid conflicts with Unity's Logger class.
  • Enabled sourcemaps on WebGL for debugging.
  • Introduced InitializeTezosAsync method in TezosManager to allow for asynchronous initialization of the SDK, so that listeners can wait for the SDK to be ready before proceeding.
  • TezosManager now has a IsInitialized property to check if the SDK has been initialized.

Changed

  • Refactored asynchronous callbacks throughout the SDK to use the Result<T> pattern for improved error handling and clarity.
  • Simplified HTTP request logic for better efficiency and readability, including updates to TezosHttpClient to utilize coroutine callbacks.
  • Improved operation tracking in OperationTracker and WalletProvider to improve blockchain operation tracking and error reporting mechanisms.
  • Updated event naming and handling to improve clarity and streamline the event handling process, renaming events such as ContractCallInjected to OperationInjected and using generic events like OperationCompleted in WalletEventManager.
  • TokenMetadata type to JsonElement to be able to handle generic metadata.
  • Connector system, renaming IBeaconConnector to IWalletConnector and modifying implementations (BeaconConnectorDotNet, BeaconConnectorWebGL) to align with new interface.
  • TokenContract and BeaconConnectorDotNet classes updated to use the new wallet interfaces.
  • Method signatures and implementations across wallet-related classes to align with new interfaces.
  • Event handling in connectors to ensure proper translation and dispatch according to the new event system structure.
  • Logging and error handling across the modified classes for better debugging and maintenance.
  • Connection and operation request flows in wallet connectors to enhance performance and user experience.
  • Samples have been updated to use the new namespaces and namings.
  • WebGL fixes and security improvements.
  • File structure, folder structure, and namespace changes.

Fixed

  • Addressed a memory leak in TokenContract where event handlers were not being properly unsubscribed.
  • Handling of SDKInitialized event in BeaconConnectorWebGl and TezosAuthenticator to ensure proper initialization.
  • WebGL persistent auth for Beacon wallet provider.

Removed

  • Outdated debug logs to clean up codebase and improve maintainability.
  • Dark background UI element in TezosAuthenticator prefab.

Documentation

  • Updated comments to reflect new callback signatures and their behaviors as well as the use of the Result<T> pattern.
  • Updated comments to describe the new wallet and connector interface structure and their benefits.

3.0.0 - 2023-01-09

Added

  • Tutorial scenes within the Tutorials folder, offering step-by-step guidance on SDK features.
  • Centralised event management system WalletEventManager.cs for uniform event handling.
  • TezosManager as a singleton pattern and as a prefab for easy SDK initialization and management.
  • TezosAuthenticator.prefab to streamline user authentication processes with drag-and-drop setup.
  • TezosConfigSO and DataProviderConfigSO for flexible and user-friendly SDK configuration management.

Changed

  • Folder restructuring and namespace adjustments for clarity and better organization.
  • Renaming of classes and files across the SDK to enhance understandability (e.g., DemoExample to Marketplace Example and NftApi Sample to Nft Api Example).
  • Refactored HTTP client construction to utilise DataProviderConfigSO for data settings.
  • Namespace adjustments to reflect the new folder structure.
  • Update of package.json to provide better descriptions and categorisation of samples.
  • Improvement and consolidation of log messages and error handling throughout the SDK.
  • Major code cleanups and refactoring across multiple files (BeaconClientManager.cs, WalletProvider.cs, Tezos.cs, and others) for readability and maintainability.

Removed

  • Obsolete scripts, e.g., WalletProviderInfo, ApiTests and Unity events and prefabs associated with outdated functionalities.
  • Unused fields and refactored classes to remove redundant methods and streamline interfaces (e.g., changes in IBeaconConnector).

Fixed

  • Enhanced UI responsiveness and visual aesthetics.
  • Resolved TypeScript serialization issues on the WebGL frontend.
  • Bug fixes in GetContractTokenIds handling of zero token counts.
  • Miscellaneous bug fixes and improved error handling throughout the codebase.

Deprecated

  • Phased out classes and methods that have been replaced by the new event management system and singleton patterns.
  • Deprecated TezosSingleton.cs in favor of TezosManager.cs.

[Migration Notes]

  • Due to extensive changes, users are encouraged to review the changed file paths and updated namespaces to ensure compatibility with the new version.
  • Custom implementations should be revised to work with the new central event manager (WalletEventManager.cs).

2.0.7 - 2023-10-24

Added

  • Configurable parameters (networkType, rpcUrl, dAppMetadata and logLevel) for Tezos singleton instance.

Changed

  • Default RPC node to tezos.marigold.dev

2.0.6 - 2023-10-16

Changed

  • Disabled Kukai Embed silent signing
  • Updated Kukai Embed to 0.8.9
  • Updated @airgap/beacon-sdk to 4.0.12

Added

  • Persistent auth on WebGL platform

2.0.5 - 2023-08-12

Changed

  • Unity readme

2.0.4 - 2023-08-11

Fixed

  • Asset store validator tool warnings for WebGLCopyAndPaste feature

Added

  • .unitypackage release with GH actions

2.0.3 - 2023-08-01

Changed

  • Mint button in inventory rolled back to old behaviour that uses contracts on view
  • Added Mint FA2 Token button on welcome screen
  • Removed upload file feature usage from DemoExample sample

2.0.2 - 2023-07-28

Fixed

  • WebGL GetActiveAccountAddress function.

2.0.1 - 2023-07-28

Fixed

  • NftApi sample bug with incorrect key error.

2.0.0 - 2023-07-11

Fixed

  • Bug with standalone IL2CPP build fails
  • Bug with closing Beacon database connections before app exit

Added

  • FA2 token contract (deploy, mint and transfer features)
  • Implemented IPFS and on-chain image uploaders for WebGL and Editor platforms

Changed

  • Issue Report Form menu item path changed (new path: Tools/Tezos SDK for Unity/Report an Issue)
  • ITezosAPI renamed to ITezos, refactored and divided in Wallet and API parts
  • Missing namespaces

1.5.1 - 2023-06-27

Fixed

  • Bug with game items transfer not working

Added

  • Ipfs web uploader
  • Ipfs editor uploader

1.5.0 - 2023-06-22

Fixed

  • Bug with UnityBeacon gameobject
  • Bug fix contracts compilation on Ligo 0.65.0
  • Bug Marketplace is not getting loaded on WebGL
  • Bug with incorrect Micheline params serialization on WebGL
  • Bug with sharing violation on beacon.db

Added

  • Kukai embed login option for WebGL builds
  • Ability to build WebGL frontend bundle with Webpack, refactored WebGL fronted app structure
  • API method: GetLatestBlockLevel
  • Editor Issue Report Form window
  • Readme section about mobile-platforms building with disabled Managed Stripping Level

Changed

  • Updated Beacon TypeScript dependency
  • Refactored namespaces, root namespace now is TezosSDK

1.4.0 - 2023-05-18

Fixed

  • Bug with BeaconConnectorWebGl
  • Bug, updated Netezos to v2.8.0

Added

  • Better coroutine error handling
  • API methods: GetOwnersForToken, GetOwnersForContract, IsHolderOfContract, GetTokenMetadata, GetContractMetadata, GetTokensForContract, GetOperationStatus
  • User ability to specify logging level
  • Tezos config singleton class
  • IDataProviderConfig and TzKTProviderConfig implementation
  • Test runner with GH actions

Changed

  • Refactor: Tezos divided into two parts: Wallet and API

1.3.1 - 2023-04-27

Changed

  • Beacon SDK version to 1.0.23

1.3.0 - 2023-04-25

Added

  • Custom unity readme

Fixed

  • Bug with unnecessary RequestPermission() call while clicking on Deeplink connect button on mobiles

Changed

  • Package structure
  • SignPayload method: now users can pass payload as plaintext without hex-encoding
  • Readme images

1.2.1 - 2023-04-17

Fixed

  • Bug with Newtonsoft reference

1.2.0 - 2023-04-17

Added

  • Authentication.prefab
  • WebGl unitypackage plugin
  • API single entrypoint

1.1.0 - 2023-03-31

Added

  • UPM-compatible Package
  • CI to publish package to NPM registry
  • Cross-Session-Persistence to authentication

Fixed

  • Bugs on sample project

Changed

  • Beacon SDK version

0.0.2 - 2023-02-28

Fixed

  • Fixed correct network type resolving in dotnet BeaconConnector

Removed

  • Removed redundant .dll binary files from beacon-dotnet-sdk plugins

0.0.1 - 2023-02-28

Added

  • The project has now a CHANGELOG
  • Added auto releases with GH actions