Skip to content

Commit

Permalink
Update changelogs
Browse files Browse the repository at this point in the history
  • Loading branch information
limemloh committed Sep 28, 2023
1 parent 90b3ff7 commit f939478
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 5 deletions.
17 changes: 17 additions & 0 deletions packages/common/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@
- `deserializeInitError`
- `deserializeTypeValue`

The API now uses dedicated types instead of language primitives:
- Use `AccountAddress` instead of a string with base58 encoding. Use `AccountAddress.fromBase58('<base58>')` to construct it.
- Use `BlockHash` instead of a string with hex encoding. Use `BlockHash.fromHexString('<hex>')` to construct it.
- Use `TranactionHash` instead of a string with hex encoding. Use `TransactionHash.fromHexString('<hex>')` to construct it.
- Use `Energy` instead of a bigint. Use `Energy.create(<integer>)` to construct it.
- Use `ReceiveName` instead of a string. Use `ReceiveName.fromString('<contract>.<function>')` to construct it.
- Use `InitName` instead of a string. Use `Init.fromString('init_<contract>')` to construct it.
- Use `ContractName` instead of a string. Use `ContractName.fromString('<contract>')` to construct it.
- Use `EntrypointName` instead of a string. Use `EntrypointName.fromString('<function>')` to construct it.
- Use `Parameter` instead of a string with hex encoding. Use `Parameter.fromHexString('<hex>')`.
- Use `SequenceNumber` (formerly called nonce) instead of a bigint. Use `SequenceNumber.create(<integer>)` to construct it.
- Use `Timestamp` instead of a bigint. Can be constructed using `Timestamp.fromMillis(<integer>)`.
- Use `Duration` instead of a bigint. Can be constructed using `Duration.fromMillis(<integer>)`.

Several types have been replaced with a module containing the type itself together with functions for constructing and converting the type:
- `AccountAddress` is now a module with functions related to account addresses:
- To refer to `AccountAddress` as a type use `AccountAddress.Type`.
Expand All @@ -43,6 +57,8 @@ Several types have been replaced with a module containing the type itself togeth
- To refer to `CredentialRegistrationId` as a type use `CredentialRegistrationId.Type`.
- Constructing `new CredentialRegistrationId("<hex-string>")` is now `CredentialRegistrationId.fromHexString("<hex-string>")`.

- Renamed `AccountSequenceNumber` module to `SequenceNumber`.

### Added

- All JSON serialization in `serialization.ts` is now handled by `json-bigint` meaning that all functions now correctly handles bigint inputs
Expand All @@ -51,6 +67,7 @@ Several types have been replaced with a module containing the type itself togeth
- `Duration` is now a module with functions related to durations of time.
- `EntrypointName` is now a module with functions related to entrypoint names of a smart contract.
- `ReceiveName` is now a module with functions related to receive-function names of a smart contract.
- `ReturnValue` is now a module with functions related to return values from invoking a smart contract.

## 9.4.0

Expand Down
5 changes: 0 additions & 5 deletions packages/common/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,6 @@ export interface AddressAccount {
address: AccountAddress.Type;
}

// export interface ContractAddress {
// index: bigint;
// subindex: bigint;
// }

export type AccountIdentifierInput =
| AccountAddress.Type
| CredentialRegistrationId.Type
Expand Down
17 changes: 17 additions & 0 deletions packages/nodejs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@
- NodeJS: 4.7, `"moduleResolution": "node16" // or "nodenext"`
- Bundled applications (webpack, esbuild, rollup, etc...): 5.0, `"moduleResolution": "bundler"`


