You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Nightly and Continuous integration tests against official Tezos RPC nodes
18
18
* dApp development uses cases a first-class concern, empowering new developers to get results quickly
19
19
* No dependencies on the Tezos RPC node for generating operations (Ex: not dependant on “forge” RPC method).
20
-
* Well documented API using [TypeDoc](https://tezos-ts.io/typedoc)
21
-
* Set of ready-made React components for common use-cases, with a [Demo Gallery](https://tezos-ts.io/react-storybook/)
20
+
* Well documented API using [TypeDoc](https://taquito.tez.ie/typedoc)
21
+
* Set of ready-made React components for common use-cases, with a [Demo Gallery](https://taquito.tez.ie/react-storybook/)
22
22
* Regular versioned releases, published to npmjs.org, with a published version strategy
23
23
* Participation in the [CII Best Practices](https://bestpractices.coreinfrastructure.org) program and all requirements entailed therein
24
24
* Portable - This library has minimum dependencies, making it usable in any js project on the front or back end.
@@ -27,48 +27,48 @@ The goals of this library are:
27
27
28
28
## Project Organization
29
29
30
-
`tezos-ts` is organized as a mono repository from which several npm packages are built and published. Packages are in the `packages/` directory, each one with its a README file.
30
+
`taquito` is organized as a mono repository from which several npm packages are built and published. Packages are in the `packages/` directory, each one with its a README file.
31
31
32
-
We publish gpg signed packages to npmjs.org under the `@tezos-ts` handle.
32
+
We publish gpg signed packages to npmjs.org under the `@taquito` handle.
|[@tezos-ts/tezos-ts](packages/tezos-ts)| Regroup every other library and provide higher level utility |
37
-
|[@tezos-ts/react-components](packages/tezos-ts-react-components)| React components that implement some common use cases |
38
-
|[@tezos-ts/rpc](packages/tezos-ts-rpc)| RPC client library, wrap every rpc endpoint in its own method |
39
-
|[@tezos-ts/michelson-encoder](packages/tezos-ts-michelson-encoder)| Encode/Decode storage and parameters to/from michelson format |
40
-
|[@tezos-ts/indexer](packages/tezos-ts-indexer)| A client for the [tezos-indexer-api][0] API |
41
-
|[@tezos-ts/streamer](packages/tezos-ts-streamer)| A client for the [tezos-ts-streamer][1] API |
42
-
|[@tezos-ts/signer](packages/tezos-ts-signer)| Provide necessary function to sign using tezos keys |
43
-
|[@tezos-ts/utils](packages/tezos-ts-utils)| Provide different encoding and decoding utilities |
36
+
|[@taquito/taquito](packages/taquito)| Regroup every other library and provide higher level utility |
37
+
|[@taquito/react-components](packages/taquito-react-components)| React components that implement some common use cases |
38
+
|[@taquito/rpc](packages/taquito-rpc)| RPC client library, wrap every rpc endpoint in its own method |
39
+
|[@taquito/michelson-encoder](packages/taquito-michelson-encoder)| Encode/Decode storage and parameters to/from michelson format |
40
+
|[@taquito/indexer](packages/taquito-indexer)| A client for the [tezos-indexer-api][0] API |
41
+
|[@taquito/streamer](packages/taquito-streamer)| A client for the [taquito-streamer][1] API |
42
+
|[@taquito/signer](packages/taquito-signer)| Provide necessary function to sign using tezos keys |
43
+
|[@taquito/utils](packages/taquito-utils)| Provide different encoding and decoding utilities |
44
44
45
45
## API Documentation
46
46
47
-
The TypeDoc style API documentation is available [here](https://tezos-ts.io/typedoc)
47
+
The TypeDoc style API documentation is available [here](https://taquito.tez.ie/typedoc)
48
48
49
49
### React Components overview
50
50
51
51
React component demos are published using the [storybook](https://storybook.js.org) tool.
52
52
53
-
View the demo components here: [Tezos components Storybook](https://tezos-ts.io/react-storybook)
53
+
View the demo components here: [Tezos components Storybook](https://taquito.tez.ie/react-storybook)
54
54
55
55
## Versioning Strategy
56
56
57
57
Version releases use "Semantic Versioning" style version numbers, but deviates from SemVer norms when it comes to the "Major" number.
58
58
59
-
We use SemVer style versions for tezos-ts, but we make the "Major" version number track against the latest Tezos economical protocol we have tested on.
59
+
We use SemVer style versions for taquito, but we make the "Major" version number track against the latest Tezos economical protocol we have tested on.
60
60
61
-
For example, in August 2019, the economic protocol was `004-Pt24m4xi`, and `005-PsBABY5H` was (is) working its way through the on-chain amendment process. Therefore the current version number for tezos-ts would be `v4.0.0`. During this time, we would start working on `v5.0.0-beta.1` on the expectation (but not the assumption) that it shall become our new economic protocol.
61
+
For example, in August 2019, the economic protocol was `004-Pt24m4xi`, and `005-PsBABY5H` was (is) working its way through the on-chain amendment process. Therefore the current version number for taquito would be `v4.0.0`. During this time, we would start working on `v5.0.0-beta.1` on the expectation (but not the assumption) that it shall become our new economic protocol.
62
62
63
63
When we are confident that the next protocol proposal going to be promoted, AND we have implemented and tested interoperability with the new protocol (and potentially node RPC changes) we shall them release `v5.0.0` BEFORE the chain transitions to the new protocol.
64
64
65
-
It is essential that the packages supporting the new protocol be released before the chain transitions to the new economic protocol so that developers who build on top of tezos-ts have time to update and test their projects.
65
+
It is essential that the packages supporting the new protocol be released before the chain transitions to the new economic protocol so that developers who build on top of taquito have time to update and test their projects.
66
66
67
-
During "Major" version updates, breaking changes in the tezos-ts public APIs MAY include breaking changes, for which we will make a strong effort to announce and document in our release notes. The Minor and Patch version numbers follow SemVer norms.
67
+
During "Major" version updates, breaking changes in the taquito public APIs MAY include breaking changes, for which we will make a strong effort to announce and document in our release notes. The Minor and Patch version numbers follow SemVer norms.
68
68
69
69
All releases are backward compatible with chain data back to the genesis block. Support for older Tezos node RPCs is maintained where feasible but will be dropped eventually. Tezos node RPC support also depends on what versioning strategy gets adopted by the canonical Tezos node. At the time of writing, this is unclear.
70
70
71
-
Supported versions of the tezos-ts packages will be maintained for the current and next protocol versions. Teams using older versions are encouraged to update, but if blockers exist, they are encouraged to contact us.
71
+
Supported versions of the taquito packages will be maintained for the current and next protocol versions. Teams using older versions are encouraged to update, but if blockers exist, they are encouraged to contact us.
72
72
73
73
## Releases
74
74
@@ -113,7 +113,7 @@ Reports may be encrypted using keys published on keybase.io using [keybase/jevon
113
113
114
114
### Other Issues & Feature Requests
115
115
116
-
Please use the [GitHub issue tracker](https://github.com/ecadlabs/tezos-ts/issues) to report bugs or request features.
116
+
Please use the [GitHub issue tracker](https://github.com/ecadlabs/taquito/issues) to report bugs or request features.
0 commit comments