Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release finschia-kt v0.2.1 #13

Merged
merged 3 commits into from
Apr 27, 2023
Merged

Release finschia-kt v0.2.1 #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3db6bdc
chore: update changelog for release v0.2.1
zemyblue Apr 27, 2023
21313b8
chore: update finschia-sdk version and url in README.
zemyblue Apr 27, 2023
072c043
chore: remove unused README description.
zemyblue Apr 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ Ref: https://keepachangelog.com/en/1.0.0/
### Added

### Changed
* [\#6](https://github.com/Finschia/finschia-kt/pull/6) Rename package 'ln.v2' -> 'sdk'
* (ci) [\#11](https://github.com/Finschia/finschia-kt/pull/11) Add ci/cd to publish to maven

### Deprecated

Expand All @@ -54,9 +52,20 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Build, CI

* (build) [\#4](https://github.com/Finschia/finschia-kt/pull/4) Add gradle `updateSubmodule` task and `checkoutSubModule` task to run `git submodule update --init --remote` with specific version before `build task`

### Document Updates


## [v0.2.1]

### Changed
* [\#6](https://github.com/Finschia/finschia-kt/pull/6) Rename package 'ln.v2' -> 'sdk'
* (ci) [\#11](https://github.com/Finschia/finschia-kt/pull/11) Add ci/cd to publish to maven

### Build, CI

* (build) [\#4](https://github.com/Finschia/finschia-kt/pull/4) Add gradle `updateSubmodule` task and `checkoutSubModule` task to run `git submodule update --init --remote` with specific version before `build task`


<!-- Release links -->
[Unreleased]: https://github.com/Finschia/finschia-kt/compare/8aa2005...HEAD
[Unreleased]: https://github.com/Finschia/finschia-kt/compare/v0.2.1...HEAD
[v0.2.1]: https://github.com/Finschia/finschia-kt/compare/8aa2005...v0.2.1
23 changes: 3 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,18 @@

gRPC client library in kotlin for finschia (https://github.com/Finschia/finschia).

Requires [finschia-sdk v0.47.0-alpha1](https://github.com/Finschia/finschia-sdk/tree/v0.47.0-alpha1)
Requires [finschia-sdk v0.47.0](https://github.com/Finschia/finschia-sdk/tree/v0.47.0)

Current finschia-sdk version applied to finschia-kt/protobuf is [finschia-sdk v0.47.0-alpha1](https://github.com/Finschia/finschia-sdk/tree/v0.47.0-alpha1)
Current finschia-sdk version applied to finschia-kt/protobuf is [finschia-sdk v0.47.0](https://github.com/Finschia/finschia-sdk/tree/v0.47.0)

## Build

You can build the project by following command, which also runs all the unit tests:

```shell
$ git submodule update --init
$ ./gradlew build
```

Note that any version of finschia-kt is only compatible with a certain finschia-sdk version. The corresponding finschia-sdk
version that the current repository supports can be found in the tag or commit hash of `proto/repositories/finschia-sdk`
submodule, using the following command.

```shell
$ cd protobuf/repositories/finschia-sdk && git describe --always && cd -
```

If you are a finschia-kt developer or contributor and trying to use another version of finschia-sdk, `git checkout`
the appropriate version in the finschia-sdk submodule before building this repository. The following command is an example
of using finschia-sdk `v0.47.0-alpha1`.

```shell
$ cd protobuf/repositories/finschia-sdk && git checkout v0.47.0-alpha1 && cd -
```

## How to use

### 1. How to get a Bech32 address from the KeyWallet
Expand Down Expand Up @@ -90,7 +73,7 @@ The former is using the tx wrapper, while the latter does not use the wrapper.

### 1. Run finschia-sdk simapp

Build with reference to [Quick Start build](https://github.com/Finschia/finschia-sdk/tree/v0.47.0-alpha1#quick-start).
Build with reference to [Quick Start build](https://github.com/Finschia/finschia-sdk/tree/v0.47.0#quick-start).

Initialize and configure simapp.

Expand Down