Skip to content

Commit bebf4c4

Browse files
committed
update workflow to look for llms-full.txt on check, updated llms
1 parent 0d560cf commit bebf4c4

File tree

11 files changed

+602
-47
lines changed

11 files changed

+602
-47
lines changed

.github/workflows/check-llms.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Validate llms.txt
1+
name: Validate llms-full.txt
22

33
on:
44
pull_request:
@@ -23,31 +23,31 @@ jobs:
2323
python -m pip install --upgrade pip
2424
pip install pyyaml requests
2525
26-
- name: Get SHA256 hash of the PR's llms.txt file
26+
- name: Get SHA256 hash of the PR's llms-full.txt file
2727
id: pr_llms_hash
2828
run: |
29-
if [ -f "llms.txt" ]; then
30-
# Calculate SHA256 hash of the llms.txt file in the PR branch (checked out by default)
31-
sha256sum llms.txt | awk '{ print $1 }' > pr_sha256.txt
29+
if [ -f "llms-full.txt" ]; then
30+
# Calculate SHA256 hash of the llms-full.txt file in the PR branch (checked out by default)
31+
sha256sum llms-full.txt | awk '{ print $1 }' > pr_sha256.txt
3232
else
3333
echo "0000" > pr_sha256.txt
3434
fi
3535
cat pr_sha256.txt
3636
37-
- name: Generate llms.txt using the Python script
37+
- name: Generate llms-full.txt using the Python script
3838
run: python3 scripts/generate_llms.py
3939

40-
- name: Calculate SHA256 hash of the generated llms.txt
40+
- name: Calculate SHA256 hash of the generated llms-full.txt
4141
id: generated_llms_hash
4242
run: |
43-
# Full path to the generated llms.txt file
44-
llms_file="/home/runner/work/polkadot-docs/polkadot-docs/llms.txt"
43+
# Full path to the generated llms-full.txt file
44+
llms_file="/home/runner/work/polkadot-docs/polkadot-docs/llms-full.txt"
4545
4646
# Check if the file exists before calculating the hash
4747
if [ -f "$llms_file" ]; then
4848
sha256sum "$llms_file" | awk '{ print $1 }' > generated_sha256.txt
4949
else
50-
echo "Error: llms.txt not found at $llms_file"
50+
echo "Error: llms-full.txt not found at $llms_file"
5151
exit 1
5252
fi
5353
cat generated_sha256.txt
@@ -58,10 +58,10 @@ jobs:
5858
pr_hash=$(cat pr_sha256.txt)
5959
6060
if [ "$generated_hash" != "$pr_hash" ]; then
61-
echo "Error: SHA256 hashes do not match. The generated llms.txt file differs from the one in the PR."
61+
echo "Error: SHA256 hashes do not match. The generated llms-full.txt file differs from the one in the PR."
6262
echo "You need to run the generate LLMS script:"
6363
echo "python3 scripts/generate_llms.py"
6464
exit 1
6565
else
66-
echo "SHA256 hashes match. The llms.txt file is consistent."
66+
echo "SHA256 hashes match. The llms-full.txt file is consistent."
6767
fi

