@substrate/txwrapper-registry

Registry creation support, catering to chains with types in @polkadot/apps-config

yarn add @substrate/txwrapper-registry

In a JS/TS index file of package:

import { getRegistry } from '@substrate/txwrapper-registry';

  // Create Polkadot's type registry.
  const registry = getRegistry({
    chainName: 'Polkadot',
    specName: 'polkadot',
    specVersion: 26,
    metadataRpc,
  });

Have a look at the examples to see how getRegistry is used in the whole lifecycle of a transaction, from generation to signing to broadcast.

Config

In order to instantiate a registry with your chains custom types you must pass in the path to your own types bundle file. If you would like to generate a types bundle file and don't know how to, feel free to use this helper library we have created to generate these types. generate-type-bundle.

The following env variable is accepted:

TX_TYPES_BUNDLE=/path-to-file - Note: It must be a valid JSON file that has the same structure as the OverrideBundleTypes in polkadot-js.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

7.5.3 (2024-11-26)

Note: Version bump only for package @substrate/txwrapper-registry

7.5.2 (2024-10-15)

Note: Version bump only for package @substrate/txwrapper-registry

7.5.1 (2024-06-18)

Note: Version bump only for package @substrate/txwrapper-registry

7.5.0 (2024-06-11)

Note: Version bump only for package @substrate/txwrapper-registry

7.5.0 (2024-06-11)

Note: Version bump only for package @substrate/txwrapper-registry

7.4.0 (2024-04-25)

Note: Version bump only for package @substrate/txwrapper-registry

7.3.0 (2024-03-19)

Note: Version bump only for package @substrate/txwrapper-registry

7.2.1 (2024-02-29)

Bug Fixes

