Class ArcanaConnector

Hierarchy

Connector
- ArcanaConnector

Index

Constructors

constructor

Properties

chains id name options ready prefixed

Constructors

constructor

new ArcanaConnector(config): ArcanaConnector
Parameters
- config: {
      chains?: Chain[];
      options: {
          auth: AuthProvider;
          login?: LoginType;
      };
  }
  - Optional chains?: Chain[]
  - options: {
    auth: AuthProvider;
    login?: LoginType;
    }
    - auth: AuthProvider
    - Optional login?: LoginType
Returns ArcanaConnector
Overrides Connector.constructor
- Defined in src/connector.ts:54

Properties

`Readonly` chains

chains: Chain[]

Chains connector supports

`Readonly` id

id: "arcana" = "arcana"

`Readonly` name

name: "Arcana Auth" = "Arcana Auth"

`Readonly` options

options: any

Options to use with connector

ready

ready: boolean = !(typeof window === "undefined")

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event, fn, context?): ArcanaConnector
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]
      
      Returns void
- Optional context: any
Returns ArcanaConnector
Inherited from Connector.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(): Promise<Required<ConnectorData>>
Returns Promise<Required<ConnectorData>>
Overrides Connector.connect
- Defined in src/connector.ts:83

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Overrides Connector.disconnect
- Defined in src/connector.ts:219

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]
Returns boolean
Inherited from Connector.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof ConnectorEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof ConnectorEvents)[]
Inherited from Connector.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

getAccount

getAccount(): Promise<`0x${string}`>
Returns Promise<`0x${string}`>
Overrides Connector.getAccount
- Defined in src/connector.ts:193

getChainId

getChainId(): Promise<number>
Returns Promise<number>
Overrides Connector.getChainId
- Defined in src/connector.ts:224

getProvider

getProvider(): Promise<EthereumProvider>
Returns Promise<EthereumProvider>
Overrides Connector.getProvider
- Defined in src/connector.ts:211

getWalletClient

getWalletClient(config?): Promise<{
    account: Account;
    addChain: ((args) => Promise<void>);
    batch?: {
        multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; });
    };
    cacheTime: number;
    chain: Chain;
    deployContract: (<const TAbi, TChainOverride>(args) => Promise<`0x${string}`>);
    extend: (<const client>(fn) => Client<Transport, Chain, Account, WalletRpcSchema, ({ [K in keyof client]: client[K]; }) & WalletActions<Chain, Account>>);
    getAddresses: (() => Promise<GetAddressesReturnType>);
    getChainId: (() => Promise<number>);
    getPermissions: (() => Promise<GetPermissionsReturnType>);
    key: string;
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    request: EIP1193RequestFn<WalletRpcSchema>;
    requestAddresses: (() => Promise<RequestAddressesReturnType>);
    requestPermissions: ((args) => Promise<RequestPermissionsReturnType>);
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    sendTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
    signMessage: ((args) => Promise<`0x${string}`>);
    signTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
    signTypedData: (<const TTypedData, TPrimaryType>(args) => Promise<`0x${string}`>);
    switchChain: ((args) => Promise<void>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    watchAsset: ((args) => Promise<boolean>);
    writeContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<`0x${string}`>);
}>
Parameters
- config: {
  chainId?: number;
  } = {}
  - Optional chainId?: number
Returns Promise<{
    account: Account;
    addChain: ((args) => Promise<void>);
    batch?: {
        multicall?: boolean | ({ batchSize?: number | undefined; wait?: number | undefined; });
    };
    cacheTime: number;
    chain: Chain;
    deployContract: (<const TAbi, TChainOverride>(args) => Promise<`0x${string}`>);
    extend: (<const client>(fn) => Client<Transport, Chain, Account, WalletRpcSchema, ({ [K in keyof client]: client[K]; }) & WalletActions<Chain, Account>>);
    getAddresses: (() => Promise<GetAddressesReturnType>);
    getChainId: (() => Promise<number>);
    getPermissions: (() => Promise<GetPermissionsReturnType>);
    key: string;
    name: string;
    pollingInterval: number;
    prepareTransactionRequest: (<TChainOverride>(args) => Promise<PrepareTransactionRequestReturnType>);
    request: EIP1193RequestFn<WalletRpcSchema>;
    requestAddresses: (() => Promise<RequestAddressesReturnType>);
    requestPermissions: ((args) => Promise<RequestPermissionsReturnType>);
    sendRawTransaction: ((args) => Promise<`0x${string}`>);
    sendTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
    signMessage: ((args) => Promise<`0x${string}`>);
    signTransaction: (<TChainOverride>(args) => Promise<`0x${string}`>);
    signTypedData: (<const TTypedData, TPrimaryType>(args) => Promise<`0x${string}`>);
    switchChain: ((args) => Promise<void>);
    transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>;
    type: string;
    uid: string;
    watchAsset: ((args) => Promise<boolean>);
    writeContract: (<const TAbi, TFunctionName, TChainOverride>(args) => Promise<`0x${string}`>);
}>
Overrides Connector.getWalletClient
- Defined in src/connector.ts:183

