Skip to main content

StarknetSigner

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

Starknet signer implementation wrapping a starknet.js Account, for browser based wallet use StarknetBrowserSigner

Extended by​

Implements​

Constructors​

Constructor​

new StarknetSigner(account): StarknetSigner;

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

Constructs a signer wrapping a starknet.js Account

Parameters​

ParameterTypeDescription
accountAccount

Returns​

StarknetSigner

Constructor​

new StarknetSigner(account, isManagingNoncesInternally?): StarknetSigner;

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

Parameters​

ParameterType
accountAccount
isManagingNoncesInternally?boolean

Returns​

StarknetSigner

Properties​

account​

readonly account: Account;

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


isManagingNoncesInternally​

readonly isManagingNoncesInternally: boolean;

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


type​

type: "AtomiqAbstractSigner";

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

Implementation of​

AbstractSigner.type

Methods​

getAddress()​

getAddress(): string;

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

Returns​

string

Inherit Doc​

Implementation of​

AbstractSigner.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>


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

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>


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>


sendDeployAccount()​

protected sendDeployAccount(tx): Promise<string>;

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

Parameters​

ParameterTypeDescription
txStarknetTxDeployAccount

Returns​

Promise<string>


sendInvoke()​

protected sendInvoke(tx): Promise<string>;

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

Parameters​

ParameterTypeDescription
txStarknetTxInvoke

Returns​

Promise<string>


signDeployAccount()​

protected signDeployAccount(tx): Promise<DeployAccountContractTransaction>;

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

Parameters​

ParameterTypeDescription
txStarknetTxDeployAccount

Returns​

Promise<DeployAccountContractTransaction>


signInvoke()​

protected signInvoke(tx): Promise<Invocation>;

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

Parameters​

ParameterTypeDescription
txStarknetTxInvoke

Returns​

Promise<Invocation>