diff --git a/docs/sdk/architecture.md b/docs/sdk/architecture.md index 6bf0a81..de6cf76 100644 --- a/docs/sdk/architecture.md +++ b/docs/sdk/architecture.md @@ -57,16 +57,16 @@ TBD | Error type | Additional information | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| -| [Bad payload](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/bad-payload.ts) | TBD | -| [Bad signature](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/bad-signature.ts) | TBD | -| [Build extrinsic](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/build-extrinsic.ts) | TBD | -| [Build query](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/build-query.ts) | TBD | -| [Codes](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/codes.ts) | TBD | -| [Connection failed](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/connection-failed.ts) | TBD | -| [Errors](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/errors.ts) | TBD | -| [Invalid signer](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/invalid-signer.ts) | TBD | -| [Not found](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/not-found.ts) | TBD | -| [Public api](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/public-api.ts) | TBD | -| [Submit extrinsic](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/submit-extrinsic.ts) | TBD | -| [Validation](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/validation.ts) | TBD | -| [Verification failed](https://github.com/UniqueNetwork/unique-sdk/blob/0cbdab33512e6e712d3e2c5cbcd54807ec6354a1/packages/substrate-client/errors/src/verification-failed.ts) | TBD | +| Bad payload | TBD | +| Bad signature | TBD | +| Build extrinsic | TBD | +| Build query | TBD | +| Codes | TBD | +| Connection failed | TBD | +| Errors | TBD | +| Invalid signer | TBD | +| Not found | TBD | +| Public api | TBD | +| Submit extrinsic | TBD | +| Validation | TBD | +| Verification failed | TBD | diff --git a/docs/sdk/index.md b/docs/sdk/index.md index 9cc4bfb..dc7baca 100644 --- a/docs/sdk/index.md +++ b/docs/sdk/index.md @@ -13,8 +13,6 @@ Depending on the project characteristics and the development team capabilities, Our SDK allows integrating all Unique Network features into your web3 application without interacting with low-level API. Using SDK, you can mint collections and tokens, manage account balance, etc. Technically, it is a REST add-on that allows you to use the same methods in a simplified form. -You can learn SDK deeply by reviewing its [repository](https://github.com/UniqueNetwork/unique-sdk/blob/master/packages/sdk/). - ### Substrate REST You can use a proxy HTTP service (Substrate REST) to implement server logic. @@ -28,8 +26,6 @@ In general, this package is pretty close to SDK, but it provides you with more f With Substrate REST, you can use public or self-hosted endpoints, which provides some flexibility in project and security settings. -You can learn SDK deeply by reviewing its [repository](https://github.com/UniqueNetwork/unique-sdk/blob/master/packages/rest/). - ### Substrate Client Substrate Client is a JavaScript/TypeScript library that helps to interact with Unique Network directly. This approach is recommended only for experienced developers which have already worked with blockchains. This is the most low-level package that we provide. @@ -41,8 +37,6 @@ However, Substrate Client can also be used with any network based on the [Substr Substrate Client is a low-lower connection tool that is easier than the WSS connection, but it requires more development and infrastructure support than SDK or Substrate REST. -You can review the Substrate Client deeper in its [repository](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/substrate-client). - ## How to install ### SDK @@ -129,7 +123,7 @@ const sdk = new Sdk(clientOptions); ### Substrate REST #### Installation -Choose install approach: [Docker](#docker), [Source code](#git) or [Public endpoints](#public-endpoints). +Choose install approach: [Docker](#docker) or [Public endpoints](#public-endpoints). ##### Docker @@ -139,34 +133,6 @@ docker run -p 3000:3000 -e CHAIN_WS_URL=wss://ws-opal.unique.network uniquenetwo See the [hub.docker.com](https://hub.docker.com/r/uniquenetwork/web) page for more details. -#### Git - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -npm install -npm run build:web -npm start -``` - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -yarn -yarn run build:web -yarn start -``` - - - - - #### Public endpoints You can use public endpoints for access Unique Web: @@ -283,31 +249,6 @@ yarn add @unique-nft/substrate-client -**via Git:** - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -npm install -npm run build:substrate-client -``` - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -yarn -yarn build:substrate-client -``` - - - - #### Initialization ```typescript:no-line-numbers diff --git a/docs/sdk/installation.md b/docs/sdk/installation.md index 8c320fd..6d4bdc8 100644 --- a/docs/sdk/installation.md +++ b/docs/sdk/installation.md @@ -86,7 +86,7 @@ const sdk = new Sdk(clientOptions); ## Substrate REST ### Installation -Choose install approach: [Docker](#docker), [Source code](#git) or [Public endpoints](#public-endpoints). +Choose install approach: [Docker](#docker) or [Public endpoints](#public-endpoints). #### Docker @@ -96,34 +96,6 @@ docker run -p 3000:3000 -e CHAIN_WS_URL=wss://ws-opal.unique.network uniquenetwo See the [hub.docker.com](https://hub.docker.com/r/uniquenetwork/web) page for more details. -#### Git - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -npm install -npm run build:web -npm start -``` - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -yarn -yarn run build:web -yarn start -``` - - - - - #### Public endpoints You can use public endpoints for access Unique Web: @@ -240,31 +212,6 @@ yarn add @unique-nft/substrate-client -**via Git:** - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -npm install -npm run build:substrate-client -``` - - - - -```bash:no-line-numbers -git clone https://github.com/UniqueNetwork/unique-sdk -cd unique-sdk -yarn -yarn build:substrate-client -``` - - - - ### Initialization ```typescript:no-line-numbers diff --git a/docs/sdk/tools.md b/docs/sdk/tools.md index 7b8d9c3..8fa83b0 100644 --- a/docs/sdk/tools.md +++ b/docs/sdk/tools.md @@ -40,10 +40,10 @@ const signer = provider.addSeed(''); The following providers are supported: -* [Keyring](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/accounts/keyring) -* [KeyringLocal](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/accounts/keyring-local) -* [Polkadot extension](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/accounts/polkadot) -* [Metamask extension](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/accounts/metamask) +* Keyring +* KeyringLocal +* Polkadot extension +* Metamask extension #### Generate new account diff --git a/docs/tutorials/how-to-collections.md b/docs/tutorials/how-to-collections.md index c21d22b..0d9da7e 100644 --- a/docs/tutorials/how-to-collections.md +++ b/docs/tutorials/how-to-collections.md @@ -365,9 +365,6 @@ curl -X 'POST' \ - -The full list of the `sdk.collections` module you can check right [in the sources](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/substrate-client/tokens/methods/collection) of the `@unique/substrate-client` package. - ### Change the owner of the collection Each collection has an owner. It is defined when collection is created. However, it is possible to set a new collection owner if needed. However, you can do this **only on behalf of the collection owner** . Please check the samples below to learn how to do this. diff --git a/docs/tutorials/nfts-how-to-create-and-tune-collection.md b/docs/tutorials/nfts-how-to-create-and-tune-collection.md index 5c3c326..3646200 100644 --- a/docs/tutorials/nfts-how-to-create-and-tune-collection.md +++ b/docs/tutorials/nfts-how-to-create-and-tune-collection.md @@ -137,5 +137,3 @@ const { parsed: { collectionId, limits }, } = result; ``` - -The full list of the `sdk.collections` module you can check right [in the sources](https://github.com/UniqueNetwork/unique-sdk/tree/master/packages/substrate-client/tokens/methods/collection) of `@unique/substrate-client` package.