micro ordinaux

micro-ordinaux

Bibliothèque JS minimale pour les ordinaux et les inscriptions au-dessus de scure-btc-signer.

Utilisez-le comme bibliothèque dans votre code JS ou exécutez un outil CLI inclus. Les inscriptions permettent de télécharger des fichiers aléatoires sur la blockchain BTC.

Expérimental : peut entraîner une perte de fonds jusqu'à ce qu'il soit testé de manière approfondie.

Usage

npm installer des micro-ordinaux

• Création d'une inscription
• API TypeScript
• CLI

Création d'une inscription

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

API TypeScript

 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 micro-ordinaux ord file.jpg

Utilisation : ord [--net mainnet|testnet] [--priv key] [--recovery key] [--compress=on|off] [--fee 10.1] [--adresse adresse]

• net : réseau Bitcoin
• priv : clé privée de racine pivotante au format WIF, sera utilisée pour révéler la transaction. N'utilisez pas votre portefeuille, priv devrait être un nouveau. Nous générons une clé temporaire, si aucune n'est fournie
• récupération : clé privée de racine pivotante au format WIF, peut être utilisée pour récupérer tous les bitcoins envoyés à l'adresse d'inscription par accident sans payer la totalité des frais d'inscription.
• compresser : inscriptions compressées avec brotli. Compatible avec les explorateurs. par défaut = activé
• frais : frais du réseau Bitcoin en satoshis
• addr : adresse où l'inscription sera envoyée après révélation Important : le premier sat est toujours inscrit. Les inscriptions par lots ne sont pas prises en charge.

Conception

Il n'y a pas de code réseau. Cela rend le package plus sûr, mais diminue l'expérience du développeur.

Nous pouvons probablement récupérer les frais automatiquement, mais la sélection utxo deviendrait plus complexe. Par exemple, si l'utilisateur a déjà inscrit quelque chose ou possède des ordinaux rares, nous devons accéder au nœud ordinal pour le savoir. De plus, nous ne savons rien des sorties gelées dans le portefeuille : elles se trouvent uniquement à l'intérieur d'un portefeuille.

Cas extrêmes à garder à l’esprit :

1. l'utilisateur a ajouté un mauvais txid/index ou a quitté l'application après l'envoi
   • nous imprimons la clé privée temporaire, l'utilisateur peut redémarrer en lui fournissant '--priv'
   • tant que les frais/réseau/chemin sont les mêmes, vous pouvez redémarrer le processus
2. l'utilisateur a envoyé moins d'un montant ou plusieurs UTXO.
   • c'est en fait plus difficile, car toute dépense nécessitera des frais d'inscription complets
   • pour cela nous ajoutons recovery

Essai

Explorateurs

Utilisez mempool et ordinalsbot.

Obtenir des pièces testnet

Il existe plusieurs robinets : uo1, eu, pompe

Portefeuilles tiers

Pour utiliser Sparrow sur Mac :

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

Licence

MIT (c) Paul Miller (https://paulmillr.com), voir fichier LICENSE.