Skip to content

Commit

Permalink
Filling Changelog, filling method docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakub Zajkowski committed Jul 25, 2024
1 parent dbcbaef commit e113b6a
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 4 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
### Removed
-->

## [3.0.0-rc04] - 2024-07-25

### Added

- Brought back the functionality of setting contract hash (`setContractHash` method) in `Contract` class. Previously even using that method would ignore the contract hash due to a bug in the node. Now setting it will imply that the contract endpoints need to by called by contract hash. You still can use `setContractName`, but `setContractHash` takes priority if both are used.
- Added the possibility to muffle deprecation warnings in `CasperServiceByJsonRPC`. You can now pass `muffleDeprecationWarnings` as an optional parameter to the constructor. If set to `true`, the SDK will not log any deprecation warnings from that class. Defaults to `false`

### Removed

- `TransactionSessionKind` since field kind was removed from `Session` implementation of `TransactionTarget`
- Removed usages of `toHex`, `fromHex` and `toAccountHashStr` since they are deprecated.

### Changed

- `waitForDeploy` and `waitForTransaction` methods will fail fast if the results for getting deploy/transaction info is present but was not successfull.

## [3.0.0-rc02] - 2024-07-05

This release candidate is compatible with [#node RC3](https://github.com/casper-network/casper-node/tree/release-2.0.0-rc2)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "casper-js-sdk",
"version": "3.0.0-rc03",
"version": "3.0.0-rc04",
"license": "Apache 2.0",
"description": "SDK to interact with the Casper blockchain",
"homepage": "https://github.com/casper-ecosystem/casper-js-sdk#README.md",
Expand Down
3 changes: 2 additions & 1 deletion src/lib/Contracts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ export class Contract {
constructor(public casperClient?: CasperClient) {}

/**
* Attaches an on-chain smart contract to this `Contract` object using its hexadecimal string typed hash. The contract hash must include the prefix "hash-"
* Attaches an on-chain smart contract to this `Contract` object using its hexadecimal string typed hash. The contract hash must include the prefix "hash-".
* Setting contract hash will imply that the contract endpoints need to by called by contract hash. You still can use `setContractName`, but `setContractHash` takes priority if both are used.
* @param contractHash The hexadecimal smart contract hash, with the prefix "entity-contract-"
* @param contractPackageHash The hexadecimal smart contract package hash, with the prefix "package-". This parameter is optional, and only used when there is event processing present.
*/
Expand Down
1 change: 1 addition & 0 deletions src/services/CasperServiceByJsonRPC.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ export class CasperServiceByJsonRPC {
/**
* Constructor for building a `CasperServiceByJsonRPC`
* @param provider A provider uri
* @param muffleDeprecationWarnings If set to `true`, deprecation warnings in this class will be suppressed. Defaults to `false`.
*/
constructor(
provider: string | SafeEventEmitterProvider,
Expand Down

0 comments on commit e113b6a

Please sign in to comment.