simbahebinbo / bitcoin-inscription-parser

A parser for bitcoin ordinals inscriptions

bitcoin-inscription-parser

bitcoin-inscription-parser is a tool which helps to parse bitcoin inscriptions from transactions. Any inscription content wrapped in OP_FALSE OP_IF … OP_ENDIF using data pushes can be correctly parsed.

The tool supports single or multiple inscriptions in all input of the transaction.

bitcoin-inscription-parser 是一个工具，可以帮助解析比特币交易中的铭文。任何在数据推送中使用 OP_FALSE OP_IF … OP_ENDIF 包裹的铭文内容都可以被正确解析。

该工具支持交易输入中的单个或多个铭文。

build and run

go build -o bin/ examples/parse_inscriptions_from_tx.go
./bin/parse_inscriptions_from_tx

Unit tests

go test -v tests/script_parser_test.go 
=== RUN   TestScriptWithInscription
=== PAUSE TestScriptWithInscription
=== CONT  TestScriptWithInscription
    script_parser_test.go:75: Find inscription with content type: text/plain;charset=utf-8, content length: 28
    script_parser_test.go:81: test script with inscription: test passed
    script_parser_test.go:75: Find inscription with content type: text/plain;charset=utf-8, content length: 28
    script_parser_test.go:81: test script with unknown tag: test passed
    script_parser_test.go:75: Find inscription with content type: text/plain;charset=utf-8, content length: 28
    script_parser_test.go:81: test script with additions after OP_ENDIF: test passed
--- PASS: TestScriptWithInscription (0.00s)
PASS

=== RUN   TestScriptWithMultipleInscriptions
    script_parser_test.go:121: Find inscription with content type: text/plain;charset=utf-8, content length: 38
    script_parser_test.go:121: Find inscription with content type: text/plain;charset=utf-8, content length: 38
    script_parser_test.go:127: test script with multiple inscriptions: test passed
--- PASS: TestScriptWithMultipleInscriptions (0.00s)
PASS

=== RUN   TestScriptWithIncompleteEnvelopHeader
=== PAUSE TestScriptWithIncompleteEnvelopHeader
=== CONT  TestScriptWithIncompleteEnvelopHeader
    script_parser_test.go:200: test script with no OP_FALSE: test passed
    script_parser_test.go:200: test script with no OP_IF: test passed
    script_parser_test.go:200: test script with no ord: test passed
--- PASS: TestScriptWithIncompleteEnvelopHeader (0.00s)
PASS

=== RUN   TestScriptWithDuplicatedTag
=== PAUSE TestScriptWithDuplicatedTag
=== CONT  TestScriptWithDuplicatedTag
    script_parser_test.go:266: test script with duplicated content type tag: test passed
    script_parser_test.go:266: test script with unknown duplicated tag: test passed
--- PASS: TestScriptWithDuplicatedTag (0.00s)
PASS

=== RUN   TestScriptWithOtherOpcodeBeforeEndIf
    script_parser_test.go:304: test script with other opcode before OP_ENDIF: test passed
--- PASS: TestScriptWithOtherOpcodeBeforeEndIf (0.00s)
PASS

=== RUN   TestScriptWithUnrecognizedEvenTag
    script_parser_test.go:336: Find inscription with content type: text/plain;charset=utf-8, content length: 38
    script_parser_test.go:342: test script with unrecognized even tag: test passed
--- PASS: TestScriptWithUnrecognizedEvenTag (0.00s)
PASS

=== RUN   TestScriptWithNoContentTypeTag
    script_parser_test.go:369: Find inscription with content type: , content length: 36
    script_parser_test.go:375: test script with no content type tag: test passed
--- PASS: TestScriptWithNoContentTypeTag (0.00s)
PASS

=== RUN   TestScriptWithNoContentType
    script_parser_test.go:405: Find inscription with content type: , content length: 32
    script_parser_test.go:411: test script with no content type: test passed
--- PASS: TestScriptWithNoContentType (0.00s)
PASS

=== RUN   TestScriptWithNoContentBody
    script_parser_test.go:439: Find inscription with content type: text/plain;charset=utf-8, content length: 0
    script_parser_test.go:445: test script with no content body: test passed
--- PASS: TestScriptWithNoContentBody (0.00s)
PASS

=== RUN   TestScriptWithInvalidDtaLength
    script_parser_test.go:483: test script with invalid data length: test passed
--- PASS: TestScriptWithInvalidDtaLength (0.00s)
PASS

=== RUN   TestScriptWithZeroPush
    script_parser_test.go:512: Find inscription with content type: text/plain;charset=utf-8, content length: 0
    script_parser_test.go:518: test script with zero push: test passed
--- PASS: TestScriptWithZeroPush (0.00s)
PASS

=== RUN   TestScriptWithMultiplePushes
    script_parser_test.go:549: Find inscription with content type: text/plain;charset=utf-8, content length: 66
    script_parser_test.go:555: test script with multiple pushes: test passed
--- PASS: TestScriptWithMultiplePushes (0.00s)
PASS

=== RUN   TestScriptWithNoEndIf
=== PAUSE TestScriptWithNoEndIf
=== CONT  TestScriptWithNoEndIf
    script_parser_test.go:609: test script with no END_IF: test passed
    script_parser_test.go:609: test script with no END_IF: test passed
--- PASS: TestScriptWithNoEndIf (0.00s)
PASS