@penumbrafi/registry 13.0.0

package/CHANGELOG.md

@@ -0,0 +1,366 @@
+# @penumbrafi/registry
+
+## 13.0.0
+
+### Major Changes
+
+- a72f006: Republish under the `@penumbrafi` scope and read the registry data from
+  `raw.githubusercontent.com/penumbrafi/registry/main/registry`.
+
+  The package was previously published as `@penumbra-labs/registry` and fetched
+  from `prax-wallet/registry`; both of those are unmaintained. Consumers should
+  change their dependency to `@penumbrafi/registry` — the API is unchanged.
+
+### Minor Changes
+
+- ecce49f: Add an optional `status` field to IBC connections. `Chain.status` is
+  `'active' | 'expired' | undefined` and records whether a connection can
+  currently carry a transfer; `'expired'` normally means the counterparty light
+  client has expired. Clients can use it to hide or disable a channel instead of
+  offering a withdrawal that will never arrive. The field is optional and purely
+  additive, so consumers that ignore it are unaffected.
+
+> Published as `@penumbra-labs/registry` up to and including 12.8.0.
+
+## 12.8.0
+
+### Minor Changes
+
+- Add an option to improve caching in NextJS environments.
+
+## 12.7.2
+
+### Patch Changes
+
+- Remove Simply Staking RPC for downtime
+
+## 12.7.1
+
+### Patch Changes
+
+- update channels for phobos-3 testnet
+
+## 12.7.0
+
+### Minor Changes
+
+- rpc: add radiant commons to registry
+
+## 12.6.1
+
+### Patch Changes
+
+- rename allETH, add dydx and injective
+
+## 12.6.0
+
+### Minor Changes
+
+- a4e903b: Add Phobos3 bundled registry
+
+## 12.5.1
+
+### Patch Changes
+
+- 0ca7bc4: Fix querying metadata by denom – should use `base` field instead of `denom`
+
+## 12.5.0
+
+### Minor Changes
+
+- dfad8cd: Allow querying metadata by asset's denom
+
+## 12.4.0
+
+### Minor Changes
+
+- bump registry and consume downstream deps
+
+## 12.3.0
+
+### Minor Changes
+
+- f1feced: update testnet channels and rpc providers list
+
+## 12.2.0
+
+### Minor Changes
+
+- 47cae42: update testnet channels and rpc providers list
+
+## 12.1.3
+
+### Patch Changes
+
+- 40cd591: rpc: remove binary builders from registry
+
+## 12.1.2
+
+### Patch Changes
+
+- fix protobuf pkg version
+
+## 12.1.1
+
+### Patch Changes
+
+- adds coingecko ids to assets
+
+## 12.1.0
+
+### Minor Changes
+
+- Add fallible tryGetMetadata method to registry
+- 4a563c9: Add priority scores
+
+## 12.0.1
+
+### Patch Changes
+
+- fb2bff8: add primary colors to all assets, add script for auto coloring
+- 6bcb0a9: add primary hex colors for all assets on all chains
+- a174c49: Add name and description fields to native Penumbra token in the registry
+- adb6ee2: add rc to registry's frontend list
+- a2db6c4: Updates the channels for penumbra testnet
+
+## 12.0.0
+
+### Major Changes
+
+- Forward compatible Metadata deserialization
+
+## 11.5.0
+
+### Minor Changes
+
+- Adding badge support for metadata
+
+## 11.3.1
+
+### Patch Changes
+
+- bundle phobos-2 registry, missing from v11.3.0
+
+## 11.3.0
+
+### Minor Changes
+
+- Bundling new phobos registries
+
+## 11.2.0
+
+### Minor Changes
+
+- c9bf54c: Updating testnet chain id fallback logic
+
+## 11.1.0
+
+### Minor Changes
+
+- Update to latest bundle
+
+## 11.0.0
+
+### Major Changes
+
+- 2a74e30: New frontends data structure w/ images
+
+### Patch Changes
+
+- b195bd3: Add support for local devnet chain IDs
+
+## 10.1.0
+
+### Minor Changes
+
+- add osmosis channel
+
+## 10.0.0
+
+### Major Changes
+
+- Expose remote fetching methods
+
+## 9.4.0
+
+### Minor Changes
+
+- Add penumbra-1 to registry list
+
+### Patch Changes
+
+- 779e2bc: Change validator name for Starling Cybernetics to "Starling Cybernetics"
+
+## 9.3.0
+
+### Minor Changes
+
+- Clear out rpcs & frontends
+
+## 9.2.0
+
+### Minor Changes
+
+- Save stakingAssetId as proto-compatible type
+
+## 9.1.1
+
+### Patch Changes
+
+- Fix testnet-preview parsing
+
+## 9.1.0
+
+### Minor Changes
+
+- b5726c2: Changed stakingAssetId type
+
+## 9.0.0
+
+### Major Changes
+
+- Add stakingAssetId to globals
+
+## 8.0.1
+
+### Patch Changes
+
+- Update testnet to new noble/osmosis ibc channels
+
+## 8.0.0
+
+### Major Changes
+
+- New API for global rpcs & frontends
+
+## 7.7.0
+
+### Minor Changes
+
+- Add frontends to registry
+
+## 7.6.0
+
+### Minor Changes
+
+- Add wtest_eth, test_sat, utest_atom, utest_osmo
+
+## 7.5.1
+
+### Patch Changes
+
+- Update noble/osmosis testnet channels
+
+## 7.5.0
+
+### Minor Changes
+
+- New gm/gn icons
+
+## 7.4.1
+
+### Patch Changes
+
+- Fix Penumbra Labs testnet validator denoms
+
+## 7.4.0
+
+### Minor Changes
+
+- Add Starling Staking delegation token metadata
+
+## 7.3.0
+
+### Minor Changes
+
+- Update noble channels
+
+## 7.2.2
+
+### Patch Changes
+
+- update osmosis channel for deimos-8
+
+## 7.2.1
+
+### Patch Changes
+
+- Update noble channelids
+
+## 7.2.0
+
+### Minor Changes
+
+- Fix deimos-8 exports
+
+## 7.1.0
+
+### Minor Changes
+
+- Support for deimos-8
+
+## 7.0.0
+
+### Major Changes
+
+- Bundle registry in dist
+
+## 6.0.0
+
+### Major Changes
+
+- Counterparty chain id added + renamed ibcChannel to channelId
+
+## 5.2.0
+
+### Minor Changes
+
+- Update to latest ibc channels
+
+## 5.1.0
+
+### Minor Changes
+
+- Get all assets
+
+## 5.0.0
+
+### Major Changes
+
+- New registry class
+
+## 4.1.0
+
+### Minor Changes
+
+- Added registry for testnet-preview
+
+## 4.0.0
+
+### Major Changes
+
+- Added stakingAssetId and numeraires
+
+## 3.0.0
+
+### Major Changes
+
+- Augmented and adapted ibc connections
+
+## 2.0.0
+
+### Major Changes
+
+- Expose more interfaces + change method name
+
+## 1.1.0
+
+### Minor Changes
+
+- Simplify registry to one fetch
+
+## 1.0.0
+
+### Major Changes
+
+- Initial publish

