Skip to content

Commit 1a8303b

Browse files
authored
feat: add runes core compression algorithm ULEB128 (#1123)
* docs: runes add ULEB128压缩算法 * docs: add etching example * docs: add mint example * docs: add transfer example
1 parent 210a598 commit 1a8303b

File tree

2 files changed

+248
-1
lines changed

2 files changed

+248
-1
lines changed

BTC/Runes/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ BRC-20 是由匿名开发者 @domodata 于2023年3月8日推出,是基于刚
1515
## 符文石(RuneStone)
1616
> 符文协议消息,称为符文石,存储在比特币交易输出中。 在区块 840,000(比特币第四次减半) 上激活, 早期区块中的符文石将被忽略。
1717
18-
符文石输出的脚本以`OP_RETURN`开头,然后是 `OP_13`,最后是零个或多个数据推送。这些推送的数据被串联起来并解码为128位整数序列,最后解析为符石。
18+
符文石输出的脚本以`OP_RETURN`开头,然后是 `OP_13`,最后是零个或多个数据推送。这些推送的数据被串联起来并解码为128位整数序列,最后解析为符石,相关编解码逻辑见[ULEB128](./ULEB128.md)
1919
一笔交易最多可以拥有一颗符文石。符文石可以蚀刻一个新的符文或者铸造一个现有的符文,并将符文从交易的输入传输到其输出。
2020
```js
2121
struct Runestone {

BTC/Runes/ULEB128.md

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
# 简介
2+
3+
ULEB128(Unsigned Little Endian Base 128)是一种编码方式,设计用于高效地表示无符号整数,尤其是在计算机科学和编程中。它采用变长编码方式,旨在减少存储和传输数据时的开销。
4+
5+
# 示例
6+
7+
## ULEB128 编码
8+
9+
ULEB128编码将无符号整数编码为一系列字节,其中每个字节除了最后一个字节外,最高位都被设置为1,表示还有更多的字节。
10+
整数从其最低有效位到最高有效位进行编码,逐字节处理,每次处理7位。处理的过程中,将7位数据放入字节的低7位,若还有更多数据待处理,则设置高位为1,否则设置为0。这种编码方式保证了较小的数值占用较少的空间。
11+
** 举例 **
12+
假设要编码整数 300(二进制表示为 10, 0101100):
13+
14+
- 第一个字节中,低7位为 0101100(十进制的 44),最高位设置为 1(表示还有数据),因此第一个字节为 10101100。
15+
- 第二个字节仅包含剩余的 10,放在最低位,其余位填充为0,最高位为 0(表示这是最后一个字节),因此第二个字节为 00000010。
16+
- 最终编码为 0xD4 0x02。
17+
18+
## ULEB128 解码
19+
20+
ULEB128 解码需要观察每个字节的最高位(也称为继续位),在 ULEB128 编码中,每个字节的最高位(第8位)用于指示是否还有更多的字节需要读取。
21+
22+
- 如果这一位是 1,表示后续还有至少一个字节是这个数的一部分。
23+
- 如果这一位是 0,则表示这是最后一个字节。
24+
** 举例 **
25+
假设要解码十六进制 **cfa433**
26+
- 第一个字节 cf(二进制:11001111),数据位:1001111(二进制),十进制值为 79。
27+
- 第二个字节 a4(二进制:10100100),数据位:0100100(二进制),十进制值为 36。
28+
- 第三个字节 33(二进制:00110011),数据位:0110011(二进制),十进制值为 51。
29+
30+
相加得到 79 + 36 _ 128 + 51 _ 128^2 = 840271
31+
32+
## 在Runes中应用
33+
34+
## 蚀刻
35+
36+
### 数据结构
37+
38+
```js
39+
type Etching = {
40+
divisibility?: U8;
41+
premine?: U128;
42+
rune?: Rune;
43+
spacers?: U32;
44+
symbol?: Symbol;
45+
terms?: Terms;
46+
};
47+
48+
type Rune = u128;
49+
50+
type Terms = {
51+
amount?: U128;
52+
cap?: U128;
53+
height?: {
54+
start?: U64;
55+
end?: U64;
56+
};
57+
offset?: {
58+
start?: U64;
59+
end?: U64;
60+
};
61+
};
62+
```
63+
64+
### 示例
65+
66+
| DOG•GO•TO•THE•MOON 蚀刻交易
67+
https://mempool.space/zh/tx/e79134080a83fe3e0e06ed6990c5a9b63b362313341745707a2bff7d788a1375
68+
69+
**1. Raw OP_RETURN**
70+
71+
```js
72+
OP_RETURN
73+
OP_PUSHNUM_13
74+
OP_PUSHBYTES_33 02010487a1c3f0c0ebf7fb9d01010503d4040595e80706808084fea6dee1111601
75+
```
76+
77+
**2. ULEB128解码**
78+
79+
```js
80+
[
81+
{ decimal: 2n, hex: '02' },
82+
{ decimal: 1n, hex: '01' },
83+
{ decimal: 4n, hex: '04' },
84+
{ decimal: 11382812169668186247n, hex: '87a1c3f0c0ebf7fb9d01' },
85+
{ decimal: 1n, hex: '01' },
86+
{ decimal: 5n, hex: '05' },
87+
{ decimal: 3n, hex: '03' },
88+
{ decimal: 596n, hex: 'd404' },
89+
{ decimal: 5n, hex: '05' },
90+
{ decimal: 128021n, hex: '95e807' },
91+
{ decimal: 6n, hex: '06' },
92+
{ decimal: 10000000000000000n, hex: '808084fea6dee111' },
93+
{ decimal: 22n, hex: '16' },
94+
{ decimal: 1n, hex: '01' },
95+
];
96+
```
97+
98+
**3. 对照码表翻译**
99+
100+
```js
101+
{
102+
"edicts": [],
103+
"etching": {
104+
"divisibility": "5",
105+
"premine": "10000000000000000",
106+
"rune": "11382812169668186247",
107+
"spacers": "596",
108+
"symbol": "128021",
109+
"turbo": false,
110+
"terms": null
111+
},
112+
"mint": null,
113+
"pointer": "1",
114+
"flags": "1",
115+
}
116+
```
117+
118+
## 铸造
119+
120+
### 数据结构
121+
122+
```js
123+
type Mint = {
124+
block: U64;
125+
tx: U32;
126+
}
127+
```
128+
129+
### 示例
130+
131+
| GOLD•RUNE•STONE 铸造交易
132+
https://mempool.space/zh/tx/b4da683f34fa2a159f887012a67a14e56dbbf8e38e2da991be45869413544e0b
133+
134+
**1. Raw OP_RETURN**
135+
136+
```js
137+
OP_RETURN
138+
OP_PUSHNUM_13
139+
OP_PUSHBYTES_16 14cfa43314b80400cfa433b804e80700
140+
```
141+
142+
**2. ULEB128解码**
143+
144+
```js
145+
[
146+
{ decimal: 20n, hex: '14' },
147+
{ decimal: 840271n, hex: 'cfa433' },
148+
{ decimal: 20n, hex: '14' },
149+
{ decimal: 568n, hex: 'b804' },
150+
{ decimal: 0n, hex: '00' },
151+
{ decimal: 840271n, hex: 'cfa433' },
152+
{ decimal: 568n, hex: 'b804' },
153+
{ decimal: 1000n, hex: 'e807' },
154+
{ decimal: 0n, hex: '00' },
155+
];
156+
```
157+
158+
**3. 对照码表翻译**
159+
160+
```js
161+
{
162+
"edicts": [
163+
{
164+
"id": {
165+
"block": "840271",
166+
"tx": "568"
167+
},
168+
"amount": "1000",
169+
"output": "0"
170+
}
171+
],
172+
"etching": null,
173+
"mint": {
174+
"block": "840271",
175+
"tx": "568"
176+
},
177+
"pointer": null
178+
}
179+
```
180+
181+
## 转账
182+
183+
### 数据结构
184+
185+
```js
186+
type Mint = {
187+
block: U64;
188+
tx: U32;
189+
}
190+
```
191+
192+
### 示例
193+
194+
| DOG•GO•TO•THE•MOON 转移交易
195+
https://mempool.space/zh/tx/966aff320562acd491458bded8fc9010590285aa3abd4801fe06192c242544ee
196+
197+
**1. Raw OP_RETURN**
198+
199+
```js
200+
OP_RETURN
201+
OP_PUSHNUM_13
202+
OP_PUSHBYTES_21 160b00c0a2330380ea8ed51f0b00008094ebdc030d
203+
```
204+
205+
**2. ULEB128解码**
206+
207+
```js
208+
[
209+
{ decimal: 22n, hex: '16' },
210+
{ decimal: 11n, hex: '0b' },
211+
{ decimal: 0n, hex: '00' },
212+
{ decimal: 840000n, hex: 'c0a233' },
213+
{ decimal: 3n, hex: '03' },
214+
{ decimal: 8500000000n, hex: '80ea8ed51f' },
215+
{ decimal: 11n, hex: '0b' },
216+
{ decimal: 0n, hex: '00' },
217+
{ decimal: 0n, hex: '00' },
218+
{ decimal: 1000000000n, hex: '8094ebdc03' },
219+
{ decimal: 13n, hex: '0d' },
220+
];
221+
```
222+
223+
**3. 对照码表翻译**
224+
225+
```js
226+
{
227+
"edicts": [
228+
{
229+
"id": {
230+
"block": "840000",
231+
"tx": "3"
232+
},
233+
"amount": "8500000000",
234+
"output": "11"
235+
},
236+
{
237+
"id": {
238+
"block": "840000",
239+
"tx": "3"
240+
},
241+
"amount": "1000000000",
242+
"output": "13"
243+
}
244+
],
245+
"pointer": "11"
246+
}
247+
```

0 commit comments

Comments
 (0)