stellar-xdr 30.0.0

Stellar XDR types, encoding, and decoding.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

.PHONY: all test build doc install readme fuzz fuzz-reduce watch generate generate-files clean fmt publish print-cargo-hack-args test-powerset

export RUSTFLAGS=-Dwarnings -Dclippy::all -Dclippy::pedantic

# The feature combinations that get built and tested. This is the single
# definition of them: the CI workflow reads it back with
# `make print-cargo-hack-args` so that the two cannot drift apart.
CARGO_HACK_ARGS=--feature-powerset --exclude-features default --group-features base64,serde,serde_json,schemars,arbitrary,hex,rand,type_enum,serde_ignored,test_feature

CARGO_DOC_ARGS?=--open

all: build test

test:
	cargo test --all-features

test-powerset:
	cargo hack test $(CARGO_HACK_ARGS)

print-cargo-hack-args:
	@printf '%s\n' "$(CARGO_HACK_ARGS)"

build: generate
	cargo hack clippy $(CARGO_HACK_ARGS) --all-targets
	cargo clippy --no-default-features --release --target wasm32v1-none

doc:
	cargo test --doc --all-features
	RUSTDOCFLAGS="--cfg docs" cargo +nightly doc --package stellar-xdr --all-features $(CARGO_DOC_ARGS)

install:
	cargo install --locked --path . --force --features cli

readme:
	cargo +nightly rustdoc -- -Zunstable-options -wjson \
		&& echo '# stellar-xdr' \
		| cat target/doc/stellar_xdr.json \
		| jq -r '"# stellar-xdr\n\n" + .index[.root|tostring].docs' \
		> README.md

# Run the fuzz corpus.
# Leak detection is disabled because the fuzzer tests the const impls that
# contain &'static data and so their Arbitrary impls explicitly leak.
fuzz:
	ASAN_OPTIONS=detect_leaks=0 cargo +nightly fuzz run spec-entry -- -rss_limit_mb=0 -max_len=10240 -runs=0

# Shrinks each corpus to the smallest set of inputs with the same coverage.
fuzz-reduce:
	ASAN_OPTIONS=detect_leaks=0 cargo +nightly fuzz cmin spec-entry -- -rss_limit_mb=0

watch:
	cargo watch --clear --watch-when-idle --shell '$(MAKE)'

generate: generate-files xdr-version xdr-json xdr-definitions-json

CUSTOM_DEFAULT_IMPL=TransactionEnvelope
CUSTOM_STR_IMPL=PublicKey,AccountId,ContractId,MuxedAccount,MuxedAccountMed25519,SignerKey,SignerKeyEd25519SignedPayload,NodeId,ScAddress,AssetCode,AssetCode4,AssetCode12,ClaimableBalanceId,PoolId,MuxedEd25519Account,MuxedContract,Int128Parts,UInt128Parts,Int256Parts,UInt256Parts

generate-files: src/generated.rs

src/generated.rs: $(sort $(wildcard xdr/*.x))
	cargo run --manifest-path xdr-generator-rust/generator/Cargo.toml -- \
		$(addprefix --input ,$(sort $(wildcard xdr/*.x))) \
		--output $@ \
		--custom-default $(CUSTOM_DEFAULT_IMPL) \
		--custom-str $(CUSTOM_STR_IMPL)
	rustfmt $@ && find src/generated -name '*.rs' | xargs rustfmt

xdr-version: $(wildcard .git/modules/xdr/**/*) $(wildcard xdr/*.x)
	git submodule status -- xdr | sed 's/^ *//g' | cut -f 1 -d " " | tr -d '\n' | tr -d '+' > xdr-version

xdr-json: src/generated.rs
	mkdir -p xdr-json
	cargo run --features cli -- types schema-files --out-dir xdr-json

xdr-definitions-json: $(sort $(wildcard xdr/*.x))
	mkdir -p xdr-definitions-json
	cargo run --manifest-path xdr-generator-rust/generator-definitions-json/Cargo.toml -- \
		$(addprefix --input ,$(sort $(wildcard xdr/*.x))) \
		--output xdr-definitions-json/xdr.json

clean:
	rm -f src/generated.rs
	rm -rf src/generated
	rm -f xdr-version
	rm -fr xdr-json
	rm -fr xdr-definitions-json
	cargo clean --quiet

fmt:
	cargo fmt --all

publish:
	cargo workspaces publish --all --force '*' --from-git --yes