@haneullabs/bcs 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,388 @@
+# Change Log
+
+## 1.9.2
+
+### Patch Changes
+
+- 89fa2dc: Work around bug in turbopack thatbreaks uleb128 encoding in next@16
+
+## 1.9.1
+
+### Patch Changes
+
+- a37829f: Fix encoding/decoding large uleb128 values
+
+## 1.9.0
+
+### Minor Changes
+
+- f3b19a7: Use bcs.byteVector and bcs.bytes instead of bcs.vector(bcs.u8()) and bcs.fixedArrray(n,
+  bcs.u8()) to improve performance
+- f3b19a7: improve perf of bcs.byteVector
+
+## 1.8.1
+
+### Patch Changes
+
+- a17c337: Fix name in bcs error message
+
+## 1.8.0
+
+### Minor Changes
+
+- ea1ac70: Update dependencies and improve support for typescript 5.9
+
+### Patch Changes
+
+- Updated dependencies [ea1ac70]
+  - @haneullabs/utils@0.2.0
+
+## 1.7.0
+
+### Minor Changes
+
+- 33230ed: Add generic inference for bcs type names
+- 33230ed: Update generics for vector, option, fixedArray, and map to prefer bcs types over input
+  and output values
+- 33230ed: Export new BcsStruct, BcsEnum and BcsTuple classes
+
+## 1.6.4
+
+### Patch Changes
+
+- 1c4a82d: update links in package.json
+- Updated dependencies [1c4a82d]
+  - @haneullabs/utils@0.1.1
+
+## 1.6.3
+
+### Patch Changes
+
+- Updated dependencies [a00522b]
+  - @haneullabs/utils@0.1.0
+
+## 1.6.2
+
+### Patch Changes
+
+- bb7c03a: Update dependencies
+- Updated dependencies [bb7c03a]
+  - @haneullabs/utils@0.0.1
+
+## 1.6.1
+
+### Patch Changes
+
+- 7e1c525: Correctly handle byteOffset in Uint8Arrays when reading bcs bytes
+
+## 1.6.0
+
+### Minor Changes
+
+- c3a788c: Expose `Owner` struct and update it to support `ConsensusV2` owner types
+
+### Patch Changes
+
+- 7ba32a4: update dependencies
+
+## 1.5.0
+
+### Minor Changes
+
+- 03975f4: replace bs58 and bech32 packages with @scure/base
+
+## 1.4.0
+
+### Minor Changes
+
+- 95b1ea5: Add bcs.byteVector for parsing a vector<u8> into a Uint8Array
+
+## 1.3.0
+
+### Minor Changes
+
+- 10e2724: Allow BcsType.transform to omit input or output transform
+
+## 1.2.1
+
+### Patch Changes
+
+- 7abd243: Update repo links
+
+## 1.2.0
+
+### Minor Changes
+
+- ad24b95: Verify hex string is valid hex in `fromHex`
+
+## 1.1.1
+
+### Patch Changes
+
+- 1dd7713: Accept arrays of numbers when serializing bcs.bytes()
+
+## 1.1.0
+
+### Minor Changes
+
+- 489f421: Updated hex, base64, and base58 utility names for better consistency
+
+  All existing methods will continue to work, but the following methods have been deprecated and
+  replaced with methods with improved names:
+  - `toHEX` -> `toHEX`
+  - `fromHEX` -> `fromHex`
+  - `toB64` -> `toBase64`
+  - `fromB64` -> `fromBase64`
+  - `toB58` -> `toBase58`
+  - `fromB58` -> `fromBase58`
+
+## 1.0.4
+
+### Patch Changes
+
+- f37b3c2: Improve error message when bcs enum contains unknown value
+
+## 1.0.3
+
+### Patch Changes
+
+- 7fc464a: Remove unique symbols from types to improve compatability between version
+- 0f27a97: Update dependencies
+
+## 1.0.2
+
+### Patch Changes
+
+- 369b924343: Improve error messages when attempting to serialze non-array values that should be
+  arrays
+
+## 1.0.1
+
+### Patch Changes
+
+- f1e828f557: Remove undefined from bcs.option output types
+
+## 1.0.0
+
+### Major Changes
+
+- a92b03de42: The Typescript SDK has been renamed to `@haneullabs/haneul` and includes many new features
+  and breaking changes. See the
+  [full migration guide](https://sdk.haneullabs.com/typescript/migrations/haneul-1.0) for details on
+  how to upgrade.
+
+## 0.11.1
+
+### Patch Changes
+
+- 4830361fa4: Updated typescript version
+
+## 0.11.0
+
+### Minor Changes
+
+- bae8802fe3: Update base64 encoding to use global `atob` and `btoa` functions.
+
+## 0.10.1
+
+### Patch Changes
+
+- 9ac0a4ec01: Add extensions to all sdk import paths
+
+## 0.10.0
+
+### Minor Changes
+
+- e5f9e3ba21: Replace tsup based build to fix issues with esm/cjs dual publishing
+
+## 0.9.1
+
+### Patch Changes
+
+- dd362ec1d6: Update docs url to sdk.haneullabs.com
+
+## 0.9.0
+
+### Minor Changes
+
+- fce0a08d0f: Deprecate the bcs.generic helper. This helper causes typescript performance issues,
+  and the generated generics can't be exported
+
+## 0.8.1
+
+### Patch Changes
+
+- b48289346: Mark packages as being side-effect free.
+
+## 0.8.0
+
+### Minor Changes
+
+- 1bc430161: Add new type-safe schema builder. See https://sdk.haneullabs.com/bcs for updated
+  documentation
+- e4484852b: Add isSerializedBcs helper
+
+## 0.7.4
+
+### Patch Changes
+
+- 290c8e640: Fix parsing of hex strings where leading 0s have been trimmed
+
+## 0.7.3
+
+### Patch Changes
+
+- 36f2edff3: Fix an issue with parsing struct types with nested type parameters
+
+## 0.7.2
+
+### Patch Changes
+
+- ca5c72815d: Fix a bcs decoding bug for u128 and u256 values
+- fdb569464e: Fixes an issue with a top level generic in a nested vector
+
+## 0.7.1
+
+### Patch Changes
+
+- b4f0bfc76: Fix type definitions for package exports.
+
+## 0.7.0
+
+### Minor Changes
+
+- 19b567f21: Unified self- and delegated staking flows. Removed fields from `Validator`
+  (`stake_amount`, `pending_stake`, and `pending_withdraw`) and renamed `delegation_staking_pool` to
+  `staking_pool`. Additionally removed the `validator_stake` and `delegated_stake` fields in the
+  `ValidatorSet` type and replaced them with a `total_stake` field.
+- 5c3b00cde: Add object id to staking pool and pool id to staked sui.
+- 3d9a04648: Adds `deactivation_epoch` to staking pool object, and adds `inactive_pools` to the
+  validator set object.
+- a8049d159: Fixes the issue with deep nested generics by introducing array type names
+  - all of the methods (except for aliasing) now allow passing in arrays instead of strings to allow
+    for easier composition of generics and avoid using template strings
+
+  ```js
+  // new syntax
+  bcs.registerStructType(['VecMap', 'K', 'V'], {
+  	keys: ['vector', 'K'],
+  	values: ['vector', 'V'],
+  });
+
+  // is identical to an old string definition
+  bcs.registerStructType('VecMap<K, V>', {
+  	keys: 'vector<K>',
+  	values: 'vector<V>',
+  });
+  ```
+
+  Similar approach applies to `bcs.ser()` and `bcs.de()` as well as to other register\* methods
+
+- a0955c479: Switch from 20 to 32-byte address. Match Secp256k1.deriveKeypair with Ed25519.
+- 0a7b42a6d: This changes almost all occurences of "delegate", "delegation" (and various
+  capitalizations/forms) to their equivalent "stake"-based name. Function names, function argument
+  names, RPC endpoints, Move functions, and object fields have been updated with this new naming
+  convention.
+- 77bdf907f: When parsing u64, u128, and u256 values with bcs, they are now string encoded.
+
+## 0.6.1
+
+### Patch Changes
+
+- 0e202a543: Remove pending delegation switches.
+
+## 0.6.0
+
+```js
+// new syntax
+bcs.registerStructType(['VecMap', 'K', 'V'], {
+	keys: ['vector', 'K'],
+	values: ['vector', 'V'],
+});
+
+// is identical to an old string definition
+bcs.registerStructType('VecMap<K, V>', {
+	keys: 'vector<K>',
+	values: 'vector<V>',
+});
+```
+
+### Minor Changes
+
+- 598f106ef: Adds base58 encoding support to bcs
+
+- two functions added: `fromB58` and `toB58` similar to existing encodings
+- `Reader.toString` and `de/encodeStr` methods support new `base58` value
+- adds a 3 built-in types "hex-string", "base58-string" and "base64-string"
+- adds constants for the built-ins: `BCS.BASE64`, `BCS.BASE58` and `BCS.HEX`
+
+```js
+bcs.registerStructType('TestStruct', {
+	hex: BCS.HEX,
+	base58: BCS.BASE58,
+	base64: BCS.BASE64,
+});
+```
+
+### Adds type aliasing and inline definitions
+
+- adds new `registerAlias` function which allows type aliases and tracks basic recursion
+- adds support for inline definitions in the `.de()` and `.ser()` methods
+
+### Examples
+
+```js
+// inline definition example
+let struct = { name: 'Alice', age: 25 };
+let bytes = bcs.ser({ name: 'string', age: 'u8' }, struct).toBytes();
+let restored = bcs.de({ name: 'string', age: 'u8' }, bytes);
+
+// `restored` deeply equals `struct`
+```
+
+```js
+// aliases for types
+bcs.registerAlias('Name', 'string');
+bcs.ser('Name', 'Palpatine');
+```
+
+## 0.5.0
+
+### Minor Changes
+
+- 1a0968636: Remove usage of bn.js, and use native bigints instead.
+
+## 0.4.0
+
+### Minor Changes
+
+- 1591726e8: Support multiple instances of BCS
+
+### Patch Changes
+
+- 1591726e8: Add support for generic types
+
+## 0.3.0
+
+### Minor Changes
+
+- d343b67e: Re-release packages
+
+## 0.2.1
+
+### Patch Changes
+
+- c5e4851b: Updated build process from TSDX to tsup.
+- e2aa08e9: Fix missing built files for packages.
+
+Version history from v0.1.0 to this day.
+
+## v0.2.0 - Usability Boost
+
+- `bcs.de(...)` now supports strings if encoding is passed as the last argument
+- `BCS` (upper) -> `bcs` (lower) renaming
+- Improved documentation, checked documentation examples for failures
+
+## v0.1.0
+
+First version of libary published.