Skip to main content

StarknetBrowserSigner

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetBrowserSigner.ts:11

Browser-based Starknet signer, use with browser based signer accounts, this ensures that no signTransaction calls are made and only sendTransaction is supported!

Extends

Constructors

Constructor

new StarknetBrowserSigner(account, usesECDSADN?): StarknetBrowserSigner;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetBrowserSigner.ts:23

Parameters

ParameterTypeDescription
accountAccountSigner account to request signatures and send transaction through
usesECDSADN?booleanOptional flag indicating whether the signer supports signing using ECDSA-DN (deterministic nonce) algorithm, this allows the wallet to produce reproducible entropy. Only pass true here if you are 100% sure that the signer supports this!

Returns

StarknetBrowserSigner

Overrides

StarknetSigner.constructor

Properties

account

readonly account: Account;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:82

Inherited from

StarknetSigner.account


getReproducibleEntropy()?

optional getReproducibleEntropy: (appName) => Promise<Buffer<ArrayBufferLike>>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetBrowserSigner.ts:15

Parameters

ParameterType
appNamestring

Returns

Promise<Buffer<ArrayBufferLike>>


isManagingNoncesInternally

readonly isManagingNoncesInternally: boolean;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:81

Inherited from

StarknetSigner.isManagingNoncesInternally


type

type: "AtomiqAbstractSigner";

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:79

Inherited from

StarknetSigner.type

Methods

getAddress()

getAddress(): string;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:99

Returns

string

Inherit Doc

Inherited from

StarknetSigner.getAddress


getDeployPayload()

getDeployPayload(): Promise<any>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:187

Returns the payload for deploying the signer account's contract on Starknet

Returns

Promise<any>

Inherited from

StarknetSigner.getDeployPayload


getReproducibleEntropyMessage()

static getReproducibleEntropyMessage(starknetChainId, appName): object;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:49

Returns a SNIP-12 message to be signed for extracting reproducible entropy. Works when wallets use signing with deterministic nonce, such that signature over the same message always yields the same signature (same entropy).

Parameters

ParameterTypeDescription
starknetChainIdStarknetChainIdStarknet chain ID to use for the SNIP-12 message
appNamestringApplication name to differentiate reproducible entropy generated across different apps

Returns

object

NameTypeDefault valueDefined in
domainobject-atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:66
domain.chainIdany-atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:69
domain.namestringappNameatomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:67
domain.revisionstring'1'atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:70
domain.versionstring'1'atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:68
messageobject-atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:72
message.Messagestringmessageatomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:73
message.Warningstringwarningatomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:74
primaryTypestring'Message'atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:65
typesobject-atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:53
types.Messageobject[]-atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:60
types.StarknetDomainobject[]-atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:54

Inherited from

StarknetSigner.getReproducibleEntropyMessage


sendTransaction()

sendTransaction(tx, onBeforePublish?): Promise<string>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:152

Signs and sends the provided starknet transaction. Note that onBeforePublish is not really called before the tx is sent out in this default case, since this is not supported by the starknet web based wallets

Parameters

ParameterTypeDescription
txStarknetTxA transaction to sign and send
onBeforePublish?(txId, rawTx) => Promise<void>A callback called after the transaction has been sent

Returns

Promise<string>

Inherited from

StarknetSigner.sendTransaction


signTransaction()?

optional signTransaction(tx): Promise<StarknetTx>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:124

Signs the provided starknet transaction and returns its signed version

Parameters

ParameterTypeDescription
txStarknetTxA starknet transaction to sign

Returns

Promise<StarknetTx>

Inherited from

StarknetSigner.signTransaction


sendDeployAccount()

protected sendDeployAccount(tx): Promise<string>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:179

Parameters

ParameterTypeDescription
txStarknetTxDeployAccount

Returns

Promise<string>

Inherited from

StarknetSigner.sendDeployAccount


sendInvoke()

protected sendInvoke(tx): Promise<string>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:169

Parameters

ParameterTypeDescription
txStarknetTxInvoke

Returns

Promise<string>

Inherited from

StarknetSigner.sendInvoke


signDeployAccount()

protected signDeployAccount(tx): Promise<DeployAccountContractTransaction>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:141

Parameters

ParameterTypeDescription
txStarknetTxDeployAccount

Returns

Promise<DeployAccountContractTransaction>

Inherited from

StarknetSigner.signDeployAccount


signInvoke()

protected signInvoke(tx): Promise<Invocation>;

Defined in: atomiq-chain-starknet/src/starknet/wallet/StarknetSigner.ts:133

Parameters

ParameterTypeDescription
txStarknetTxInvoke

Returns

Promise<Invocation>

Inherited from

StarknetSigner.signInvoke