isAuthorized

isAuthorized(): Promise<boolean>
Returns Promise<boolean>
Overrides Connector.isAuthorized
- Defined in src/connector.ts:201

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof ConnectorEvents
Returns number
Inherited from Connector.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from Connector.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): ArcanaConnector
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns ArcanaConnector
Inherited from Connector.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): ArcanaConnector
Add a listener for a given event.
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]
      
      Returns void
- Optional context: any
Returns ArcanaConnector
Inherited from Connector.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): ArcanaConnector
Add a one-time listener for a given event.
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]
      
      Returns void
- Optional context: any
Returns ArcanaConnector
Inherited from Connector.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): ArcanaConnector
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof ConnectorEvents
Returns ArcanaConnector
Inherited from Connector.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): ArcanaConnector
Remove the listeners of a given event.
Type Parameters
- T extends keyof ConnectorEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns ArcanaConnector
Inherited from Connector.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

setLogin

setLogin(val): void
Parameters
- val: LoginType
Returns void
- Defined in src/connector.ts:227

setStorage

setStorage(storage): void
Parameters
- storage: Storage
Returns void
Inherited from Connector.setStorage
- Defined in node_modules/@wagmi/connectors/dist/base-e6cfa360.d.ts:140

switchChain

switchChain(chainId): Promise<Chain>
Parameters
- chainId: number
Returns Promise<Chain>
Overrides Connector.switchChain
- Defined in src/connector.ts:132

`Optional` watchAsset

watchAsset(asset): Promise<boolean>
Parameters
- asset: {
      address: string;
      decimals?: number;
      image?: string;
      symbol: string;
  }
  - address: string
  - Optional decimals?: number
  - Optional image?: string
  - symbol: string
Returns Promise<boolean>
Inherited from Connector.watchAsset
- Defined in node_modules/@wagmi/connectors/dist/base-e6cfa360.d.ts:129

Class ArcanaConnector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: { chains?: Chain[]; options: { auth: AuthProvider; login?: LoginType; }; }

Optional chains?: Chain[]

options: { auth: AuthProvider; login?: LoginType; }

auth: AuthProvider

Optional login?: LoginType

Returns ArcanaConnector

Properties

Readonly chains

Readonly id

Readonly name

Readonly options

ready

Static prefixed

Methods

addListener

Type Parameters

T extends keyof ConnectorEvents

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

Returns void

Optional context: any

Returns ArcanaConnector

connect

Returns Promise<Required<ConnectorData>>

disconnect

Returns Promise<void>

emit

Type Parameters

T extends keyof ConnectorEvents

Parameters

event: T

Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

Returns boolean

eventNames

Returns (keyof ConnectorEvents)[]

getAccount

Returns Promise<`0x${string}`>

getChainId

Returns Promise<number>

getProvider

Returns Promise<EthereumProvider>

getWalletClient

Parameters

config: { chainId?: number; } = {}

Optional chainId?: number

isAuthorized

Returns Promise<boolean>

listenerCount

Parameters

event: keyof ConnectorEvents

Returns number

listeners

Type Parameters

T extends keyof ConnectorEvents

Parameters

event: T

Returns ((...args) => void)[]

off

Type Parameters

T extends keyof ConnectorEvents

Parameters

event: T

Optional fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

Returns void

Optional context: any

Optional once: boolean

config: {
chains?: Chain[];
options: {
auth: AuthProvider;
login?: LoginType;
};
}

`Optional` chains?: Chain[]

options: {
auth: AuthProvider;
login?: LoginType;
}

`Optional` login?: LoginType

`Readonly` chains

`Readonly` id

`Readonly` name

`Readonly` options

`Static` prefixed

`Rest` ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

config: {
chainId?: number;
} = {}

`Optional` chainId?: number

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

`Optional` context: any

`Optional` event: keyof ConnectorEvents

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<ConnectorEvents>[Extract<T, keyof ConnectorEvents>]

`Optional` context: any

`Optional` once: boolean

`Optional` watchAsset

asset: {
address: string;
decimals?: number;
image?: string;
symbol: string;
}

`Optional` decimals?: number

`Optional` image?: string