Skip to content

Commit

Permalink
Changed readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
ne0nx committed Sep 2, 2018
1 parent c8cf270 commit 4b9b3ee
Showing 1 changed file with 19 additions and 24 deletions.
43 changes: 19 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/12425729/40763856-5f14764a-64e1-11e8-8684-2f1c8497abd5.png" alt="EthereumKit" height="300px">
</p>

EthereumKit is a Swift framework that enables you to create Ethereum wallet and use it in your app.
EthereumKitSwift is a framework that enables you to create Ethereum wallet and use it in your app.

```swift
// BIP39: Generate seed and mnemonic sentence.
Expand All @@ -25,53 +22,51 @@ let rawTransaction = RawTransaction(
)

let tx = try! wallet.signTransaction(rawTransaction)
geth.sendRawTransaction(rawTransaction: tx) { result in
// Do something...
}
print(tx)
```

## Set up

- Run `make bootstrap`

## Features
- Mnemonic recovery phrease in [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
- [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)/[BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) HD wallet
- [EIP55](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-55.md) format address encoding
- [EIP155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md) replay attack protection
- Sign transaction
- ERC20 token transfer
- [Keystore v3](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition) with PBKDF2-SHA-256 and Scrypt DK functions

## Documentations

- [Getting Started](Documentation/GettingStarted.md)
- [ERC20 Token](Documentation/ERC20.md)
- [JSONRPC API](Documentation/JSONRPC.md)
- [Etherscan API](Documentation/Etherscan.md)
<!-- - [Keystore v3](Documentation/Keystorev3.md) -->
<!-- - [JSONRPC API](Documentation/JSONRPC.md) -->
<!-- - [Etherscan API](Documentation/Etherscan.md) -->

## Requirements

- Swift 4.0 or later
- iOS 9.0 or later
- Swift 4.1 or later
- iOS 10.0 or later

## Installation
#### [Carthage](https://github.com/Carthage/Carthage)

- Insert `github "yuzushioh/EthereumKit"` to your Cartfile.
- Run `carthage update --platform ios`.
#### [CocoaPods](https://github.com/CocoaPods/CocoaPods)

```ruby
pod 'EthereumKitSwift', git: '[email protected]:anchorpw/ethereum-kit-swift.git', branch: 'master'
```
- Insert to your Podfile.
- Run `pod install`.

## Dependency

- [CryptoEthereumSwift](https://github.com/yuzushioh/CryptoEthereumSwift): Ethereum cryptography implementations for iOS framework
- [BigInt](https://github.com/attaswift/BigInt): Arbitrary-precision arithmetic in pure Swift
- [libscrypt](https://github.com/technion/libscrypt): A shared library that implements scrypt() functionality

## Apps using EthereumKit

- [gnosis/safe-ios](https://github.com/gnosis/safe-ios): Gnosis Safe is a multi signature (2FA) wallet for personal usage.
- [popshootjapan/WeiWallet-iOS](https://github.com/popshootjapan/WeiWallet-iOS): Wei Wallet for iOS
## Author

Ryo Fukuda, [@yuzushioh](https://twitter.com/yuzushioh), [email protected]

- Ryo Fukuda, [@yuzushioh](https://twitter.com/yuzushioh), [email protected]
- DK, [email protected]

## License
EthereumKit is released under the [Apache License 2.0](LICENSE.md).

0 comments on commit 4b9b3ee

Please sign in to comment.