@elacity-js/common
v1.1.1
Published
Common utilities used across Elacity JS SDK packages (shared primitives like auth helpers, pagination, and cross-package types).
Downloads
91
Readme
@elacity-js/common
Common utilities used across Elacity JS SDK packages (shared primitives like auth helpers, pagination, and cross-package types).
Chains
@elacity-js/common is the source of truth for SDK-supported chain IDs via the ChainId enum (used by both @elacity-js/api and @elacity-js/contracts).
import { ChainId } from '@elacity-js/common';
const chainId = ChainId.Base;Exports
This package exports:
Chain Support
ChainId: Enum of supported chain IDs (Base, Arbitrum Sepolia, Elastos) used consistently across SDKs.
Authentication
AuthUser: Authenticated user session shape (address, token, expiresIn, optional sa).AuthTokenStorage: Interface for persisting/loading/clearing auth sessions.MemoryTokenStorage: In-memory implementation ofAuthTokenStorage(suitable for server-side or temporary sessions).AuthSigner: Minimal interface for wallet signing (compatible with ethers.Signer and other wallet libraries).
Pagination
FilterPaginationInput: Standard pagination and sorting options (offset, limit, sortBy, searchBy).PaginatedResponse<T>: Standard paginated response shape (total, offset, limit, data).
Documentation
- https://docs.ela.city/sdks/common/
Contributing
If you want to contribute, the fastest way to get productive is to:
- Add/adjust functionality in
packages/common/src/lib/ - Run
nx test common(and add tests for new behavior) - Run
nx build commonto ensure it packages correctly
Please keep changes scoped to this package unless a cross-package change is required.
This library was generated with Nx.
Building
Run nx build common to build the library.
Running unit tests
Run nx test common to execute the unit tests via Jest.
