Interface UPClientChannel interface UPClientChannel { element : null | HTMLIFrameElement ; id : string ; window : Window ; get allowedAccounts () : ` 0x ${ string } ` [] ; set allowedAccounts ( accounts : ` 0x ${ string } ` [] ) : void ; get chainId () : number ; set chainId ( chainId : number ) : void ; get contextAccounts () : ` 0x ${ string } ` [] ; set contextAccounts ( contextAccounts : ` 0x ${ string } ` [] ) : void ; get enable () : boolean ; set enable ( value : boolean ) : void ; get rpcUrls () : string [] ; set rpcUrls ( rpcUrls : string [] ) : void ; addListener < T extends keyof UPClientChannelEvents > ( event : T , fn : ( ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) => void , context ?: any , ) : this ; close () : void ; emit < T extends keyof UPClientChannelEvents > ( event : T , ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) : boolean ; eventNames () : (
keyof UPClientChannelEvents )
[] ; listenerCount ( event : keyof UPClientChannelEvents ) : number ; listeners < T extends keyof UPClientChannelEvents > ( event : T , ) : ( ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) => void [] ; off < T extends keyof UPClientChannelEvents > ( event : T , fn ?: ( ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) => void , context ?: any , once ?: boolean , ) : this ; on < T extends keyof UPClientChannelEvents > ( event : T , fn : ( ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) => void , context ?: any , ) : this ; once < T extends keyof UPClientChannelEvents > ( event : T , fn : ( ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) => void , context ?: any , ) : this ; removeAllListeners ( event ?: keyof UPClientChannelEvents
) : this ; removeListener < T extends keyof UPClientChannelEvents > ( event : T , fn ?: ( ... args : ArgumentMap < UPClientChannelEvents > [ Extract < T , keyof UPClientChannelEvents , > ] , ) => void , context ?: any , once ?: boolean , ) : this ; resume ( delay : number ) : void ; send ( method : string , params : unknown [] ) : Promise < void > ; setAllowedAccounts ( accounts : ` 0x ${ string } ` [] ) : Promise < void > ; setChainId ( chainId : number ) : Promise < void > ; setContextAccounts ( contextAccounts : ` 0x ${ string } ` [] ) : Promise < void > ; setEnable ( enable : boolean ) : Promise < void > ; setRpcUrls ( rpcUrls : string [] ) : Promise < void > ; setupChannel ( enable : boolean , accounts : ` 0x ${ string } ` [] , contextAccounts : ` 0x ${ string } ` [] , chainId : number , ) : Promise < void > ; } Readonlyelement element : null | HTMLIFrameElement
Readonlywindow window : Window
allowed get allowedAccounts () : ` 0x ${ string } ` [] Returns ` 0x ${ string } ` [] list of accounts
set allowedAccounts ( accounts : ` 0x ${ string } ` [] ) : void Parameters accounts : ` 0x ${ string } ` [] Returns void chain get chainId () : number Returns number chain id
set chainId ( chainId : number ) : void Returns void context get contextAccounts () : ` 0x ${ string } ` [] Returns ` 0x ${ string } ` [] list of addresses
set contextAccounts ( contextAccounts : ` 0x ${ string } ` [] ) : void Parameters contextAccounts : ` 0x ${ string } ` [] Returns void enable get enable () : boolean Returns boolean is channel enabled
set enable ( value : boolean ) : void Returns void close close () : void Returns void remove removeAllListeners ( event ?: keyof UPClientChannelEvents) : this Parameters Optionalevent : keyof UPClientChannelEventsReturns this resume resume ( delay : number ) : void Returns void send send ( method : string , params : unknown [] ) : Promise < void > Parameters method : string params : unknown [] Returns Promise < void > set setAllowedAccounts ( accounts : ` 0x ${ string } ` [] ) : Promise < void > Parameters accounts : ` 0x ${ string } ` [] Returns Promise < void > set setChainId ( chainId : number ) : Promise < void > Returns Promise < void > set setContextAccounts ( contextAccounts : ` 0x ${ string } ` [] ) : Promise < void > Parameters contextAccounts : ` 0x ${ string } ` [] Returns Promise < void > set setEnable ( enable : boolean ) : Promise < void > Returns Promise < void > set setRpcUrls ( rpcUrls : string [] ) : Promise < void > Returns Promise < void > setup setupChannel ( enable : boolean , accounts : ` 0x ${ string } ` [] , contextAccounts : ` 0x ${ string } ` [] , chainId : number , ) : Promise < void > Parameters enable : boolean accounts : ` 0x ${ string } ` [] contextAccounts : ` 0x ${ string } ` [] chainId : number Returns Promise < void >
API for client channel, each time an iframe's UPClientProvider is allocated and connected the UPProviderConnector will create and emit a new UPClientChannel. The UPClientChannel will have the API to control that channel. The configuration will default to values from the UPProviderConnector but enable will be false.