微序數詞

微序詞

scure-btc-signer 之上的序數和銘文的最小 JS 函式庫。

將其用作 JS 程式碼中的庫，或運行附帶的 CLI 工具。銘文允許在 BTC 區塊鏈上上傳隨機檔案。

實驗性：在徹底測試之前可能會導致資金損失。

用法

npm install 微序數

• 創建銘文
• TypeScript API
• 命令列介面

創建銘文

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 ;
} ;

命令列介面

npm install -g 微序數 ord file.jpg

用法：ord [--net mainnet|testnet] [--priv key] [--recovery key] [--compress=on|off] [--fee 10.1] [--addr 位址]

• 網路：比特幣網絡
• priv：WIF格式的taproot私鑰，將用於揭示交易不要使用你的錢包，priv應該是一個新的。如果沒有提供，我們會產生一個臨時密鑰
• 恢復：WIF格式的taproot私鑰，可用於恢復任何意外發送到銘文地址的比特幣，而無需支付全額銘文費用。
• 壓縮：用 brotli 壓縮的銘文。與探索者相容。預設=開
• 費用：以聰為單位的比特幣網路費用
• addr：揭示後將發送銘文的地址 重要提示：第​​一個星期六始終被銘文。不支援批次刻錄。

設計

沒有網路代碼。它使包更安全，但降低了開發人員的體驗。

我們或許可以自動收取費用，但 utxo 選擇會變得更加複雜。例如，如果使用者之前記下了某些內容或具有罕見的序數，我們需要存取序數節點才能知道這一點。此外，我們對錢包中凍結的輸出一無所知：它僅位於錢包內部。

要記住的邊緣情況：

1. 用戶添加了錯誤的 txid/index 或發送後退出應用程式
   • 我們列印臨時私鑰，用戶可以透過提供「--priv」來重新啟動
   • 只要費用/網路/路徑相同，您就可以重新啟動流程
2. 用戶發送的 UTXO 數量少於或多個。
   • 這實際上更難，因為任何支出都需要全額銘文費
   • 為此我們添加recovery

測試

探險家

使用 mempool 和 ordinalsbot。

取得測試網硬幣

水龍頭有幾種：uo1、eu、pump

第三方錢包

在 Mac 上使用 Sparrow：

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

執照

麻省理工學院 (c) Paul Miller (https://paulmillr.com)，請參閱許可證文件。