Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Tools to docs #232

Merged
merged 7 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/build/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ We love to work closely with you to make BOB useful to your use-case and ideas.

- [Wallets](/docs/build/tools/wallets): Learn how to use wallets on BOB.
- [APIs](/docs/build/tools/api): Learn how to use APIs on BOB.
- [Rust zkVM](/docs/build/tools/bonsai): Learn how to write Rust off-chain code that can be verified on-chain on BOB.
- [Rust zkVM](/docs/build/tools/rust-zkvm): Learn how to write Rust off-chain code that can be verified on-chain on BOB.
- [Oracles](/docs/build/tools/oracles): Learn how to use oracles on BOB.

## Contracts
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/build/getting-started/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Get started: https://docs.unisat.io/dev/unisat-developer-service

- [Wallets](/docs/build/tools/wallets)
- [APIs](/docs/build/tools/api)
- [Rust zkVM](/docs/build/tools/bonsai)
- [Rust zkVM](/docs/build/tools/rust-zkvm)
- [Oracles](/docs/build/tools/oracles)

### Collection of Bitcoin Tools
Expand Down
13 changes: 13 additions & 0 deletions docs/docs/build/tools/account-abstraction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Account Abstraction

## Safe Wallet

[Safe Wallet](https://safe.gobob.xyz/welcome) (formerly known as Gnosis Safe multisig) is a smart contract wallet. Featuring 130+ ecosystem apps and the ability to create your own modules and guard, Safe is the most trusted decentralized custody protocol and collective asset management platform.

## Pimlico

[Pimlico](https://pimlico.io/) provides an infrastructure platform that makes building ERC-4337 smart accounts simpler. They provide bundlers, verifying paymasters, ERC-20 paymasters, and more tools.

## BTC Connect

Made by [Particle Network](https://particle.network/), BTC Connect enables users to control ERC-4337 smart accounts (i.e. smart contract wallets) on EVM-chains with their native Bitcoin wallets (e.g. UniSat). Interactions with products deployed on BOB can be conducted via Bitcoin wallet signatures using their pre-built modal. Learn more in their [docs](https://docs.particle.network/developers/btc-connect) or in their [docs](https://docs.particle.network/developers/btc-connect).
6 changes: 1 addition & 5 deletions docs/docs/build/tools/api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
sidebar_position: 2
---

# APIs

## Ordinals
Expand All @@ -10,4 +6,4 @@ sidebar_position: 2

UniSat Open-API is open to community developers, allowing you to explore the world of Bitcoin and ordinals.

Getting an API key: [Contact the team](https://docs.unisat.io/dev/unisat-developer-service#getting-an-api-key).
Getting an API key: [Contact the team](https://docs.unisat.io/dev/unisat-developer-service#getting-an-api-key).
7 changes: 0 additions & 7 deletions docs/docs/build/tools/bonsai.md

This file was deleted.

14 changes: 14 additions & 0 deletions docs/docs/build/tools/data-indexers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Data Indexers

## Goldsky

[Goldsky](https://goldsky.com/) is a data indexer for web3 builders, offering high-performance subgraph hosting and realtime data replication pipelines.

Their [subgraphs](https://goldsky.com/products/subgraphs) are fully spec-compliant with every subgraph on The Graph’s hosted and decentralized networks. Smart APIs automatically create a subgraph from any smart contract ABI, so you don’t have to.

[Mirror](https://goldsky.com/products/mirror) streams live crypto data to your backend database, giving you more control & flexibility than traditional APIs.

**Supported Networks**

- BOB Mainnet
- BOB Sepolia (Testnet)
7 changes: 7 additions & 0 deletions docs/docs/build/tools/nfts-ordinals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# NFTs & Ordinals

## Emblem Vault

[Emblem Vault](https://twitter.com/EmblemVault) is an [interoperability](https://docs.emblem.wiki/) protocol that allows for the trading, transferring, and transacting of digital assets across blockchains. Vaulting is a propriety [crosschain](https://emblem.finance/createcurated) mechanism that is similar to bridging and wrapped assets but offers extended compatibility with any type of distributed ledger technology. Since 2020 Emblem Vault has been the leading multichain solutions for NFTs with over $100M in total value vaulted and $200M in trading activity.

<!-- TODO: Add Emblem addresses for test/mainnet -->
33 changes: 30 additions & 3 deletions docs/docs/build/tools/oracles.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,34 @@

Acurast provides [Chainlink-compatible Price Feeds](https://docs.acurast.com/integrations/evm/#chainlink-compatible-price-feeds) on BOB. See their guide on how to integrate with Acurast and the deployed price feeds.

### Supported Networks
## API3

- BOB Devnet
- BOB Testnet (coming soon)
[API3](https://api3.org/) is building secure first-party oracles for BOB.

Once API3 is live on BOB, they will offer:

- [dAPIs](https://docs.api3.org/guides/dapis/subscribing-managed-dapis/): First-party aggregated data feeds sourced directly from the data providers.
- [Airnode](https://docs.api3.org/guides/airnode/calling-an-airnode/): The first-party serverless Oracle solution to bring any REST API onchain.
- [QRNG](https://docs.api3.org/guides/qrng/): Quantum Random Number Generator for verifiable quantum RNG onchain.

<!-- TODO: Add addresses after API3 deploys -->

## RedStone

[RedStone](https://redstone.finance/) provides 800+ [price feeds](https://app.redstone.finance/) for BOB.

See [this guide](https://docs.redstone.finance/) to learn how to use RedStone price feeds.

<!-- TODO: Add RedStone addresses -->

## DIA

[DIA](https://www.diadata.org/) provides 3,000+ [price feeds](https://www.diadata.org/app/price/) for BOB.

See [this guide](https://docs.diadata.org/introduction/intro-to-dia-oracles/access-the-oracle) to learn how to use DIA price feeds.

**Supported Networks**

<!-- TODO: Verify DIA on test/mainnet -->

- BOB Mainnet: 0x4d24e7c1cf0ed63bc8c6cb5a795af31fd8127c6b
12 changes: 12 additions & 0 deletions docs/docs/build/tools/rust-zkvm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Rust zkVM

## RISC Zero

The [RISC Zero zero-knowledge virtual machine](https://dev.risczero.com/api/zkvm/) (zkVM) lets you prove correct execution of arbitrary Rust code in your Ethereum contract. [For example](https://dev.risczero.com/api/blockchain-integration/bonsai-on-eth), any smart contract can call the RISC Zero Verifier contract to trustlessly verify that the zk proof of the off-chain computation is valid. While you can generate proofs on your own hardware, you can also use their [Bonsai API and SDK](https://dev.risczero.com/api/generating-proofs/remote-proving) to generate them.

**Supported Networks**

<!-- TODO: Verify RISC Zero on test/mainnet -->

- BOB Mainnet
- BOB Sepolia (Testnet)
20 changes: 14 additions & 6 deletions docs/docs/build/tools/wallets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
sidebar_position: 1
---

# Wallets

## Bitcoin and BOB
Expand Down Expand Up @@ -33,9 +29,21 @@ MetaMask is a browser extension that allows you to interact with EVM-compatible
### [OKX Wallet](https://www.okx.com/web3)

- Type: Browser, Android, iOS, Desktop
- Features: Bitcoin, Ordinals, EVM
- Features: Bitcoin, Ordinals, BRC20, EVM
- Networks: Any EVM network, Bitcoin Mainnet

### [FoxWallet](https://foxwallet.com/)

- Type: Android, iOS
- Features: Bitcoin, Ordinals, BRC20, EVM
- Networks: Any EVM network, Bitcoin Mainnet

### [Pontem Wallet](https://pontemwallet.xyz/)

- Type: Browser, Android, iOS,
- Features: Bitcoin, Ordinals, BRC20, EVM
- Networks: Any EVM network, Bitcoin Testnet, Mainnet

## Bitcoin

Wallets that only support Bitcoin.
Expand All @@ -44,7 +52,7 @@ Wallets that only support Bitcoin.

Open Source Chrome Extension for Bitcoin, Ordinals, and BRC20. Integration can be achieved through the [Wallet API](https://docs.unisat.io/dev/unisat-wallet-api).

- Type: Browser
- Type: Browser
- Features: Bitcoin, Ordinals, BRC20
- Networks: Bitcoin Testnet, Mainnet

Expand Down
Loading