llms-files/llms-basics.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7075,6 +7075,22 @@ The conversion process is implemented through the [`to_address`](https://parityt
70757075

70767076
**Stateful Mapping for Reversibility** : Since the conversion from 32-byte to 20-byte addresses is inherently lossy, the system provides an optional stateful mapping through the [`OriginalAccount`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/storage_types/struct.OriginalAccount.html){target=\_blank} storage. When a Polkadot account registers a mapping (via the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function), the system stores the original 32-byte account ID, enabling the [`to_account_id`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.to_account_id){target=\_blank} function to recover the exact original account rather than falling back to a default conversion.
70777077

7078+
7079+
### Account Mapping for Native Polkadot Accounts
7080+
7081+
If you have a native Polkadot account (32-byte format) that was created with a Polkadot/Substrate keypair (Ed25519/Sr25519) rather than an Ethereum-compatible keypair (secp256k1), you'll need to map your account to enable Ethereum compatibility.
7082+
7083+
To map your account, call the [`map_account`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/dispatchables/fn.map_account.html){target=\_blank} extrinsic of the [`pallet_revive`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html){target=\_blank} pallet using your original Substrate account. This creates a stateful mapping that allows your 32-byte account to interact with the Ethereum-compatible smart contract system.
7084+
7085+
Once mapped, you'll be able to:
7086+
7087+
- Transfer funds between 20-byte format addresses.
7088+
- Interact with smart contracts using Ethereum-compatible tools like MetaMask.
7089+
- Maintain full reversibility to your original 32-byte account format.
7090+
7091+
!!! warning "Mapping Requirement"
7092+
Without this mapping, native Polkadot accounts cannot transfer funds or interact with the Ethereum-compatible layer on the Hub.
7093+
70787094
## Account Registration
70797095

70807096
The registration process is implemented through the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function. This process involves:

llms-files/llms-dapps.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11657,6 +11657,22 @@ The conversion process is implemented through the [`to_address`](https://parityt
1165711657

1165811658
**Stateful Mapping for Reversibility** : Since the conversion from 32-byte to 20-byte addresses is inherently lossy, the system provides an optional stateful mapping through the [`OriginalAccount`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/storage_types/struct.OriginalAccount.html){target=\_blank} storage. When a Polkadot account registers a mapping (via the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function), the system stores the original 32-byte account ID, enabling the [`to_account_id`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.to_account_id){target=\_blank} function to recover the exact original account rather than falling back to a default conversion.
1165911659

11660+
11661+
### Account Mapping for Native Polkadot Accounts
11662+
11663+
If you have a native Polkadot account (32-byte format) that was created with a Polkadot/Substrate keypair (Ed25519/Sr25519) rather than an Ethereum-compatible keypair (secp256k1), you'll need to map your account to enable Ethereum compatibility.
11664+
11665+
To map your account, call the [`map_account`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/dispatchables/fn.map_account.html){target=\_blank} extrinsic of the [`pallet_revive`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html){target=\_blank} pallet using your original Substrate account. This creates a stateful mapping that allows your 32-byte account to interact with the Ethereum-compatible smart contract system.
11666+
11667+
Once mapped, you'll be able to:
11668+
11669+
- Transfer funds between 20-byte format addresses.
11670+
- Interact with smart contracts using Ethereum-compatible tools like MetaMask.
11671+
- Maintain full reversibility to your original 32-byte account format.
11672+
11673+
!!! warning "Mapping Requirement"
11674+
Without this mapping, native Polkadot accounts cannot transfer funds or interact with the Ethereum-compatible layer on the Hub.
11675+
1166011676
## Account Registration
1166111677

1166211678
The registration process is implemented through the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function. This process involves:

llms-files/llms-infrastructure.txt

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -940,9 +940,9 @@ Users running Debian-based distributions like Ubuntu can install the binaries us
940940
Execute the following commands as root to add the official repository and install the binaries:
941941

942942
```bash
943-
# Import the security@parity.io GPG key
944-
gpg --recv-keys --keyserver hkps://keys.mailvelope.com 9D4B2B6EB8F97156D19669A9FF0812D491B96798
945-
gpg --export 9D4B2B6EB8F97156D19669A9FF0812D491B96798 > /usr/share/keyrings/parity.gpg
943+
# Import the release-team@parity.io GPG key
944+
gpg --keyserver hkps://keyserver.ubuntu.com --receive-keys 90BD75EBBB8E95CB3DA6078F94A4029AB4B35DAE
945+
gpg --export 90BD75EBBB8E95CB3DA6078F94A4029AB4B35DAE > /usr/share/keyrings/parity.gpg
946946

947947
# Add the Parity repository and update the package index
948948
echo 'deb [signed-by=/usr/share/keyrings/parity.gpg] https://releases.parity.io/deb release main' > /etc/apt/sources.list.d/parity.list
@@ -2344,16 +2344,7 @@ Some minor offenses, such as spamming, are only punished by networking reputatio
23442344

23452345
### Penalties by Offense
23462346

2347-
Below, you can find a summary of penalties for specific offenses:
2348-
2349-
| Offense | [Slash (%)](#slashing) | [On-Chain Disabling](#disabling) | [Off-Chain Disabling](#disabling) | [Reputational Changes](#reputation-changes) |
2350-
|:------------------------------------:|:----------------------:|:--------------------------------------:|:------------------------------------:|:-------------------------------------------:|
2351-
| Backing Invalid | 100% | Yes (High Priority) | Yes (High Priority) | No |
2352-
| ForInvalid Vote | 2% | Yes (Mid Priority) | Yes (Mid Priority) | No |
2353-
| AgainstValid Vote | 0% | Yes (Low Priority) | Yes (Low Priority) | No |
2354-
| GRANDPA / BABE / BEEFY Equivocations | 0.01-100% | Yes (Varying Priority)| No | No |
2355-
| Seconded + Valid Equivocation | - | No | No | No |
2356-
| Double Seconded Equivocation | - | No | No | Yes |
2347+
Refer to the Polkadot Wiki's [offenses page](https://wiki.polkadot.com/learn/learn-offenses/){target=\_blank} for a summary of penalties for specific offenses.
23572348
--- END CONTENT ---
23582349

23592350
Doc-Content: https://docs.polkadot.com/infrastructure/staking-mechanics/rewards-payout/
@@ -9602,6 +9593,22 @@ The conversion process is implemented through the [`to_address`](https://parityt
96029593

96039594
**Stateful Mapping for Reversibility** : Since the conversion from 32-byte to 20-byte addresses is inherently lossy, the system provides an optional stateful mapping through the [`OriginalAccount`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/storage_types/struct.OriginalAccount.html){target=\_blank} storage. When a Polkadot account registers a mapping (via the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function), the system stores the original 32-byte account ID, enabling the [`to_account_id`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.to_account_id){target=\_blank} function to recover the exact original account rather than falling back to a default conversion.
96049595

9596+
9597+
### Account Mapping for Native Polkadot Accounts
9598+
9599+
If you have a native Polkadot account (32-byte format) that was created with a Polkadot/Substrate keypair (Ed25519/Sr25519) rather than an Ethereum-compatible keypair (secp256k1), you'll need to map your account to enable Ethereum compatibility.
9600+
9601+
To map your account, call the [`map_account`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/dispatchables/fn.map_account.html){target=\_blank} extrinsic of the [`pallet_revive`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html){target=\_blank} pallet using your original Substrate account. This creates a stateful mapping that allows your 32-byte account to interact with the Ethereum-compatible smart contract system.
9602+
9603+
Once mapped, you'll be able to:
9604+
9605+
- Transfer funds between 20-byte format addresses.
9606+
- Interact with smart contracts using Ethereum-compatible tools like MetaMask.
9607+
- Maintain full reversibility to your original 32-byte account format.
9608+
9609+
!!! warning "Mapping Requirement"
9610+
Without this mapping, native Polkadot accounts cannot transfer funds or interact with the Ethereum-compatible layer on the Hub.
9611+
96059612
## Account Registration
96069613

96079614
The registration process is implemented through the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function. This process involves:

llms-files/llms-networks.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7434,6 +7434,22 @@ The conversion process is implemented through the [`to_address`](https://parityt
74347434

74357435
**Stateful Mapping for Reversibility** : Since the conversion from 32-byte to 20-byte addresses is inherently lossy, the system provides an optional stateful mapping through the [`OriginalAccount`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/storage_types/struct.OriginalAccount.html){target=\_blank} storage. When a Polkadot account registers a mapping (via the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function), the system stores the original 32-byte account ID, enabling the [`to_account_id`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.to_account_id){target=\_blank} function to recover the exact original account rather than falling back to a default conversion.
74367436

7437+
7438+
### Account Mapping for Native Polkadot Accounts
7439+
7440+
If you have a native Polkadot account (32-byte format) that was created with a Polkadot/Substrate keypair (Ed25519/Sr25519) rather than an Ethereum-compatible keypair (secp256k1), you'll need to map your account to enable Ethereum compatibility.
7441+
7442+
To map your account, call the [`map_account`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/dispatchables/fn.map_account.html){target=\_blank} extrinsic of the [`pallet_revive`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html){target=\_blank} pallet using your original Substrate account. This creates a stateful mapping that allows your 32-byte account to interact with the Ethereum-compatible smart contract system.
7443+
7444+
Once mapped, you'll be able to:
7445+
7446+
- Transfer funds between 20-byte format addresses.
7447+
- Interact with smart contracts using Ethereum-compatible tools like MetaMask.
7448+
- Maintain full reversibility to your original 32-byte account format.
7449+
7450+
!!! warning "Mapping Requirement"
7451+
Without this mapping, native Polkadot accounts cannot transfer funds or interact with the Ethereum-compatible layer on the Hub.
7452+
74377453
## Account Registration
74387454

74397455
The registration process is implemented through the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function. This process involves:

llms-files/llms-parachains.txt

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7478,13 +7478,13 @@ To define your chain specification:
74787478
You should now see your chain specification containing SCALE-encoded hex values versus plain text.
74797479

74807480

7481-
!!!note "Deprecation of `para_id` in Chain Specs"
7481+
!!!note "`para_id` Considerations"
74827482

7483-
The `para_id` field in JSON chain specifications, added through the [`chain-spec-builder`](https://paritytech.github.io/polkadot-sdk/master/staging_chain_spec_builder/index.html){target=\_blank} command, is currently used by nodes for configuration purposes. However, beginning with Polkadot SDK release `stable2509`, the `para_id` field will no longer be required in chain specifications. Instead, runtimes need to be updated to implement the [`cumulus_primitives_core::GetParachainInfo`](https://paritytech.github.io/polkadot-sdk/master/cumulus_primitives_core/trait.GetParachainInfo.html){target=\_blank} trait to successfully operate with nodes using chain specs that omit the `para_id` field.
7483+
The `para_id` field in JSON chain specifications, added through the [`chain-spec-builder`](https://paritytech.github.io/polkadot-sdk/master/staging_chain_spec_builder/index.html){target=\_blank} command, is used by nodes for configuration purposes. Beginning with Polkadot SDK release `stable2509`, runtimes can optionally implement the [`cumulus_primitives_core::GetParachainInfo`](https://paritytech.github.io/polkadot-sdk/master/cumulus_primitives_core/trait.GetParachainInfo.html){target=\_blank} trait as an alternative method for parachain identification.
74847484

7485-
With the upcoming `stable2512` release, the `para_id` field will be completely removed from chain specifications in favor of the new runtime API. New nodes will be unable to start with chain specs containing the `para_id` field unless the runtime implements the `GetParachainInfo` trait. Ensure your runtime is updated to maintain compatibility with future node versions.
7485+
However, the `para_id` field will remain supported in chain specifications for backwards compatibility. This ensures that nodes can still sync from genesis or from runtime states that existed before the `GetParachainInfo` runtime API was introduced.
74867486

7487-
For guidance on performing runtime upgrades to implement this new trait, refer to the [runtime upgrade tutorial](/tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade/){target=\_blank}.
7487+
For guidance on performing runtime upgrades to implement the `GetParachainInfo` trait, refer to the [runtime upgrade tutorial](/tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade/){target=\_blank}.
74887488

74897489
## Export Required Files
74907490

@@ -16535,6 +16535,22 @@ The conversion process is implemented through the [`to_address`](https://parityt
1653516535

1653616536
**Stateful Mapping for Reversibility** : Since the conversion from 32-byte to 20-byte addresses is inherently lossy, the system provides an optional stateful mapping through the [`OriginalAccount`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/storage_types/struct.OriginalAccount.html){target=\_blank} storage. When a Polkadot account registers a mapping (via the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function), the system stores the original 32-byte account ID, enabling the [`to_account_id`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.to_account_id){target=\_blank} function to recover the exact original account rather than falling back to a default conversion.
1653716537

16538+
16539+
### Account Mapping for Native Polkadot Accounts
16540+
16541+
If you have a native Polkadot account (32-byte format) that was created with a Polkadot/Substrate keypair (Ed25519/Sr25519) rather than an Ethereum-compatible keypair (secp256k1), you'll need to map your account to enable Ethereum compatibility.
16542+
16543+
To map your account, call the [`map_account`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/pallet/dispatchables/fn.map_account.html){target=\_blank} extrinsic of the [`pallet_revive`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/index.html){target=\_blank} pallet using your original Substrate account. This creates a stateful mapping that allows your 32-byte account to interact with the Ethereum-compatible smart contract system.
16544+
16545+
Once mapped, you'll be able to:
16546+
16547+
- Transfer funds between 20-byte format addresses.
16548+
- Interact with smart contracts using Ethereum-compatible tools like MetaMask.
16549+
- Maintain full reversibility to your original 32-byte account format.
16550+
16551+
!!! warning "Mapping Requirement"
16552+
Without this mapping, native Polkadot accounts cannot transfer funds or interact with the Ethereum-compatible layer on the Hub.
16553+
1653816554
## Account Registration
1653916555

1654016556
The registration process is implemented through the [`map`](https://paritytech.github.io/polkadot-sdk/master/pallet_revive/trait.AddressMapper.html#tymethod.map){target=\_blank} function. This process involves:

0 commit comments

Comments
 (0)