Skip to content

Commit

Permalink
Merge branch 'master' into nakul/add_apis
Browse files Browse the repository at this point in the history
  • Loading branch information
nakul1010 authored Nov 7, 2023
2 parents 39064d2 + d7d42a5 commit 7e72722
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 1,981 deletions.
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": [
"../sdk/src/**/*"
], // Adjust the path as needed
"exclude": [
"../sdk/src/index.ts"
]
}
Loading

0 comments on commit 7e72722

Please sign in to comment.