package/dist/index.d.ts

@@ -0,0 +1,152 @@
+import { AssetId } from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';
+import { Denom } from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';
+import { Metadata } from '@penumbra-zone/protobuf/penumbra/core/asset/v1/asset_pb';
+
+export declare type Base64AssetId = Stringified<AssetId['inner']>;
+
+declare class BundledClient {
+    get(chainId: string): Registry;
+    globals(): RegistryGlobals;
+}
+
+export declare interface Chain {
+    addressPrefix: string;
+    chainId: string;
+    channelId: string;
+    counterpartyChannelId: string;
+    images: Image_2[];
+    displayName: string;
+    /**
+     * Liveness of the connection as last observed on chain. `'expired'` means the
+     * channel cannot currently carry a transfer, usually because the counterparty
+     * light client has expired, and clients should hide or disable it. Absent when
+     * the connection has not been classified.
+     */
+    status?: ConnectionStatus;
+}
+
+export declare class ChainRegistryClient {
+    readonly bundled: BundledClient;
+    readonly remote: RemoteClient;
+    constructor(options?: RegistryOptions);
+}
+
+export declare type ConnectionStatus = 'active' | 'expired';
+
+declare interface DenomUnit {
+    denom: string;
+    exponent?: number;
+}
+
+export declare interface EntityMetadata {
+    name: string;
+    url: string;
+    images: Image_2[];
+}
+
+declare interface Image_2 {
+    png?: string;
+    svg?: string;
+}
+export { Image_2 as Image }
+
+declare interface Image_3 {
+    png?: string;
+    svg?: string;
+    theme?: {
+        primaryColorHex?: string;
+        circle?: boolean;
+        darkMode?: boolean;
+    };
+}
+
+export declare const isDenom: (value?: Denom | AssetId) => value is Denom;
+
+declare interface JsonGlobals {
+    rpcs: EntityMetadata[];
+    /** @deprecated use `frontendsV2` instead */
+    frontends: string[];
+    frontendsV2: EntityMetadata[];
+    stakingAssetId: {
+        inner: string;
+    };
+}
+
+declare interface JsonMetadata {
+    description?: string;
+    denomUnits: DenomUnit[];
+    base: string;
+    display: string;
+    name?: string;
+    symbol: string;
+    penumbraAssetId: PenumbraAssetId;
+    images?: Image_3[];
+    badges?: Image_3[];
+}
+
+declare interface JsonRegistry {
+    chainId: string;
+    ibcConnections: Chain[];
+    assetById: Record<Base64AssetId, JsonMetadata>;
+    numeraires: Base64AssetId[];
+}
+
+declare interface PenumbraAssetId {
+    inner: string;
+}
+
+export declare class Registry {
+    readonly chainId: string;
+    readonly ibcConnections: Chain[];
+    readonly numeraires: AssetId[];
+    private readonly assetById;
+    private readonly assetByDenom;
+    constructor(r: JsonRegistry);
+    private _resolveMetadata;
+    getMetadata(id: AssetId | Denom): Metadata;
+    tryGetMetadata(id: AssetId | Denom): Metadata | undefined;
+    getAllAssets(): Metadata[];
+    version(): Promise<string>;
+}
+
+declare class RegistryGlobals {
+    readonly stakingAssetId: AssetId;
+    readonly rpcs: EntityMetadata[];
+    readonly frontends: EntityMetadata[];
+    constructor(json: JsonGlobals);
+    version(): Promise<string>;
+}
+
+/** Options to configure the registry.
+ *
+ * In the browser, no tinkering should be needed.
+ *
+ * If you're using NextJS, you should consider adding the `nextjsServerSide` flag,
+ * when on the server.
+ */
+declare interface RegistryOptions {
+    /** If set, this code is running on the server side of a NextJS app.
+     *
+     * This information is useful, because NextJS overrides the behavior of the
+     * `fetch` API, which the registry uses to get an up-to-date remote registry.
+     *
+     * We want to cache these results, which `fetch` will do just fine in the browser.
+     * But, by default, NextJS will not cache anything, ever.
+     * By informing the registry that it's running in this environment, it can amend
+     * its fetching behavior accordingly.
+     */
+    nextjsServerSide?: boolean;
+}
+
+declare class RemoteClient {
+    private readonly bundled;
+    private readonly github;
+    constructor(bundled: BundledClient, options?: RegistryOptions);
+    get(chainId: string): Promise<Registry>;
+    getWithBundledBackup(chainId: string): Promise<Registry>;
+    globals(): Promise<RegistryGlobals>;
+}
+
+declare type Stringified<T> = string;
+
+export { }