Skip to content

Commit

Permalink
Merge branch 'master' into inscription-recursive-endpoint
Browse files Browse the repository at this point in the history
* master:
  Dump and restore wallet from descriptors (ordinals#3048)
  Forbid destinations in same-sat mode (ordinals#3038)
  Enable JSON API by default (ordinals#3047)
  Exclude unnecessary docs (ordinals#3043)
  Add documentation for reinscriptions (ordinals#2963)
  Better wallet error messages (ordinals#3041)
  Remove uneccessary allocations in Inscription Script Creation (ordinals#3039)
  Test fee-spent inscription numbering (ordinals#3032)
  Break deploy recipes into multiple lines (ordinals#3026)
  Make wallet communicate with index via RPC (ordinals#2929)
  Use untyped table API to get table info (ordinals#2747)
  • Loading branch information
lifofifoX committed Jan 27, 2024
2 parents 00651ae + 13c0fa1 commit dd10796
Show file tree
Hide file tree
Showing 73 changed files with 3,221 additions and 2,717 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@ mime_guess = "2.0.4"
miniscript = "10.0.0"
mp4 = "0.14.0"
ord-bitcoincore-rpc = "0.17.1"
redb = "1.4.0"
redb = "1.5.0"
regex = "1.6.0"
reqwest = { version = "0.11.23", features = ["blocking", "json"] }
rss = "2.0.1"
rust-embed = "8.0.0"
rustls = "0.22.0"
Expand Down
3 changes: 2 additions & 1 deletion deploy/ord.service
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ ExecStart=/usr/local/bin/ord \
--acme-contact mailto:[email protected] \
--csp-origin https://${CSP_ORIGIN} \
--http \
--https
--https \
--disable-json-api
Group=ord
LimitNOFILE=65536
MemoryDenyWriteExecute=true
Expand Down
12 changes: 4 additions & 8 deletions docs/src/guides/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,10 @@ To specify a port add the `--http-port` flag:

`ord server --http-port 8080`

To enable the JSON-API endpoints add the `--enable-json-api` or `-j` flag (see
[here](#json-api) for more info):
The JSON-API endpoints are enabled by default, to disable them add the
`--disable-json-api` flag (see [here](#json-api) for more info):

`ord server --enable-json-api`

To test how your inscriptions will look you can run:

`ord preview <FILE1> <FILE2> ...`
`ord server --disable-json-api`

Search
------
Expand Down Expand Up @@ -76,7 +72,7 @@ been issued when they are mined:
JSON-API
--------

You can run `ord server` with the `--enable-json-api` flag to access endpoints that
By default the `ord server` gives access to endpoints that
return JSON instead of HTML if you set the HTTP `Accept: application/json`
header. The structure of these objects closely follows
what is shown in the HTML. These endpoints are:
Expand Down
29 changes: 29 additions & 0 deletions docs/src/inscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,22 @@ go through the inputs consecutively and look for all inscription `envelopes`.
| 3 | 0 | |
| 4 | 1 | i6 |

Inscription Numbers
-------------------

Inscriptions are assigned inscription numbers starting at zero, first by the
order reveal transactions appear in blocks, and the order that reveal envelopes
appear in those transactions.

Due to a historical bug in `ord` which cannot be fixed without changing a great
many inscription numbers, inscriptions which are revealed and then immediately
spent to fees are numbered as if they appear last in the block in which they
are revealed.

Inscriptions which are cursed are numbered starting at negative one, counting
down. Cursed inscriptions on and after the jubilee at block 824544 are
vindicated, and are assigned positive inscription numbers.

Sandboxing
----------

Expand All @@ -133,3 +149,16 @@ off-chain content, thus keeping inscriptions immutable and self-contained.
This is accomplished by loading HTML and SVG inscriptions inside `iframes` with
the `sandbox` attribute, as well as serving inscription content with
`Content-Security-Policy` headers.

Reinscriptions
--------------

Previously inscribed sats can be reinscribed with the `--reinscribe` command if
the inscription is present in the wallet. This will only append an inscription to
a sat, not change the initial inscription.

Reinscribe with satpoint:
`ord wallet inscribe --fee-rate <FEE_RATE> --reinscribe --file <FILE> --satpoint <SATPOINT>`

Reinscribe on a sat (requires sat index):
`ord --index-sats wallet inscribe --fee-rate <FEE_RATE> --reinscribe --file <FILE> --sat <SAT>`
27 changes: 16 additions & 11 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,23 @@ deploy branch remote chain domain:
rsync -avz deploy/checkout root@{{domain}}:deploy/checkout
ssh root@{{domain}} 'cd deploy && ./checkout {{branch}} {{remote}} {{chain}} {{domain}}'

deploy-mainnet-alpha branch='master' remote='ordinals/ord': (deploy branch remote 'main' 'alpha.ordinals.net')
deploy-mainnet-alpha branch='master' remote='ordinals/ord': \
(deploy branch remote 'main' 'alpha.ordinals.net')

deploy-mainnet-bravo branch='master' remote='ordinals/ord': (deploy branch remote 'main' 'bravo.ordinals.net')
deploy-mainnet-bravo branch='master' remote='ordinals/ord': \
(deploy branch remote 'main' 'bravo.ordinals.net')

deploy-mainnet-charlie branch='master' remote='ordinals/ord': (deploy branch remote 'main' 'charlie.ordinals.net')
deploy-mainnet-charlie branch='master' remote='ordinals/ord': \
(deploy branch remote 'main' 'charlie.ordinals.net')

deploy-regtest branch='master' remote='ordinals/ord': (deploy branch remote 'regtest' 'regtest.ordinals.net')
deploy-regtest branch='master' remote='ordinals/ord': \
(deploy branch remote 'regtest' 'regtest.ordinals.net')

deploy-signet branch='master' remote='ordinals/ord': (deploy branch remote 'signet' 'signet.ordinals.net')
deploy-signet branch='master' remote='ordinals/ord': \
(deploy branch remote 'signet' 'signet.ordinals.net')

deploy-testnet branch='master' remote='ordinals/ord': (deploy branch remote 'test' 'testnet.ordinals.net')
deploy-testnet branch='master' remote='ordinals/ord': \
(deploy branch remote 'test' 'testnet.ordinals.net')

deploy-all: \
deploy-regtest \
Expand Down Expand Up @@ -91,7 +97,7 @@ open:
open http://localhost

doc:
cargo doc --all --open
cargo doc --workspace --exclude audit-content-security-policy --exclude audit-cache --open

prepare-release revision='master':
#!/usr/bin/env bash
Expand Down Expand Up @@ -171,14 +177,13 @@ update-changelog:
echo >> CHANGELOG.md
git log --pretty='format:- %s' >> CHANGELOG.md

preview-examples:
cargo run preview examples/*

convert-logo-to-favicon:
convert -background none -resize 256x256 logo.svg static/favicon.png

update-mdbook-theme:
curl https://raw.githubusercontent.com/rust-lang/mdBook/v0.4.35/src/theme/index.hbs > docs/theme/index.hbs
curl \
https://raw.githubusercontent.com/rust-lang/mdBook/v0.4.35/src/theme/index.hbs \
> docs/theme/index.hbs

audit-cache:
cargo run --package audit-cache
Expand Down
Loading

0 comments on commit dd10796

Please sign in to comment.