|
1 |
| -<!-- START doctoc generated TOC please keep comment here to allow auto update --> |
2 |
| -<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
3 |
| -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* |
| 1 | +Documentation |
4 | 2 |
|
5 |
| -- [Design Decisions](#design-decisions) |
6 |
| -- [Core features:](#core-features) |
7 |
| -- [FAQ](#faq) |
| 3 | +*If you need to find or understand basic Usage, check [Usage.md](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md).* |
8 | 4 |
|
9 |
| -<!-- END doctoc generated TOC please keep comment here to allow auto update --> |
| 5 | +Here are quick references for essential features: |
| 6 | + |
| 7 | +- [Preffered models](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#preffered-models) |
| 8 | +- [Account Management (create, import, private keys managments, etc.)](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#account-management) |
| 9 | +- [Ethereum Endpoints interaction (web3, balance, tx's operations, chain state)](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ethereum-endpoints-interaction) |
| 10 | +- [Websockets](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#websockets) |
| 11 | +- [ENS](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ens) |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +- [Account Management](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#account-management) |
| 18 | + |
| 19 | + - [Create Account](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#create-account) |
| 20 | + - [Import Account](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#import-account) |
| 21 | + - [Get Keystore Manager from wallet data](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#get-keystore-manager-from-wallet-data) |
| 22 | + - [Get private key](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#get-private-key) |
| 23 | + |
| 24 | +- [Ethereum Endpoints interaction](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ethereum-endpoints-interaction) |
| 25 | + |
| 26 | + - [web3 instance](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#web3-instance) |
| 27 | + - [Ethereum Address](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ethereum-address) |
| 28 | + - [Get Balance](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#get-balance) |
| 29 | + - [Transactions Operations](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#transactions-operations) |
| 30 | + - [Send Ether](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#send-ether) |
| 31 | + - [Send ERC-20 Token](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#send-erc-20-token) |
| 32 | + - [Write Transaction and call smart contract method](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#write-transaction-and-call-smart-contract-method) |
| 33 | + - [Read Transaction to call smart contract method](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#read-transaction-to-call-smart-contract-method) |
| 34 | + - [Send Transaction](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#send-transaction) |
| 35 | + - [Get Block number](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#get-block-number) |
| 36 | + |
| 37 | +- [Websockets](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#websockets) |
| 38 | + |
| 39 | +- [ENS](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ens) |
| 40 | + |
| 41 | + |
10 | 42 |
|
11 | 43 | ## Design Decisions
|
12 | 44 |
|
|
31 | 63 | - [x] Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly"and "before submission"
|
32 | 64 | - [x] **Literally following the standards:**
|
33 | 65 | - [x] [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) HD Wallets: Deterministic Wallet
|
| 66 | + |
34 | 67 | - [x] [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) (Seed phrases)
|
| 68 | + |
35 | 69 | - [x] [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) (Key generation prefixes)
|
| 70 | + |
36 | 71 | - [x] [EIP-20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md) (A standard interface for tokens - ERC-20)
|
| 72 | + |
37 | 73 | - [x] [EIP-67](https://github.com/ethereum/EIPs/issues/67) (Standard URI scheme)
|
| 74 | + |
38 | 75 | - [x] [EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md) (Replay attacks protection) *enforced!*
|
| 76 | + |
39 | 77 | - [x] [EIP-681](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-681.md) (A standard way of representing various transactions, especially payment requests in Ethers and ERC-20 tokens as URLs)
|
| 78 | + |
40 | 79 | - [x] [EIP-721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) (A standard interface for non-fungible tokens, also known as deeds - ERC-721)
|
| 80 | + |
41 | 81 | - [x] [EIP-165](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-165.md) (Standard Interface Detection, also known as ERC-165)
|
| 82 | + |
42 | 83 | - [x] [EIP-777](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-777.md) (New Advanced Token Standard, also known as ERC-777)
|
| 84 | + |
43 | 85 | - [x] [EIP-820](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-820.md) (Pseudo-introspection Registry Contract, also known as ERC-820)
|
| 86 | + |
44 | 87 | - [x] [EIP-888](https://github.com/ethereum/EIPs/issues/888) (MultiDimensional Token Standard, also known as ERC-888)
|
| 88 | + |
45 | 89 | - [x] [EIP-1400](https://github.com/ethereum/EIPs/issues/1411) (Security Token Standard, also known as ERC-1400)
|
| 90 | + |
46 | 91 | - [x] [EIP-1410](https://github.com/ethereum/EIPs/issues/1410) (Partially Fungible Token Standard, also known as ERC-1410)
|
| 92 | + |
47 | 93 | - [x] [EIP-1594](https://github.com/ethereum/EIPs/issues/1594) (Core Security Token Standard, also known as ERC-1594)
|
| 94 | + |
48 | 95 | - [x] [EIP-1643](https://github.com/ethereum/EIPs/issues/1643) (Document Management Standard, also known as ERC-1643)
|
| 96 | + |
49 | 97 | - [x] [EIP-1644](https://github.com/ethereum/EIPs/issues/1644) (Controller Token Operation Standard, also known as ERC-1644)
|
| 98 | + |
50 | 99 | - [x] [EIP-1633](https://github.com/ethereum/EIPs/issues/1634) (Re-Fungible Token, also known as ERC-1633)
|
| 100 | + |
51 | 101 | - [x] [EIP-721x](https://github.com/loomnetwork/erc721x) (An extension of ERC721 that adds support for multi-fungible tokens and batch transfers, while being fully backward-compatible, also known as ERC-721x)
|
| 102 | + |
52 | 103 | - [x] [EIP-1155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md) (Multi Token Standard, also known as ERC-1155)
|
| 104 | + |
53 | 105 | - [x] [EIP-1376](https://github.com/ethereum/EIPs/issues/1376) (Service-Friendly Token, also known as ERC-1376)
|
| 106 | + |
54 | 107 | - [x] [ST-20](https://github.com/PolymathNetwork/polymath-core) - ST-20 token is an Ethereum-based token implemented on top of the ERC-20 protocol that adds the ability for tokens to control transfers based on specific rules
|
| 108 | + |
| 109 | + |
| 110 | + |
| 111 | +### Migration Guides |
| 112 | + |
| 113 | +- [web3swift 2.0 Migration Guide](https://github.com/matterinc/web3swift/blob/master/Documentation/web3swift%202.0%20Migration%20Guide.md) |
| 114 | + |
| 115 | +## |
55 | 116 |
|
56 | 117 | ## FAQ
|
57 | 118 |
|
|
0 commit comments