Releases: livepeer/ui-kit
Releases · livepeer/ui-kit
[email protected]
Patch Changes
-
#3
1c38dcdThanks @0xcadams! - Breaking: removed the term "LPMS" from the library and replaced a "LPMS Provider" with a "Livepeer Provider".See below for the API changes:
import { getL2Migrator, getLivepeerToken, getLivepeerTokenFaucet, - getLPMSProvider, + getLivepeerProvider, getMerkleSnapshot, getMinter, ... updateAsset, updateStream, - watchLPMSProvider, + watchLivepeerProvider, ... - GetLPMSProviderResult, - WatchLPMSProviderCallback, + GetLivepeerProviderResult, + WatchLivepeerProviderCallback, ... allChainId, - allLPMS, arbitrumOneAddress, arbitrumRinkebyAddress, ArbRetryableTxABI, BondingManagerABI, ControllerABI, - defaultLPMS, + defaultStudioApiKey, defaultTranscodingProfiles, InboxABI, L1BondingManagerABI, ... L2MigratorABI, LivepeerTokenABI, LivepeerTokenFaucetABI, + lpms, mainnetAddress, mainnetChainId, MerkleSnapshotABI, ... LivepeerAddress, LivepeerChain, LivepeerChainId, - LPMSName, + LivepeerProviderName, MainnetLivepeerChain, MainnetLivepeerChainId, TestnetLivepeerChain, ... L1Migrator, L2LPTGateway, L2Migrator, + LivepeerProvider, + LivepeerProviderConfig, LivepeerToken, LivepeerTokenFaucet, - LPMS, - LPMSProvider, MerkleSnapshot, Minter, ... } from "livepeer";
[email protected]
Minor Changes
-
ebd1587Thanks @0xcadams! - Thelivepeerpackage is now comprised of five main groups:- actions: functions to write/read from Livepeer Media Server (LPMS) providers and the Livepeer protocol smart contracts
- client: the singleton LPMS provider with persistence to local storage and global state management
- constants: constants for the Studio LPMS provider (and future providers) and protocol contract addresses/ABIs/chain IDs
- errors: custom errors for livepeer.js
- types: Typescript typings for the LPMS provider interface, Typechain-generated types for protocol contracts, and utility types
Actions
+ import { + createAsset, + createStream, + getAsset, + getBondingManager, + getContractAddressFromController, + getController, + getL1Migrator, + getL2Migrator, + getLivepeerToken, + getLivepeerTokenFaucet, + getLPMSProvider, + getMerkleSnapshot, + getMinter, + getPollCreator, + getRoundsManager, + getServiceRegistry, + getStream, + getStreamSession, + getStreamSessions, + getTicketBroker, + updateAsset, + updateStream, + watchLPMSProvider, + } from 'livepeer'; + + import type { + GetLPMSProviderResult, + WatchLPMSProviderCallback, + } from 'livepeer';
Client
+ import { Client, createClient } from 'livepeer'; + import type { ClientConfig } from 'livepeer';
Constants
+ import { + allChainId, + allLPMS, + arbitrumOneAddress, + arbitrumRinkebyAddress, + ArbRetryableTxABI, + BondingManagerABI, + ControllerABI, + defaultLPMS, + defaultTranscodingProfiles, + InboxABI, + L1BondingManagerABI, + L1MigratorABI, + L2LPTGatewayABI, + L2MigratorABI, + LivepeerTokenABI, + LivepeerTokenFaucetABI, + lpms, + mainnetAddress, + mainnetChainId, + MerkleSnapshotABI, + MinterABI, + NodeInterfaceABI, + PollABI, + PollCreatorABI, + rinkebyAddress, + RoundsManagerABI, + ServiceRegistryABI, + studio, + testnetChainId, + TicketBrokerABI, + } from 'livepeer'; + + import type { + L1Address, + L1LivepeerChain, + L1LivepeerChainId, + L2Address, + L2LivepeerChain, + L2LivepeerChainId, + LivepeerAddress, + LivepeerChain, + LivepeerChainId, + LPMSName, + MainnetLivepeerChain, + MainnetLivepeerChainId, + TestnetLivepeerChain, + TestnetLivepeerChainId, + } from 'livepeer';
Types
+ import { + ArbRetryableTxFactory, + BondingManagerFactory, + ControllerFactory, + InboxFactory, + L1BondingManagerFactory, + L1MigratorFactory, + L2LPTGatewayFactory, + L2MigratorFactory, + LivepeerTokenFactory, + LivepeerTokenFaucetFactory, + MerkleSnapshotFactory, + MinterFactory, + NodeInterfaceFactory, + PollCreatorFactory, + PollFactory, + RoundsManagerFactory, + ServiceRegistryFactory, + TicketBrokerFactory, + } from 'livepeer'; + + import type { + Address, + ArbRetryableTx, + Asset, + BondingManager, + Controller, + CreateAssetArgs, + CreateStreamArgs, + GetAssetArgs, + GetStreamArgs, + GetStreamSessionArgs, + GetStreamSessionsArgs, + Hash, + Inbox, + Ipfs, + L1BondingManager, + L1Migrator, + L2LPTGateway, + L2Migrator, + LivepeerToken, + LivepeerTokenFaucet, + LPMS, + LPMSProvider, + MerkleSnapshot, + Minter, + NodeInterface, + Poll, + PollCreator, + RoundsManager, + ServiceRegistry, + Stream, + StreamSession, + TicketBroker, + TranscodingProfile, + UpdateAssetArgs, + UpdateStreamArgs, + } from 'livepeer';
@livepeer/[email protected]
Patch Changes
-
#3
1c38dcdThanks @0xcadams! - Breaking: removed the term "LPMS" from the library and replaced a "LPMS Provider" with a "Livepeer Provider".See below for the API changes:
- const lpmsProvider = useLPMSProvider<TLPMSProvider>(); + const livepeerProvider = useLivepeerProvider<TLivepeerProvider>();
- import { StudioLPMSProvider, studioProvider } from 'livepeer/providers/studio'; + import { + StudioLivepeerProvider, + studioProvider, + } from 'livepeer/providers/studio';
-
Updated dependencies [
1c38dcd]:
@livepeer/[email protected]
Minor Changes
-
#1
6a8c1f5Thanks @0xcadams! - The@livepeer/reactpackage is now comprised of three main groups:- client: the React-specific LPMS provider wrapped with
react-queryfor query caching/persistence to storage - context: React Context for providing the client to React hooks
- hooks: functions to write/read from Livepeer Media Server (LPMS) providers and the Livepeer protocol smart contracts
Client
+ import { createReactClient } from '@livepeer/react'; + import type { CreateReactClientConfig } from '@livepeer/react';
Context
+ import { Context, LivepeerConfig, useClient } from '@livepeer/react'; + import type { LivepeerConfigProps } from '@livepeer/react';
Hooks
+ import { + useAsset, + useBondingManager, + useController, + useCreateAsset, + useCreateStream, + useL1Migrator, + useL2Migrator, + useLivepeerToken, + useLivepeerTokenFaucet, + useLPMSProvider, + useMerkleSnapshot, + useMinter, + usePollCreator, + useRoundsManager, + useServiceRegistry, + useStream, + useStreamSession, + useStreamSessions, + useTicketBroker, + useUpdateAsset, + useUpdateStream, + } from '@livepeer/react';
- client: the React-specific LPMS provider wrapped with
Patch Changes
- Updated dependencies [
ebd1587]: