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

docs: add note on using the sdk to inscribe ordinals #79

Merged
merged 5 commits into from
Nov 7, 2023
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
5 changes: 4 additions & 1 deletion docs/docs/build/how-to/ordinals.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ Inscriptions are created using taproot script. That means you have to use a P2TR
- [Unisat](https://unisat.io/download ) (Browser)

### Inscribing data
There are several ways to create inscriptions, the following two are advised:
If you're developing an app with Javascript or Typescript you can use the BOB SDK to create the commit and reveal transactions required to inscribe data to an ordinal. Refer to the `inscribeText` function and provide a custom `RemoteSigner` implementation for your wallet. The test in [`sdk/test/ordinals.test.ts`](https://github.com/bob-collective/bob/blob/master/sdk/test/ordinals.test.ts) provides an example implementation using [`bitcoinjs-lib`](https://github.com/bitcoinjs/bitcoinjs-lib) and [`tiny-secp256k1`](https://github.com/bitcoinjs/tiny-secp256k1).

#### Using an external service
There are other ways to create inscriptions, the following two are advised:
- [Inscribe the Planet](https://inscribetheplanet.com/) __[RECOMMENDED]__ service which is free to use and supports file upload, direct BRC-20 deployments and minting.
- [Default way using the `ord` client](https://docs.ordinals.com/guides/inscriptions.html) (Requires full Bitcoin node and network reindexing)

Expand Down
4 changes: 3 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"install:sdk": "cd ../sdk && yarn install",
"start": "docusaurus start",
"build": "docusaurus build",
"build:docs": "docusaurus build",
"build": "yarn install:sdk && yarn build:docs",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
Expand Down
10 changes: 7 additions & 3 deletions docs/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
"compilerOptions": {
"baseUrl": "."
},
"include": ["../sdk/src/*"], // Adjust the path as needed
"exclude": ["../sdk/src/index.ts"]
}
"include": [
tomjeatt marked this conversation as resolved.
Show resolved Hide resolved
"../sdk/src/**/*"
], // Adjust the path as needed
"exclude": [
"../sdk/src/index.ts"
]
}
Loading