The API now uses dedicated types instead of language primitives:
- Use `AccountAddress` instead of a string with base58 encoding. Use `AccountAddress.fromBase58('<base58>')` to construct it.
- Use `BlockHash` instead of a string with hex encoding. Use `BlockHash.fromHexString('<hex>')` to construct it.
- Use `TranactionHash` instead of a string with hex encoding. Use `TransactionHash.fromHexString('<hex>')` to construct it.
- Use `Energy` instead of a bigint. Use `Energy.create(<integer>)` to construct it.
- Use `ReceiveName` instead of a string. Use `ReceiveName.fromString('<contract>.<function>')` to construct it.
- Use `InitName` instead of a string. Use `Init.fromString('init_<contract>')` to construct it.
- Use `ContractName` instead of a string. Use `ContractName.fromString('<contract>')` to construct it.
- Use `EntrypointName` instead of a string. Use `EntrypointName.fromString('<function>')` to construct it.
- Use `Parameter` instead of a string with hex encoding. Use `Parameter.fromHexString('<hex>')`.
- Use `SequenceNumber` (formerly called nonce) instead of a bigint. Use `SequenceNumber.create(<integer>)` to construct it.
- Use `Timestamp` instead of a bigint. Can be constructed using `Timestamp.fromMillis(<integer>)`.
- Use `Duration` instead of a bigint. Can be constructed using `Duration.fromMillis(<integer>)`.

Several types have been replaced with a module containing the type itself together with functions for constructing and converting the type:
- `AccountAddress` is now a module with functions related to account addresses:
- To refer to `AccountAddress` as a type use `AccountAddress.Type`.
Expand All @@ -36,6 +51,8 @@ Several types have been replaced with a module containing the type itself togeth
- To refer to `CredentialRegistrationId` as a type use `CredentialRegistrationId.Type`.
- Constructing `new CredentialRegistrationId("<hex-string>")` is now `CredentialRegistrationId.fromHexString("<hex-string>")`.

- Renamed `AccountSequenceNumber` module to `SequenceNumber`.

### Added

- All JSON serialization in `serialization.ts` is now handled by `json-bigint` meaning that all functions now correctly handles bigint inputs
Expand Down
17 changes: 17 additions & 0 deletions packages/web/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@
- NodeJS: 4.7, `"moduleResolution": "node16" // or "nodenext"`
- Bundled applications (webpack, esbuild, rollup, etc...): 5.0, `"moduleResolution": "bundler"`


The API now uses dedicated types instead of language primitives:
- Use `AccountAddress` instead of a string with base58 encoding. Use `AccountAddress.fromBase58('<base58>')` to construct it.
- Use `BlockHash` instead of a string with hex encoding. Use `BlockHash.fromHexString('<hex>')` to construct it.
- Use `TranactionHash` instead of a string with hex encoding. Use `TransactionHash.fromHexString('<hex>')` to construct it.
- Use `Energy` instead of a bigint. Use `Energy.create(<integer>)` to construct it.
- Use `ReceiveName` instead of a string. Use `ReceiveName.fromString('<contract>.<function>')` to construct it.
- Use `InitName` instead of a string. Use `Init.fromString('init_<contract>')` to construct it.
- Use `ContractName` instead of a string. Use `ContractName.fromString('<contract>')` to construct it.
- Use `EntrypointName` instead of a string. Use `EntrypointName.fromString('<function>')` to construct it.
- Use `Parameter` instead of a string with hex encoding. Use `Parameter.fromHexString('<hex>')`.
- Use `SequenceNumber` (formerly called nonce) instead of a bigint. Use `SequenceNumber.create(<integer>)` to construct it.
- Use `Timestamp` instead of a bigint. Can be constructed using `Timestamp.fromMillis(<integer>)`.
- Use `Duration` instead of a bigint. Can be constructed using `Duration.fromMillis(<integer>)`.

Several types have been replaced with a module containing the type itself together with functions for constructing and converting the type:
- `AccountAddress` is now a module with functions related to account addresses:
- To refer to `AccountAddress` as a type use `AccountAddress.Type`.
Expand All @@ -36,6 +51,8 @@ Several types have been replaced with a module containing the type itself togeth
- To refer to `CredentialRegistrationId` as a type use `CredentialRegistrationId.Type`.
- Constructing `new CredentialRegistrationId("<hex-string>")` is now `CredentialRegistrationId.fromHexString("<hex-string>")`.

- Renamed `AccountSequenceNumber` module to `SequenceNumber`.

### Added

- All JSON serialization in `serialization.ts` is now handled by `json-bigint` meaning that all functions now correctly handles bigint inputs
Expand Down

0 comments on commit f939478

Please sign in to comment.