Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dev: add definitions.json generation script #2826

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

dev: add definitions.json generation script #2826

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
16b2b60
add definitions codec gen
mvadari Nov 14, 2024
e9c9441
fix spacing
mvadari Nov 14, 2024
c7b72a2
remove new field
mvadari Nov 14, 2024
b0ea5fb
clean up
mvadari Nov 14, 2024
3e1756d
pipe to file
mvadari Nov 14, 2024
406ad49
Merge branch 'main' into definitions-generation
mvadari Nov 15, 2024
5d7c1a5
add package.json script
mvadari Nov 15, 2024
9c9ac7f
Merge branch 'main' into definitions-generation
mvadari Nov 18, 2024
6267de4
fix generateModels script
mvadari Nov 18, 2024
85f0f64
clean up
mvadari Nov 18, 2024
f5fe4fe
Merge branch 'main' into definitions-generation
mvadari Dec 13, 2024
b96cdc3
Merge branch 'main' into definitions-generation
mvadari Dec 20, 2024
7ec1ff5
fix Hash192
mvadari Dec 20, 2024
5e4e4b3
Merge branch 'main' into definitions-generation
ckeshava Jan 13, 2025
ee5bae5
Merge branch 'main' into definitions-generation
mvadari Feb 6, 2025
aca417c
switch script to use server_definitions order
mvadari Feb 6, 2025
c6fd141
fix tests
mvadari Feb 6, 2025
0bc8a10
clean up
mvadari Feb 6, 2025
be3f11f
Merge branch 'main' into definitions-generation
mvadari Feb 18, 2025
9abd99a
fix test
mvadari Feb 18, 2025
5922565
fix again
mvadari Feb 18, 2025
da40b84
Merge branch 'main' into definitions-generation
mvadari Feb 26, 2025
0e6a5ec
remove duplicate
mvadari Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/ripple-binary-codec/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"prepublishOnly": "npm test",
"test": "npm run build && jest --verbose false --silent=false ./test/*.test.ts",
"test:browser": "npm run build && karma start ./karma.config.js",
"lint": "eslint . --ext .ts --ext .test.js"
"lint": "eslint . --ext .ts --ext .test.js",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"lint": "eslint . --ext .ts --ext .test.js",
"lint": "eslint . --ext .ts",

Unrelated to this PR: There are no *.test.js files in this sub-directory tree.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this should stay in case there are any in the future.

"generateDefinitions": "node ./tools/generateDefinitions.js"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I tried to run this npm script, I got this error message. How should I run it?

➜  xrpl git:(definitions-generation) npm run generateDefinitions ~/rippled
npm error Lifecycle script `generateDefinitions` failed with error:
npm error workspace [email protected]
npm error location /Users/ckeshavabs/xrpl.js/packages/xrpl
npm error Missing script: "generateDefinitions"
npm error
npm error To see a list of scripts, run:
npm error   npm run [email protected]

However, explicitly mentioning the script works as intended: node ./tools/generateDefinitions.js ~/rippled

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to run it at the package/xrpl folder, not at the top level.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correction: Developers need to run it from packages/ripple-binary-codec path.

},
"keywords": [
"ripple",
Expand Down
39 changes: 16 additions & 23 deletions packages/ripple-binary-codec/src/enums/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,31 @@
"Metadata": 10004
},
"LEDGER_ENTRY_TYPES": {
"Any": -3,
"Child": -2,
"Invalid": -1,
"NFTokenOffer": 55,
"Check": 67,
"DID": 73,
"NegativeUNL": 78,
"NFTokenPage": 80,
"SignerList": 83,
"Ticket": 84,
"AccountRoot": 97,
"DirectoryNode": 100,
"RippleState": 114,
"Ticket": 84,
"SignerList": 83,
"Offer": 111,
"Bridge": 105,
"LedgerHashes": 104,
"Amendments": 102,
"LedgerHashes": 104,
"Bridge": 105,
"Offer": 111,
"DepositPreauth": 112,
"XChainOwnedClaimID": 113,
"XChainOwnedCreateAccountClaimID": 116,
"RippleState": 114,
"FeeSettings": 115,
"XChainOwnedCreateAccountClaimID": 116,
"Escrow": 117,
"PayChannel": 120,
"Check": 67,
"DepositPreauth": 112,
"NegativeUNL": 78,
"NFTokenPage": 80,
"NFTokenOffer": 55,
"AMM": 121,
"DID": 73,
"Oracle": 128,
"Any": -3,
"Child": -2,
"Nickname": 110,
"Contract": 99,
"GeneratorMap": 103
"Oracle": 128
},
"FIELDS": [
[
Expand Down Expand Up @@ -2933,12 +2930,9 @@
"AccountSet": 3,
"EscrowCancel": 4,
"SetRegularKey": 5,
"NickNameSet": 6,
"OfferCreate": 7,
"OfferCancel": 8,
"Contract": 9,
"TicketCreate": 10,
"TicketCancel": 11,
"SignerListSet": 12,
"PaymentChannelCreate": 13,
"PaymentChannelFund": 14,
Expand All @@ -2949,7 +2943,6 @@
"DepositPreauth": 19,
"TrustSet": 20,
"AccountDelete": 21,
"SetHook": 22,
"NFTokenMint": 25,
"NFTokenBurn": 26,
"NFTokenCreateOffer": 27,
Expand Down
Loading
Loading