forked from rarible/protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/feature/main-page-redesign'
# Conflicts: # docs/index.md # docs/overview/resources.md # mkdocs.yml
- Loading branch information
Showing
14 changed files
with
152 additions
and
107 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Community and resources | ||
|
|
||
| ## DAO | ||
|
|
||
| If you're a builder or you're looking to participate in the Rarible Protocol DAO, here are a few valuable places you'll find support and like-minded builders. | ||
|
|
||
| * [Discord](https://discord.gg/zqsZsEWBbN) is one of the main places where the DAO is being organized, and builders take their first steps towards building with the protocol. | ||
| * [Github](https://github.com/rarible) is where everything lives. Since we are open-source, many resources and help from other builders are available there. | ||
| * [Notion](https://rarible-protocol.notion.site/rarible-protocol/Rarible-Protocol-DAO-f89d6db21a9d4c199eb30051fceb9a0a) is the platform where we hold information for DAO members and $RARI token holders. | ||
| * [OpenAPI](https://api.rarible.org/v0.1/doc) is where we document the current API capabilities. | ||
| * [DAO Twitter](https://twitter.com/raribledao) | ||
|
|
||
| ## Resources | ||
|
|
||
| * [Rarible Youtube](https://www.youtube.com/c/Rarible) | ||
| * [Rarible Twitter](https://twitter.com/rarible) | ||
| * [Rarible Hackathon Docs HackMD by Isaac](https://hackmd.io/ktJuljjGTA2TivezBXKA5g?view#Rarible-Hackathon-Docs) for Ethereum network. | ||
|
|
||
| ## Submitting | ||
|
|
||
| You are welcome to suggest features and report bugs found! You can do it here: | ||
|
|
||
| * [Submit an issue](https://github.com/rarible/protocol/issues) | ||
| * [Submit a question or suggestion](https://github.com/rarible/protocol/discussions) | ||
|
|
||
| ## Audits | ||
|
|
||
| Rarible Protocol is audited. Check this report by [ChainSecurity.com](https://chainsecurity.com/security-audit/rarible-exchange-v2-smart-contracts/). | ||
|
|
||
| ## License | ||
|
|
||
| Rarible Protocol is available under [GPL v3](../LICENSE.md). | ||
|
|
||
| SDK and OpenAPI (with generated clients) are available under [MIT](../MIT-LICENSE.md). |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,37 @@ | ||
| # Rarible Protocol Overview | ||
| --- | ||
| hide: | ||
| - toc | ||
| - feedback | ||
| --- | ||
|
|
||
| Rarible Protocol is a tool to query, issue and trade NFTs on these blockchains: | ||
| # Rarible Protocol | ||
|
|
||
| - [Ethereum](./ethereum/ethereum-overview.md) | ||
| - [Flow](./flow/flow-overview.md) (WIP) | ||
| - [Tezos](./tezos/tezos-overview.md) | ||
| - Polygon (WIP, coming soon) | ||
| - Other blockchains ([tell us](https://github.com/rarible/protocol/discussions) what blockchain you want) | ||
|
|
||
| ## Getting Started | ||
| Rarible Union Protocol is a blockchain-agnostic and decentralized tool to query, issue, and trade NFTs. | ||
|
|
||
| * [Quick Start](getting-started/quick-start.md) for starting using Union SDK | ||
| * [Union SDK](overview/union-sdk.md) docs and [Rarible Protocol SDK](https://github.com/rarible/sdk) repo on GitHub | ||
| * [Union API](overview/api-reference.md) reference | ||
| Learn more about Protocol usage. | ||
|
|
||
| See [Example App](getting-started/protocol-example.md) for more app examples. | ||
| [Protocol Overview](overview/union.md){ .md-button .md-button--primary } | ||
|
|
||
| ## Protocol Features | ||
| *** | ||
|
|
||
| - [query](https://github.com/rarible/sdk#querying) information about NFTs | ||
| - [mint](https://github.com/rarible/sdk#mint) (issue, create) NFTs | ||
| - trade NFTs ([sell](https://github.com/rarible/sdk#sell), [bid](https://github.com/rarible/sdk#bid), [auction](https://github.com/rarible/sdk#auction)) | ||
| - [transfer](https://github.com/rarible/sdk#transfer) | ||
| - [burn](https://github.com/rarible/sdk#burn) | ||
| Explore references & resources. | ||
|
|
||
| ## Architecture | ||
| [API Reference](api-reference.md){ .md-button } | ||
|
|
||
| The architecture of the Protocol: | ||
| [Union SDK](union-sdk.md){ .md-button } | ||
|
|
||
|  | ||
| *** | ||
|
|
||
| Protocol is based on the blockchain layer (smart contracts written for every blockchain supported). These smart contracts allow users to mint and exchange tokens. | ||
| Get started with Union SDK basics. | ||
|
|
||
| On top of the contracts we built indexers to index part of the blockchain state. This gives us the possibility to query data about NFTs. | ||
| [Quick Start](#){ .md-button } | ||
|
|
||
| Then, SDKs were written to interact with smart contracts. | ||
| See the example repo to create the first application. | ||
|
|
||
| All these components are written for every blockchain supported and are used in [Union service](https://github.com/rarible/union-service) and [Union SDK](https://github.com/rarible/sdk) | ||
| [React Example App](https://github.com/rarible/example){ .md-button } | ||
|
|
||
| Applications need to integrate [Union service](https://github.com/rarible/union-service) and [Union SDK](https://github.com/rarible/sdk) to be able to interact with all blockchains in the same way. | ||
| *** | ||
|
|
||
| ## Suggestions | ||
| Take community support and additional information. | ||
|
|
||
| You are welcome to [suggest features](https://github.com/rarible/protocol/discussions) and [report bugs found](https://github.com/rarible/protocol/issues)! | ||
|
|
||
| ## Audits | ||
|
|
||
| Rarible Protocol is audited. Check this report by [ChainSecurity.com](https://chainsecurity.com/security-audit/rarible-exchange-v2-smart-contracts/). | ||
|
|
||
| ## License | ||
|
|
||
| Rarible Protocol is available under [GPL v3](LICENSE). | ||
|
|
||
| SDK and openapi (with generated clients) are available under [MIT](MIT-LICENSE). | ||
| [Community and resources](getting-started/community.md){ .md-button } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Rarible Union Protocol | ||
|
|
||
| The Rarible Union Protocol is based on the blockchain layer (smart contracts written for every blockchain supported). These smart contracts allow users to mint and exchange tokens. | ||
|
|
||
| On top of the contracts, we built indexers to index part of the blockchain state. This gives us the possibility to query data about NFTs. | ||
|
|
||
| Then, SDKs were written to interact with smart contracts. | ||
|
|
||
| All these components are written for every blockchain supported and are used in [Union service](https://github.com/rarible/union-service) and [Union SDK](https://github.com/rarible/sdk). | ||
|
|
||
| Applications need to integrate Union service and Union SDK to be able to interact with all blockchains in the same way. | ||
|
|
||
| <figure markdown> | ||
| { width="600" } | ||
| <figcaption>Protocol architecture</figcaption> | ||
| </figure> | ||
|
|
||
| ## Features | ||
|
|
||
| * [Mint](https://github.com/rarible/sdk#mint) (issue, create) NFTs | ||
| * Trade NFTs ([sell](https://github.com/rarible/sdk#sell), [bid](https://github.com/rarible/sdk#bid), [auction](https://github.com/rarible/sdk#auction)) | ||
| * [Transfer](https://github.com/rarible/sdk#transfer) | ||
| * [Burn](https://github.com/rarible/sdk#burn) | ||
| * [Query](https://github.com/rarible/sdk#querying) information about NFTs | ||
|
|
||
| See [more reasons](../getting-started/reasons.md) to build on Rarible Protocol. | ||
|
|
||
| ## API Reference | ||
|
|
||
| We use different environments for blockchain networks. See actual information on [API Reference](../api-reference.md) page. | ||
|
|
||
| ## SDK | ||
|
|
||
| [Rarible Protocol SDK](https://github.com/rarible/sdk) enables applications to easily interact with Rarible protocol: [query](https://github.com/rarible/sdk#querying), [issue](https://github.com/rarible/sdk#mint), [trade](https://github.com/rarible/sdk#sell) NFTs on any blockchain supported. | ||
|
|
||
| See more information on [Union SDK](../union-sdk.md) page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Picnic | ||
|
|
||
| We use Rarible to help us identify NFTs from creators and collectors in the [Picnic] showcase. The [Rarible API] provides a few great endpoints for fetching the necessary data. | ||
| We use Rarible to help us identify NFTs from creators and collectors in the Picnic showcase. The Rarible API provides a few great endpoints for fetching the necessary data. | ||
|
|
||
| ## API Calls | ||
|
|
||
|
|
@@ -14,6 +14,7 @@ The following endpoints can be used: | |
|
|
||
| Paginate through owned tokens | ||
|
|
||
| ```ts | ||
| import axios from 'axios'; | ||
|
|
||
| /** | ||
|
|
@@ -46,11 +47,13 @@ const fetchOwnedTokens = async (owner, opts = {}) => { | |
| return []; | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| The `byOwner` endpoint does not return token metadata. You can attempt to query this information from the blockchain directly or use another API to collect token metadata information. | ||
|
|
||
| You can use the `getItemMetaById` Rarible API endpoint to get token metadata. Be mindful that you’ll have to make one request per token. | ||
|
|
||
| ```ts | ||
| import axios from 'axios'; | ||
|
|
||
| /** | ||
|
|
@@ -65,5 +68,6 @@ const fetchTokenMetadata = async id => { | |
| } | ||
| return data; | ||
| }; | ||
| ``` | ||
|
|
||
| If you have question, please reach out. [email protected] / [@gleuch] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters