open-index/open-npm huggingface dataset:
npm package: @substrate/ss58-registry
Description: Registry for SS58 account types
Author: Parity Technologies
Latest version: 1.51.0

# SS58 Registry

[![GitHub license](https://img.shields.io/badge/license-Apache2-green)](#LICENSE) [![GitLab Status](https://gitlab.parity.io/parity/ss58-registry/badges/main/pipeline.svg)](https://gitlab.parity.io/parity/ss58-registry/pipelines)

A list of known [SS58](https://docs.substrate.io/reference/address-formats/) account types as an enum, typically used by the Polkadot, Kusama or Substrate ecosystems.

These are derived from the [json data file](ss58-registry.json) in this repository which contains entries like this:

```js
{
	"prefix": 5,                       // unique u16
	"network": "astar",                // unique no spaces
	"displayName": "Astar Network",    //
	"symbols": ["ASTR"],               // symbol for each instance of the Balances pallet (usually one)
	"decimals": [18],                  // decimals for each symbol listed
	"standardAccount": "*25519",       // Sr25519, Ed25519 or secp256k1
	"website": "https://astar.network" // website or code repository of network
},
```

## Process

1. Fork and clone this repo.

2. Add an additional account type to `ss58-registry.json` (contiguous prefixes are better).

3. Bump the minor (middle) version number of the `Cargo.toml` by running:
```
cargo install cargo-bump && cargo bump minor
```
4. Run git stage, commit, push and then raise a pull request.

5. Once the PR has landed, one of the admins can
[create a new release](https://github.com/paritytech/ss58-registry/releases/new).
This will release the new version to [crates.io](https://crates.io/crates/ss58-registry)

## Licensing

Apache-2.0
npm package: @substrate/txwrapper-core
Description: Core components for creating a txwrapper lib.
Author: Parity Technologies
Latest version: 7.5.3

<br /><br />

<h1 align="center">@substrate/txwrapper-core</h1>
<h4 align="center">Core components for creating a txwrapper lib.</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@substrate/txwrapper-orml">
    <img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-core.svg" />
  </a>
  <a href="https://github.com/paritytech/txwrapper-core/actions">
    <img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
  </a>
  <a href="https://david-dm.org/paritytech/txwrapper-core">
    <img alt="david-dm" src="https://img.shields.io/david/paritytech/txwrapper-core.svg" />
  </a>
</p>

<br /><br />

```bash
yarn add @substrate/txwrapper-core
```

Have a look at the [txwrapper creation guide for chain builders](../../CHAIN_BUILDER.md) to see more guidance on how to use this package to build a chain specific txwrapper.

## Env Variables

This is a list of env variables that are used inside of txwrapper-core.


### `createMetadata` specific env vars.

**Summary**: 
`createMetadata` memoizes the call to ensure metadata is not reallocated in memory if it is the same call.

Methods that actively use `createMetadata` and are affected are:
- `defineMethod`
- `createDecoratedTx`
- `createDecoratedConstants`
- `createSignedTx`
- `decodeSignedTx`
- `decodeSigningPayload`
- `decodeUnsignedTx`

NOTE: `getRegistryBase` uses `createMetadataUnmemoized`

#### `TXWRAPPER_METADATA_CACHE_MAX`

**Summary**: 
Set the max amount of memoized calls we want in the cache. It uses an LRU cache to handle the input and output of values. This takes in an integer. Ex: `export TXWRAPPER_METADATA_CACHE_MAX=10`. This will default to unlimited size if the value is not inputted.

NOTES: 

- It is recommended to use a value greater 2 for the cache size as regressions have been seen in some cases for 2 or lower.

#### `TXWRAPPER_METADATA_CACHE_MAX_AGE`

**Summary**:
Set the TTL (Time To Live) for items in the memoized cache. This takes in an integer in the measurement of milliseconds. Ex: `export TXWRAPPER_METADATA_CACHE_MAX_AGE=1000` for 1 second.
npm package: @substrate/txwrapper-dev
Description: Core components for creating a txwrapper lib.
Author: Parity Technologies
Latest version: 7.5.3

<br /><br />

<h1 align="center">@substrate/txwrapper-dev</h1>
<h4 align="center">Dev components for creating a txwrapper lib.</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@substrate/txwrapper-dev">
    <img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-dev.svg" />
  </a>
  <a href="https://github.com/paritytech/txwrapper-core/actions">
    <img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
  </a>
  <a href="https://david-dm.org/paritytech/txwrapper-core">
    <img alt="david-dm" src="https://img.shields.io/david/paritytech/txwrapper-core.svg" />
  </a>
</p>

<br /><br />
npm package: @substrate/txwrapper-orml
Description: Selected dispatchables of ORML pallets, to be re-exported by txwrappers.
Author: Parity Technologies
Latest version: 7.5.3

<br /><br />

<h1 align="center">@substrate/txwrapper-orml</h1>
<h4 align="center">Selected dispatchables of ORML pallets, to be re-exported by chain specific txwrappers</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@substrate/txwrapper-orml">
    <img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-orml.svg" />
  </a>
  <a href="https://github.com/paritytech/txwrapper-core/actions">
    <img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
  </a>
  <a href="https://david-dm.org/paritytech/txwrapper-core">
    <img alt="david-dm" src="https://img.shields.io/david/paritytech/txwrapper-core.svg" />
  </a>
</p>

<br /><br />

```bash
yarn add @substrate/txwrapper-orml
```

In a JS/TS index file of package:

```typescript
import { methods as ORMLMethods } from '@substrate/txwrapper-orml';

// Export methods of pallets included in the chain
export const methods = {
	currencies: ORMLMethods.currencies,
  ...
};
```

Have a look at the [txwrapper creation guide for chain builders](../../CHAIN_BUILDER.md) to see more guidance on how to use this package in a chain specific txwrapper.
npm package: @substrate/txwrapper-polkadot
Description: Helper functions for Polkadot, Kusama, Paseo and Westend offline transaction generation.
Author: Parity Technologies
Latest version: 7.5.3

<br /><br />

<h1 align="center">@substrate/txwrapper-polkadot</h1>
<h4 align="center">Helper functions for Polkadot, Kusama, Paseo and Westend offline transaction generation.</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@substrate/txwrapper-polkadot">
    <img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-polkadot.svg" />
  </a>
  <a href="https://github.com/paritytech/txwrapper-core/actions">
    <img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
  </a>
  <a href="https://david-dm.org/paritytech/txwrapper-core">
    <img alt="david-dm" src="https://img.shields.io/david/paritytech/txwrapper-core.svg" />
  </a>
</p>

<br /><br />

# About

Txwrapper library for polkadot relay and system chains; specifically Polkadot, Kusama, Paseo, Westend, Asset Hub Polkadot and Asset Hub Kusama.

Note: not all methods available apply to all supported chains. To check what methods are supported by a chain consult the pallets included in chain's runtime.


## Get Started

```bash
yarn add @substrate/txwrapper-polkadot
```

In a JS/TS file:

```typescript
import {
  construct,
  methods,
} from '@substrate/txwrapper-polkadot';

const unsigned = methods.balance.transfer(
  {
    dest: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP',
    value: 100,
  },
  {
    // Additional information needed to construct the transaction offline.
  }
);

const signingPayload = construct.signingPayload(unsigned, { registry });
// On your offline device, sign the payload.
const signature = myOfflineSigning(signingPayload);

// `tx` is ready to be broadcasted.
const tx = construct.signedTx(unsigned, signature, { metadataRpc, registry });
```

Have a look at the [examples](/packages/txwrapper-examples/README.md) to see how you can perform the whole lifecycle of a transaction, from generation to signing to broadcast.
npm package: @substrate/txwrapper-registry
Description: Polkadot-js type registry creation assistants for txwrapper libraries.
Author: Parity Technologies
Latest version: 7.5.3

<br /><br />

<h1 align="center">@substrate/txwrapper-registry</h1>
<h4 align="center">Registry creation support, catering to chains with types in [@polkadot/apps-config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config/README.md)</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@substrate/txwrapper-registry">
    <img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-registry.svg" />
  </a>
  <a href="https://github.com/paritytech/txwrapper-core/actions">
    <img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
  </a>
  <a href="https://david-dm.org/paritytech/txwrapper-core">
    <img alt="david-dm" src="https://img.shields.io/david/paritytech/txwrapper-core.svg" />
  </a>
</p>

<br /><br />

```bash
yarn add @substrate/txwrapper-registry
```

In a JS/TS index file of package:

```typescript
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](/packages/txwrapper-examples/README.md) 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](https://github.com/paritytech/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`](https://github.com/polkadot-js/api/blob/master/packages/types/src/types/registry.ts#L75-L78) in polkadot-js.
npm package: @substrate/txwrapper-substrate
Description: Selected dispatchables of Substrate pallets, to be re-exported by txwrappers.
Author: Parity Technologies
Latest version: 7.5.3

<br /><br />

<h1 align="center">@substrate/txwrapper-substrate</h1>
<h4 align="center">Selected dispatchables of Substrate pallets, to be re-exported by chain specific txwrappers</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@substrate/txwrapper-substrate">
    <img alt="npm" src="https://img.shields.io/npm/v/@substrate/txwrapper-substrate.svg" />
  </a>
  <a href="https://github.com/paritytech/txwrapper-core/actions">
    <img alt="Github Actions" src="https://github.com/paritytech/txwrapper-core/workflows/pr/badge.svg" />
  </a>
  <a href="https://david-dm.org/paritytech/txwrapper-core">
    <img alt="david-dm" src="https://img.shields.io/david/paritytech/txwrapper-core.svg" />
  </a>
</p>

<br /><br />

```bash
yarn add @substrate/txwrapper-substrate
```

In a JS/TS index file of package:

```typescript
import { methods as substrateMethods } from '@substrate/txwrapper-substrate';

// Export methods of substrate pallets included in the chain's runtime.
export const methods = {
    balances: substrateMethods.balances,
    utility: substrateMethods.utility,
    proxy: substrateMethods.proxy,
  };
```

Have a look at the [txwrapper creation guide for chain builders](../../CHAIN_BUILDER.md) to see more guidance on how to use this package in a chain specific txwrapper.