Skip to content

Commit 01fa6b0

Browse files
hendrikebbersandrewb1269RickyLB
authored
Update README.md for transition to Hiero
Co-authored-by: Andrew Brandt <andrew.brandt@hashgraph.com> Co-authored-by: Ricky Saechao <76449893+RickyLB@users.noreply.github.com>
1 parent fb101ea commit 01fa6b0

File tree

1 file changed

+24
-40
lines changed

1 file changed

+24
-40
lines changed

README.md

Lines changed: 24 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
1-
# Hedera™ Swift SDK
1+
# Hiero Swift SDK
22

3-
> The SDK for interacting with Hedera Hashgraph: the official distributed
4-
> consensus platform built using the hashgraph consensus algorithm for fast,
5-
> fair and secure transactions. Hedera enables and empowers developers to
6-
> build an entirely new class of decentralized applications.
3+
The SDK for interacting with a Hiero based netwrok.
74

8-
<sub>Maintained with ❤️ by <a href="https://launchbadge.com" target="_blank">LaunchBadge</a>, <a href="https://www.swirlds.com/" target="_blank">Swirlds Labs</a>, and the Hedera community</sub>
5+
<sub>Maintained with ❤️ by <a href="https://launchbadge.com" target="_blank">LaunchBadge</a>, <a href="https://www.hashgraph.com/" target="_blank">Hashgraph</a>, and the Hedera community</sub>
96

10-
## Requirements
7+
## Usage
8+
9+
### Requirements
1110

1211
- Swift v5.6+
1312
- MacOS v10.15+ (2019, Catalina)
1413
- iOS 13+ (2019)
1514

16-
## Install
15+
### Install
1716

1817
```swift
1918
// Package.swift
2019
dependencies: [
21-
.package(url: "https://github.com/hashgraph/hedera-sdk-swift.git", from: "0.1.0")
20+
.package(url: "https://github.com/hiero-project/hiero-sdk-swift.git", from: "1.0.0")
2221
]
2322
```
2423

2524
See ["Adding Package Dependencies to Your App"](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) for help on
2625
adding a swift package to an Xcode project.
2726

28-
## Usage
27+
### Add to Code
2928

3029
```swift
31-
import Hedera
30+
import Hiero
3231

3332
// connect to the Hedera network
3433
let client = Client.forTestnet()
@@ -43,40 +42,20 @@ print("balance = \(ab.balance)")
4342

4443
See [examples](./Examples) for more usage.
4544

46-
## Community and Support
47-
48-
If you have any questions on the Hedera SDK or Hedera more generally,
49-
you can join our team and hundreds of other developers using Hedera in our
50-
community Discord:
51-
52-
<a href="https://hedera.com/discord" target="_blank">
53-
<img alt="" src="https://user-images.githubusercontent.com/753919/167244200-b95cd3a6-6256-4eaf-b9b4-f1f192341485.png" height="60">
54-
</a>
55-
56-
## License
57-
58-
Licensed under Apache License,
59-
Version 2.0 – see [LICENSE](LICENSE)
60-
or [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
61-
62-
## Contribution
63-
64-
Unless you explicitly state otherwise, any contribution intentionally submitted
65-
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
66-
licensed as above, without any additional terms or conditions.
67-
6845
## Development (HederaProtobufs)
6946

70-
HederaProtobufs is entirely generated
47+
HederaProtobufs is entirely generated. The protobufs repo will be migrated to Hiero [in near future](https://github.com/LFDT-Hiero/hiero/blob/main/transition.md).
48+
49+
### Required Tooling
7150

72-
### Required tooling
7351
protoc
7452
protoc-gen-swift (from https://github.com/apple/swift-protobuf)
7553
protoc-gen-grpc-swift (from https://github.com/grpc/grpc-swift)
7654
task (from https://github.com/go-task/task)
7755

7856
### Fetch Submodule (Hedera-Protobufs)
79-
Update [\protobuf](https://github.com/hashgraph/hedera-services) submodule to latest changes.
57+
58+
Update [\protobuf](https://github.com/hashgraph/hedera-protobufs) submodule to latest changes.
8059
```bash
8160
## Fetch the latest version of the services submodule
8261
## Note: Append "proto=<version>" to fetch a specific version
@@ -97,7 +76,9 @@ protoc --grpc-swift_opt=Visibility=Public,Server=false --grpc-swift_out=./Source
9776
```
9877

9978
### Integration Tests
79+
10080
Before running the integration tests, an operator key, operator account id, and a network name must be set in an `.env` file.
81+
10182
```bash
10283
# Account that will pay query and transaction fees
10384
TEST_OPERATOR_ID=
@@ -111,16 +92,19 @@ TEST_NETWORK_NAME=
11192
$ swift test
11293
```
11394

114-
#### Local Environment Testing
115-
Hedera offers a way to run tests through your localhost using the `hedera-local-node` service.
95+
The networks testnet, previewnet, and mainnet are the related and publicly available [Hedera networks](https://docs.hedera.com/hedera/networks).
11696

117-
For instructions on how to set up and run local node, follow the steps in the git repository:
118-
https://github.com/hashgraph/hedera-local-node
97+
### Local Environment Testing
11998

99+
You can run tests through your localhost using the `hedera-local-node` service.
100+
For instructions on how to set up and run local node, follow the steps in the [git repository](https://github.com/hashgraph/hedera-local-node).
101+
The repo will be migrated to Hiero [in near future](https://github.com/LFDT-Hiero/hiero/blob/main/transition.md).
120102
Once the local node is running in Docker, the appropriate `.env` values must be set:
103+
121104
```bash
122105
TEST_OPERATOR_ID=0.0.2
123106
TEST_OPERATOR_KEY=3030020100300706052b8104000a042204205bc004059ffa2943965d306f2c44d266255318b3775bacfec42a77ca83e998f2
124107
TEST_NETWORK_NAME=localhost
125108
```
109+
126110
Lastly, run the tests using `swift test`

0 commit comments

Comments
 (0)