Skip to content

docs: Rust documentation tests for the SolRpcClient#65

Merged
gregorydemay merged 12 commits intomainfrom
gdemay/XC-331-client-doctest
Apr 17, 2025
Merged

docs: Rust documentation tests for the SolRpcClient#65
gregorydemay merged 12 commits intomainfrom
gdemay/XC-331-client-doctest

Conversation

@gregorydemay
Copy link
Contributor

@gregorydemay gregorydemay commented Apr 11, 2025 •
edited
Loading

Add Rust documentation tests for the SolRpcClient in the sol_rpc_client crate.

This requires a mocked implementation of a Runtime to mock a canister making (through the client) an update or a query call:

  1. This implementation is only available behind the flag #[cfg(not(target_arch = "wasm32"))] to ensure that it cannot be used inside a canister and does not "pollute" the productive code.
  2. An alternative solution would have been to extract this mocked implementation to yet another crate; however, this was deemed to cumbersome.

@gregorydemay gregorydemay changed the base branch from main to gdemay/XC-331-readmes April 11, 2025 08:01
@gregorydemay gregorydemay mentioned this pull request Apr 11, 2025
Merged
Base automatically changed from gdemay/XC-331-readmes to main April 14, 2025 08:44
@gregorydemay gregorydemay changed the title test: doctest for client docs: Rust doc tests for the SolRpcClient Apr 14, 2025
@gregorydemay gregorydemay changed the title docs: Rust doc tests for the SolRpcClient docs: Rust documentation tests for the SolRpcClient Apr 14, 2025
@gregorydemay gregorydemay marked this pull request as ready for review April 14, 2025 13:25
@gregorydemay gregorydemay requested a review from a team as a code owner April 14, 2025 13:25
@gregorydemay gregorydemay merged commit c0a08e5 into main Apr 17, 2025
14 checks passed
@gregorydemay gregorydemay deleted the gdemay/XC-331-client-doctest branch April 17, 2025 08:20
This was referenced Apr 28, 2025
Closed
Merged
gregorydemay added a commit that referenced this pull request Apr 29, 2025
@github-actions @gregorydemay
chore: release v0.1.0 (#88)
329e982 
## 🤖 New release

* `sol_rpc_types`: 0.1.0
* `sol_rpc_canister`: 0.1.0
* `sol_rpc_client`: 0.1.0

<details><summary><i><b>Changelog</b></i></summary><p>

## `sol_rpc_types`

<blockquote>

## [0.1.0] - 2025-04-29

### Added

- Add Rustdoc for types related to `getTransaction`
([#71](#71))
- Add support for `getTransaction` RPC method
([#68](#68))
- Add `getBlock` RPC method
([#53](#53))
- Add `sendTransaction` RPC method
([#59](#59))
- Add NOTICE to Apache license
([#60](#60))
- Add `getAccountInfo` RPC method
([#49](#49))
- Add metrics
([#41](#41))
- Add logging crate
([#13](#13))
- Add doc build stage to CI
([#19](#19))
- Add support for override providers
([#12](#12))

### Changed

- Use `canlog_derive` and `canlog` from crates.io
([#84](#84))
- Release pipeline
([#4](#4))
- Default commitment level for `SolRpcClient`
([#77](#77))
- Support method `getBalance`
([#74](#74))
- Rename some enum variants to camel case when serializing
([#72](#72))
- Use SOL RPC canister in `basic_solana` example
([#69](#69))
- Add basic README instructions
([#63](#63))
- Cycles cost
([#52](#52))
- Client builder
([#54](#54))
- Round result from `getSlot` RPC method
([#48](#48))
- Use `canhttp` `multi` feature
([#46](#46))
- Implement getSlot RPC method
([#33](#33))
- Add some tested RPC providers for Solana Mainnet and Devnet
([#15](#15))
- Streamline providers
([#32](#32))
- Add support for API keys
([#10](#10))
- Hard-code SOL RPC providers
([#9](#9))
- Basic Solana wallet example
([#1](#1))
- Initial cargo workspace and build pipeline
([#2](#2))

### Fixed

- Correct Solana cluster for dRPC and Helius providers
([#47](#47))


<!-- generated by git-cliff -->
Changelog

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

The format is based on [Keep a
Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic
Versioning](https://semver.org/spec/v2.0.0.html).
</blockquote>

## `sol_rpc_canister`

<blockquote>

## [0.1.0] - 2025-04-29

### Added

- Add support for `getTransaction` RPC method
([#68](#68))
- Add `getBlock` RPC method
([#53](#53))
- Add `sendTransaction` RPC method
([#59](#59))
- Add NOTICE to Apache license
([#60](#60))
- Add `getAccountInfo` RPC method
([#49](#49))
- Add metrics
([#41](#41))
- Add logging crate
([#13](#13))
- Add support for override providers
([#12](#12))

### Changed

- Use `canlog_derive` and `canlog` from crates.io
([#84](#84))
- Release pipeline
([#4](#4))
- Clean-up TODOs
([#81](#81))
- Support method `getBalance`
([#74](#74))
- Remove http_types module and use external ic-http-types crate
([#73](#73))
- Rename some enum variants to camel case when serializing
([#72](#72))
- Use constant size JSON-RPC request ID
([#62](#62))
- Use method from JSON-RPC request for metric
([#61](#61))
- Cycles cost
([#52](#52))
- Client builder
([#54](#54))
- Round result from `getSlot` RPC method
([#48](#48))
- Use `canhttp` `multi` feature
([#46](#46))
- Implement a method for making generic RPC request
([#39](#39))
- Implement getSlot RPC method
([#33](#33))
- Add some tested RPC providers for Solana Mainnet and Devnet
([#15](#15))
- Streamline providers
([#32](#32))
- Update rust toolchain to 1.85
([#21](#21))
- Remove unnecessary Storable implementations
([#14](#14))
- Add support for API keys
([#10](#10))
- Hard-code SOL RPC providers
([#9](#9))
- Reproducible build
([#3](#3))
- Initial cargo workspace and build pipeline
([#2](#2))

### Fixed

- Set `maxSupportedTransactionVersion` to zero for end-to-end tests
([#85](#85))
- API keys ([#58](#58))
- End-to-end tests
([#45](#45))
- Correct Solana cluster for dRPC and Helius providers
([#47](#47))
- E2e test with Solana test validator
([#20](#20))
- Create test canister on ICP mainnet
([#8](#8))


<!-- generated by git-cliff -->
Changelog

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

The format is based on [Keep a
Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic
Versioning](https://semver.org/spec/v2.0.0.html).
</blockquote>

## `sol_rpc_client`

<blockquote>

## [0.1.0] - 2025-04-29

### Added

- Add support for `getTransaction` RPC method
([#68](#68))
- Add `getBlock` RPC method
([#53](#53))
- Add `sendTransaction` RPC method
([#59](#59))
- Add NOTICE to Apache license
([#60](#60))
- Add `getAccountInfo` RPC method
([#49](#49))

### Changed

- Release pipeline
([#4](#4))
- Default commitment level for `SolRpcClient`
([#77](#77))
- Support method `getBalance`
([#74](#74))
- Use SOL RPC canister in `basic_solana` example
([#69](#69))
- Rust documentation tests for the `SolRpcClient`
([#65](#65))
- Add basic README instructions
([#63](#63))
- Cycles cost
([#52](#52))
- Client builder
([#54](#54))
- Round result from `getSlot` RPC method
([#48](#48))
- Use `canhttp` `multi` feature
([#46](#46))
- Implement a method for making generic RPC request
([#39](#39))
- Implement getSlot RPC method
([#33](#33))
- Streamline providers
([#32](#32))
- Add support for API keys
([#10](#10))
- Hard-code SOL RPC providers
([#9](#9))
- Initial cargo workspace and build pipeline
([#2](#2))

### Fixed

- Forward calls through wallet canister
([#40](#40))
- E2e test with Solana test validator
([#20](#20))


<!-- generated by git-cliff -->
Changelog

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

The format is based on [Keep a
Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic
Versioning](https://semver.org/spec/v2.0.0.html).
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

---------

Co-authored-by: gregorydemay <gregory.demay@dfinity.org>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ninegua ninegua ninegua approved these changes

@lpahlavi lpahlavi Awaiting requested review from lpahlavi

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@gregorydemay @ninegua

Comments