search

mydoge-com / doginals

CLI for minting inscriptions
MIT License
2 stars 0 forks source link

readme

Doginals

A minter and protocol for inscriptions on Dogecoin.

Setup

Install dependencies:

npm install

Create a .env file with your node information:

NOWNODES_API_KEY=<your api key>

Funding

Generate a new .wallet.json file:

node . wallet new

Then send DOGE to the address displayed. Once sent, sync your wallet:

node . wallet sync

If you are minting a lot, you can split up your UTXOs:

node . wallet split <count>

When you are done minting, send the funds back:

node . wallet send <address> <optional amount>

Minting

From file:

node . mint <address> <path>

From data:

node . mint <address> <content type> <hex data>

Examples:

node . mint DSV12KPb8m5b6YtfmqY89K6YqvdVwMYDPn dog.jpeg
node . mint DSV12KPb8m5b6YtfmqY89K6YqvdVwMYDPn "text/plain;charset=utf8" 576f6f6621

Note: Please use a fresh wallet to mint to with nothing else in it until proper wallet for doginals support comes. You can get a paper wallet here.

Viewing

Start the server:

node . server

And open your browser to:

http://localhost:3000/tx/15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62e

Protocol

The doginals protocol allows any size data to be inscribed onto subwoofers.

An inscription is defined as a series of push datas:

"ord"
OP_1
"text/plain; charset=utf8"
OP_0
"Woof!"

For doginals, we introduce a couple extensions. First, content may spread across multiple parts:

"ord"
OP_2
"text/plain; charset=utf8"
OP_1
"Woof and "
OP_0
"woof woof!"

This content here would be concatenated as "Woof and woof woof!". This allows up to ~1500 bytes of data per transaction.

Second, P2SH is used to encode inscriptions.

There are no restrictions on what P2SH scripts may do as long as the redeem scripts start with inscription push datas.

And third, inscriptions are allowed to chain across transactions:

Transaction 1:

"ord"
OP_2
"text/plain; charset=utf8"
OP_1
"Woof and "

Transaction 2

OP_0
"woof woof!"

With the restriction that each inscription part after the first must start with a number separator, and number separators must count down to 0.

This allows indexers to know how much data remains.

FAQ

I'm getting "insufficient priority" errors when minting

The miner fee is too low. You can increase it up by putting FEE_PER_KB=300000000 in your .env file or just wait it out. The default is 100000000 but spikes up when demand is high.