effect

const effect: object

Defined in: src/Wallet.ts:1406

Raw Effect APIs for advanced users.

Type Declaration

balanceTx()

balanceTx: (wallet, tx) => Effect<FinalizedTransaction, WalletError> = balanceTxEffect

Parameters

wallet

ConnectedAPI

tx

UnboundTransaction

Returns

Effect<FinalizedTransaction, WalletError>

close()

close: (walletContext) => Effect<void, WalletError> = closeEffect

Parameters

walletContext

WalletContext

Returns

Effect<void, WalletError>

connect()

connect: (networkId) => Effect<WalletConnection, WalletError> = connectEffect

Parameters

networkId

string = 'testnet'

Returns

Effect<WalletConnection, WalletError>

deriveAddress()

deriveAddress: (seed, networkId) => Effect<string, WalletError> = deriveAddressEffect

Parameters

seed

string

networkId

string

Returns

Effect<string, WalletError>

disconnect()

disconnect: () => Effect<void, never> = disconnectEffect

Returns

Effect<void, never>

fromBrowser()

fromBrowser: (networkId) => Effect<ConnectedWallet, WalletError> = fromBrowserEffect

Parameters

networkId

string = 'testnet'

Returns

Effect<ConnectedWallet, WalletError>

fromSeed()

fromSeed: (seed, networkConfig, options?) => Effect<ConnectedWallet, WalletError> = fromSeedEffect

Parameters

seed

string

getProvingProvider()

getProvingProvider: (wallet, zkConfigProvider) => Effect<ProvingProvider, WalletError> = getProvingProviderEffect

Parameters

wallet

ConnectedAPI

zkConfigProvider

KeyMaterialProvider

Returns

Effect<ProvingProvider, WalletError>

init()

init: (seed, networkConfig) => Effect<WalletContext, WalletError> = initEffect

Parameters

seed

string

networkConfig

NetworkConfig

Returns

Effect<WalletContext, WalletError>

isAvailable()

isAvailable: () => Effect<boolean, never> = isAvailableEffect

Returns

Effect<boolean, never>

providers

providers: object = providersEffect

submitTx()

submitTx: (wallet, tx) => Effect<string, WalletError> = submitTxEffect

Parameters

wallet

ConnectedAPI

tx

FinalizedTransaction

Returns

Effect<string, WalletError>

waitForSync()

waitForSync: (walletContext) => Effect<void, WalletError> = waitForSyncEffect

Parameters

walletContext

WalletContext

Returns

Effect<void, WalletError>

Since

0.2.0