• deps: bumped @substrate/dev to v0.7.1 (#357) (47bda87)

7.2.0 (2023-12-19)

Note: Version bump only for package @substrate/txwrapper-registry

7.1.1 (2023-10-23)

Note: Version bump only for package @substrate/txwrapper-registry

7.1.0 (2023-10-16)

Bug Fixes

• txwrapper-dev: Add @polkadot/api dependency (#315) (2e19ac5)

7.0.1 (2023-07-04)

Note: Version bump only for package @substrate/txwrapper-registry

7.0.0 (2023-07-03)

Note: Version bump only for package @substrate/txwrapper-registry

6.0.1 (2023-05-25)

Bug Fixes

• safer process.env access (#301) (0035d23)

6.0.0 (2023-05-08)

Features

• add additionalTypes, and typesBundle to getRegistryBase (#294) (671a2d1)

5.0.1 (2023-02-28)

Note: Version bump only for package @substrate/txwrapper-registry

5.0.0 (2023-01-13)

Note: Version bump only for package @substrate/txwrapper-registry

4.1.0 (2022-12-29)

Note: Version bump only for package @substrate/txwrapper-registry

4.0.3 (2022-12-07)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#272) (b78b085)

4.0.2 (2022-11-28)

Note: Version bump only for package @substrate/txwrapper-registry

4.0.1 (2022-10-03)

Bug Fixes

• remove asSpecifiedCallsOnlyV14 from getRegistryBase (#249) (8d94be4)

4.0.0 (2022-09-21)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#258) (141dfbe)

3.2.2 (2022-09-06)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#252) (82a1177)

3.2.1 (2022-08-30)

Bug Fixes

• deps: correctly fix asSpecifiedCallsOnlyV14 with the polkadot-js update (#246) (12431c1)
• types: Update polkadot-js deps to get the latest types (#250) (76be717)

3.2.0 (2022-08-16)

Note: Version bump only for package @substrate/txwrapper-registry

3.1.7 (2022-07-26)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#240) (813dfcb)

3.1.6 (2022-07-12)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#238) (41a559b)

3.1.5 (2022-07-05)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#237) (60dcd70)

3.1.4 (2022-06-27)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#236) (71fb6ea)

3.1.3 (2022-06-20)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#233) (5c55722)

3.1.2 (2022-06-15)

Note: Version bump only for package @substrate/txwrapper-registry

3.1.1 (2022-06-07)

Bug Fixes

• types: Update polkadot-js deps to get latest types (#229) (0f4cfc0)

3.1.0 (2022-05-31)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#227) (e23f48a)

Features

• asSpecifiedCallsOnlyV14 option (#224) (8b30028)

3.0.4 (2022-05-24)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#226) (5b90006)

3.0.3 (2022-05-17)

Bug Fixes

• types: Update p-js deps to get the latest types (#225) (3e94ce8)

3.0.2 (2022-05-09)

Note: Version bump only for package @substrate/txwrapper-registry

3.0.1 (2022-05-04)

Note: Version bump only for package @substrate/txwrapper-registry

3.0.0 (2022-05-04)

Bug Fixes

• deps: update pjs api (#212) (e876a42)
• deps: update pjs deps (#214) (43753e6)

2.0.3 (2022-04-21)

Note: Version bump only for package @substrate/txwrapper-registry

2.0.2 (2022-04-13)

Bug Fixes

• deps: update pjs common, api, expand resolutions, adjust polkadot js example value (#209) (9f57e18)

2.0.0 (2022-04-06)

Bug Fixes

• changelog: deprecate 1.7.0, and remove 1.6.0 (#205) (cec26b1)

1.7.0 (2022-04-06)

!Warning Deprecated: Please refer to v2.0.0 for this release

Bug Fixes

• deps: update polkadot-js api, apps-config, networks (#203) (088c6ca)

1.5.9 (2022-03-30)

Bug Fixes

• deps: update polkadot-js deps (#199) (14c4cc8)

1.5.8 (2022-03-24)

Note: Version bump only for package @substrate/txwrapper-registry

1.5.7 (2022-03-15)

Note: Version bump only for package @substrate/txwrapper-registry

1.5.6 (2022-03-09)

Note: Version bump only for package @substrate/txwrapper-registry

1.5.5 (2022-03-08)

Note: Version bump only for package @substrate/txwrapper-registry

1.5.4 (2022-02-25)

Note: Version bump only for package @substrate/txwrapper-registry

1.5.3 (2022-02-22)

Bug Fixes

• deps: Update polkadotjs (#181) (9adcea3)

1.5.2 (2022-02-10)

Bug Fixes

• update polkadot-js deps (#178) (0d970ba)

1.5.1 (2022-01-18)

Note: Version bump only for package @substrate/txwrapper-registry

1.5.0 (2022-01-18)

Bug Fixes

• decrease npm build, bundle size (#169) (1a16cfa)

1.4.0 (2022-01-06)

Bug Fixes

• types: bump polkadot-js deps (#160) (a0283d9)
• types: Update polkadot-js deps to get the latest types (#165) (1654307)

1.3.2 (2021-12-08)

Note: Version bump only for package @substrate/txwrapper-registry

1.3.1 (2021-12-07)

Note: Version bump only for package @substrate/txwrapper-registry

1.3.0 (2021-12-02)

Bug Fixes

• types: bump polkadot deps (#150) (dbcee2a)
• types: Update polkadot-js deps to get the latest types (#156) (3720c28)

Features

• add asCallsOnlyArg to reduce size of metadata (#149) (d590b09)

1.2.21 (2021-11-16)

Bug Fixes

• bump polkadot-js deps (#148) (5fd475c)

1.2.20 (2021-11-09)

Bug Fixes

• bump deps (#146) (ff645d8)

1.2.19 (2021-10-28)

Bug Fixes

• types: bump deps (#144) (c0f2db4)

1.2.18 (2021-10-20)

Bug Fixes

• deps: bump polkadot-js, cleanup resolutions (#140) (0eac6cb)

1.2.17 (2021-09-30)

Bug Fixes

• deps: bump deps, import(apps-config) (#137) (ad72aa6)

1.2.16 (2021-09-22)

Bug Fixes

• types: Update polkadot-js to get the latest types (#134) (8dd550d)

1.2.15 (2021-09-14)

Bug Fixes

• apps-config version for lodash downstream (#132) (fa400b0)

1.2.14 (2021-09-13)

Note: Version bump only for package @substrate/txwrapper-registry

1.2.13 (2021-08-31)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#129) (fb5c51f)

1.2.12 (2021-08-23)

Note: Version bump only for package @substrate/txwrapper-registry

1.2.11 (2021-08-17)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#124) (060ae47)

1.2.10 (2021-08-02)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#121) (30bed94)

1.2.9 (2021-07-27)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#120) (5a81ab2)

1.2.8 (2021-07-19)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#118) (70854a3)

1.2.7 (2021-07-13)

Bug Fixes

• update deps, fix dep bugs (#115) (2bb432e)

1.2.6 (2021-07-07)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#112) (6a9d724)

1.2.5 (2021-06-29)

Note: Version bump only for package @substrate/txwrapper-registry

1.2.4 (2021-06-28)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#107) (6cc53e1)

1.2.3 (2021-06-21)

Bug Fixes

• types: Update polkadot-js deps to get the latest types, update substrate/dev (#104) (4671ca3)

1.2.2 (2021-06-14)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#102) (541822b)

1.2.1 (2021-06-07)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#100) (137c35b)

1.1.3 (2021-05-31)

Bug Fixes

• types: Update polkadot-js deps to get the latest types (#96) (07a1ecd)

1.1.2 (2021-05-26)

Bug Fixes

• types: Bump polkadot-js deps to get latest types (#91) (a99b024)
• types: Update polkadot-js deps to get latest types (#93) (bc5d7ea)

1.1.1 (2021-05-18)

Bug Fixes

• types: Bump polkadot-js deps to get latest types (#91) (a99b024)

1.1.0 (2021-05-11)

Bug Fixes

• Bump polkadot-js/api; Remove deprecated createType log option (#89) (989cd7d)
• Update polkadot scoped deps to latest types (#90) (60b9e23)

1.0.0 (2021-05-03)

Bug Fixes

• update deps for latest types (#82) (fa89090)
• update polkadot-js deps; update decorateConstants usage (#88) (d6176b8)
• workspace script sharing (#86) (207d0bb)

0.5.1 (2021-04-19)

Note: Version bump only for package @substrate/txwrapper-registry

0.5.0 (2021-04-05)

Bug Fixes

• types: Bump deps to get latest types (#76) (e02b47e)

0.4.1 (2021-03-29)

Bug Fixes

• types: Update deps to get latest polkadot-js types (#70) (ead28d7)

0.4.0 (2021-03-22)

Bug Fixes

• deps: Update @polkadot deps to get latest types (#66) (be8ca96)

0.3.0 (2021-03-15)

Note: Version bump only for package @substrate/txwrapper-registry

0.2.1 (2021-03-02)

Bug Fixes

• types: Bump deps to get latest type definitions (#59) (76b5e55)

0.2.0-beta.0 (2021-02-23)

Note: Version bump only for package @substrate/txwrapper-registry

0.1.0 (2021-02-15)

Bug Fixes

• Adjust for polkadot-js/api update (#39) (e6b0aed)
• Align ChainProperties with polkadot-js def (#54) (5ee2d7d)

Features

• ORML methods; Acala pkg; More dynamic getRegistry and knownChainProperties; Lerna (#26) (731a943)
• Use local getRegistry functions (#48) (4c430ba), closes #47 #46 #45