Mikro-Ordinalzahlen

Mikroordinalzahlen

Minimale JS-Bibliothek für Ordnungszahlen und Inschriften zusätzlich zu scure-btc-signer.

Verwenden Sie es als Bibliothek in Ihrem JS-Code oder führen Sie ein enthaltenes CLI-Tool aus. Inschriften ermöglichen das Hochladen zufälliger Dateien auf die BTC-Blockchain.

Experimentell: Kann zu Geldverlusten führen, bis es gründlich getestet wird.

Verwendung

npm installiert Mikroordinalzahlen

• Inschrift erstellen
• TypeScript-API
• CLI

Inschrift erstellen

test`) }; const revealPayment = btc.p2tr( undefined, // internalPubKey ordinals.p2tr_ord_reveal(pubKey, [inscription]), // TaprootScriptTree TESTNET, // mainnet or testnet false, // allowUnknownOutputs, safety feature customScripts // how to handle custom scripts ); // We need to send some bitcoins to this address before reveal. // Also, there should be enough to cover reveal tx fee. console.log('Address', revealPayment.address); // 'tb1p5mykwcq5ly7y2ctph9r2wfgldq94eccm2t83dd58k785p0zqzwkspyjkp5' // Be extra careful: it's possible to accidentally send an inscription as a fee. // Also, rarity is only available with ordinal wallet. // But you can parse other inscriptions and create a common one using this. const changeAddr = revealPayment.address; // can be different const revealAmount = 2000n; const fee = 500n; const tx = new btc.Transaction({ customScripts }); tx.addInput({ ...revealPayment, // This is txid of tx with bitcoins we sent (replace) txid: '75ddabb27b8845f5247975c8a5ba7c6f336c4570708ebe230caf6db5217ae858', index: 0, witnessUtxo: { script: revealPayment.script, amount: revealAmount }, }); tx.addOutputAddress(changeAddr, revealAmount - fee, TESTNET); tx.sign(privKey, undefined, new Uint8Array(32)); tx.finalize(); const txHex = hex.encode(tx.extract()); console.log(txHex); // Hex of reveal tx to broadcast const tx2 = btc.Transaction.fromRaw(hex.decode(txHex)); // Parsing inscriptions console.log('parsed', ordinals.parseWitness(tx2.inputs[0].finalScriptWitness)); console.log('vsize', tx2.vsize); // Reveal tx should pay at least this much fee">

 // npm install micro-ordinals @scure/btc-signer @scure/base
import * as btc from '@scure/btc-signer' ;
import * as ordinals from 'micro-ordinals' ;
import { hex , utf8 } from '@scure/base' ;

const TESTNET = btc . utils . TEST_NETWORK ;
const privKey = hex . decode ( '0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a' ) ;
const pubKey = btc . utils . pubSchnorr ( privKey ) ;
const customScripts = [ ordinals . OutOrdinalReveal ] ; // Enable custom scripts outside

// This inscribes on first satoshi of first input (default)
const inscription = {
  tags : {
    contentType : 'application/json' , // can be any format (MIME type)
    // ContentEncoding: 'br', // compression: only brotli supported
  } ,
  body : utf8 . decode ( JSON . stringify ( { some : 1 , test : 2 , inscription : true , in : 'json' } ) ) ,
  // One can use previously inscribed js scripts in html
  // utf8.decode(`test`)
} ;

const revealPayment = btc . p2tr (
  undefined , // internalPubKey
  ordinals . p2tr_ord_reveal ( pubKey , [ inscription ] ) , // TaprootScriptTree
  TESTNET , // mainnet or testnet
  false , // allowUnknownOutputs, safety feature
  customScripts // how to handle custom scripts
) ;

// We need to send some bitcoins to this address before reveal.
// Also, there should be enough to cover reveal tx fee.
console . log ( 'Address' , revealPayment . address ) ; // 'tb1p5mykwcq5ly7y2ctph9r2wfgldq94eccm2t83dd58k785p0zqzwkspyjkp5'

// Be extra careful: it's possible to accidentally send an inscription as a fee.
// Also, rarity is only available with ordinal wallet.
// But you can parse other inscriptions and create a common one using this.
const changeAddr = revealPayment . address ; // can be different
const revealAmount = 2000n ;
const fee = 500n ;

const tx = new btc . Transaction ( { customScripts } ) ;
tx . addInput ( {
  ... revealPayment ,
  // This is txid of tx with bitcoins we sent (replace)
  txid : '75ddabb27b8845f5247975c8a5ba7c6f336c4570708ebe230caf6db5217ae858' ,
  index : 0 ,
  witnessUtxo : { script : revealPayment . script , amount : revealAmount } ,
} ) ;
tx . addOutputAddress ( changeAddr , revealAmount - fee , TESTNET ) ;
tx . sign ( privKey , undefined , new Uint8Array ( 32 ) ) ;
tx . finalize ( ) ;

const txHex = hex . encode ( tx . extract ( ) ) ;
console . log ( txHex ) ; // Hex of reveal tx to broadcast
const tx2 = btc . Transaction . fromRaw ( hex . decode ( txHex ) ) ; // Parsing inscriptions
console . log ( 'parsed' , ordinals . parseWitness ( tx2 . inputs [ 0 ] . finalScriptWitness ) ) ;
console . log ( 'vsize' , tx2 . vsize ) ; // Reveal tx should pay at least this much fee

TypeScript-API

 import { Coder } from '@scure/base' ;
import * as P from 'micro-packed' ;
import { ScriptType , OptScript , CustomScript } from '@scure/btc-signer' ;
type Bytes = Uint8Array ;
export declare const InscriptionId : P . Coder < string , Bytes > ;
type TagRaw = {
    tag : Bytes ;
    data : Bytes ;
} ;
declare const TagCoders : {
    pointer : P . CoderType < bigint > ;
    contentType : P . CoderType < string > ;
    parent : P . Coder < string , Uint8Array > ;
    metadata : P . CoderType < any > ;
    metaprotocol : P . CoderType < string > ;
    contentEncoding : P . CoderType < string > ;
    delegate : P . Coder < string , Uint8Array > ;
    rune : P . CoderType < bigint > ;
    note : P . CoderType < string > ;
} ;
export type Tags = Partial < {
    [ K in keyof typeof TagCoders ] : P . UnwrapCoder < ( typeof TagCoders ) [ K ] > ;
} > & {
    unknown ?: [ Bytes , Bytes ] [ ] ;
} ;
export type Inscription = { tags : Tags ; body : Bytes ; cursed ?: boolean ; } ;
type OutOrdinalRevealType = { type : 'tr_ord_reveal' ; pubkey : Bytes ; inscriptions : Inscription [ ] ; } ;
export declare const OutOrdinalReveal : Coder < OptScript , OutOrdinalRevealType | undefined > & CustomScript ;
export declare function parseInscriptions ( script : ScriptType , strict ?: boolean ) : Inscription [ ] | undefined ;
/**
 * Parse inscriptions from reveal tx input witness (tx.inputs[0].finalScriptWitness)
 */
export declare function parseWitness ( witness : Bytes [ ] ) : Inscription [ ] | undefined ;
/**
 * Create reveal transaction. Inscription created on spending output from this address by
 * revealing taproot script.
 */
export declare function p2tr_ord_reveal ( pubkey : Bytes , inscriptions : Inscription [ ] ) : {
    type : string ;
    script : Uint8Array ;
} ;

CLI

npm install -g Mikroordinalzahlen ord file.jpg

Verwendung: ord [--net mainnet|testnet] [--priv key] [--recovery key] [--compress=on|off] [--fee 10.1] [--addr address]

• Netz: Bitcoin-Netzwerk
• priv: privater Taproot-Schlüssel im WIF-Format, wird zur Offenlegung der Transaktion verwendet. Verwenden Sie nicht Ihr Wallet, priv sollte ein neues sein. Wir generieren einen temporären Schlüssel, falls keiner bereitgestellt wird
• Wiederherstellung: privater Taproot-Schlüssel im WIF-Format, kann verwendet werden, um versehentlich an die Registrierungsadresse gesendete Bitcoins wiederherzustellen, ohne die volle Registrierungsgebühr zu zahlen.
• komprimieren: Mit Brotli komprimierte Inschriften. Kompatibel mit Explorern. Standard=ein
• Gebühr: Bitcoin-Netzwerkgebühr in Satoshis
• Adresse: Adresse, an die die Anmeldung nach der Enthüllung gesendet wird. Wichtig: Der erste Samstag wird immer eingeschrieben. Stapelbeschriftungen werden nicht unterstützt.

Design

Es gibt keinen Netzwerkcode. Dadurch wird das Paket sicherer, die Entwicklererfahrung wird jedoch beeinträchtigt.

Wir können die Gebühren wahrscheinlich automatisch abrufen, aber die utxo-Auswahl würde komplexer werden. Wenn der Benutzer beispielsweise zuvor etwas eingeschrieben hat oder seltene Ordnungszahlen hat, benötigen wir Zugriff auf den Ordnungsknoten, um das zu wissen. Außerdem wissen wir nichts über eingefrorene Ausgaben in der Wallet: Sie befinden sich nur innerhalb einer Wallet.

Randfälle, die Sie im Hinterkopf behalten sollten:

1. Der Benutzer hat die falsche TXID/den falschen Index hinzugefügt oder die Anwendung nach dem Senden beendet
   • Wir drucken den temporären privaten Schlüssel aus. Der Benutzer kann neu starten, indem er ihn mit „--priv“ bereitstellt.
   • Solange Gebühr/Netzwerk/Pfad gleich sind, können Sie den Vorgang neu starten
2. Der Benutzer hat weniger als den Betrag oder mehrere UTXO gesendet.
   • Dies ist tatsächlich schwieriger, da für jede Ausgabe die volle Anmeldegebühr anfällt
   • dazu fügen wir recovery hinzu

Testen

Entdecker

Verwenden Sie Mempool und Ordinalsbot.

Testnet-Münzen erhalten

Es gibt mehrere Wasserhähne: uo1, eu, pump

Geldbörsen von Drittanbietern

So verwenden Sie Sparrow auf dem Mac:

 open /Applications/Sparrow.app --args -n testnet

Lizenz

MIT (c) Paul Miller (https://paulmillr.com), siehe LIZENZdatei.