DotwalletSigner
scrypt-ts / DotwalletSigner
Class: DotwalletSigner
a [signer][https://docs.scrypt.io/how-to-test-a-contract#signer](https://docs.scrypt.io/how-to-test-a-contract#signer) which implemented the protocol with the [dotwallet][https://www.dotwallet.com/en](https://www.dotwallet.com/en), and dapps can use to interact with the dotwallet.
Hierarchy
↳
DotwalletSigner
Table of contents
Constructors
Properties
Accessors
Methods
- connect
- getBalance
- getDefaultAddress
- getDefaultPubKey
- getNetwork
- getPubKey
- getSignatures
- isAuthenticated
- listUnspent
- requestAuth
- signAndsendTransaction
- signMessage
- signRawTransaction
- signTransaction
- isSigner
Constructors
constructor
• new DotwalletSigner(accessToken, provider)
Parameters
| Name | Type |
|---|---|
accessToken | string |
provider | Provider |
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:18
Properties
_address
• Private _address: any
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:13
_isSigner
• Readonly _isSigner: boolean
Inherited from
Defined in
dist/bsv/abstract-signer.d.ts:57
accessToken
• Private accessToken: any
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:12
default_public_key
• Private default_public_key: any
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:16
provider
• Optional provider: Provider
Inherited from
Defined in
dist/bsv/abstract-signer.d.ts:56
sender
• Private sender: any
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:15
state
• Private state: any
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:14
utxos_public_key
• Private utxos_public_key: any
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:17
DEBUG_TAG
▪ Static Readonly DEBUG_TAG: "DotwalletSigner"
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:11
Accessors
connectedProvider
• get connectedProvider(): Provider
Get the connected provider.
Throws
if no provider is connected to this.
Returns
the connected provider.
Inherited from
Signer.connectedProvider
Defined in
dist/bsv/abstract-signer.d.ts:133
Methods
connect
▸ connect(provider?): Promise<DotwalletSigner>
Connect a provider to this. If a new provider is specified when connecting,
a connection will be established for the new provider and then switched to the new provider.
If no new provider is specified, a connection is established for signer's built-in provider.
If neither exists, an exception is thrown.
Parameters
| Name | Type | Description |
|---|---|---|
provider? | Provider | The target provider. |
Returns
Promise<DotwalletSigner>
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:32
getBalance
▸ getBalance(address?): Promise<{ confirmed: number ; unconfirmed: number }>
Get the balance of BSVs in satoshis for an address.
Parameters
| Name | Type | Description |
|---|---|---|
address? | Address | The query address. |
Returns
Promise<{ confirmed: number ; unconfirmed: number }>
A promise which resolves to the address balance status.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:35
getDefaultAddress
▸ getDefaultAddress(): Promise<Address>
Returns
Promise<Address>
A promise which resolves to the address to the default private key of the signer.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:33
getDefaultPubKey
▸ getDefaultPubKey(): Promise<PublicKey>
Returns
Promise<PublicKey>
A promise which resolves to the public key of the default private key of the signer.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:39
getNetwork
▸ getNetwork(): Promise<Network>
Returns
Promise<Network>
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:34
getPubKey
▸ getPubKey(address): Promise<PublicKey>
Throws
If the private key for the address does not belong this signer.
Parameters
| Name | Type | Description |
|---|---|---|
address | Address | The request address, using the default address if omitted. |
Returns
Promise<PublicKey>
The public key result.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:40
getSignatures
▸ getSignatures(rawTxHex, sigRequests): Promise<SignatureResponse[]>
Get the requested transaction signatures for the raw transaction.
Parameters
| Name | Type | Description |
|---|---|---|
rawTxHex | string | The raw transaction hex to get signatures from. |
sigRequests | SignatureRequest[] | The signature requst informations, see details in SignatureRequest. |
Returns
Promise<SignatureResponse[]>
A promise which resolves to a list of SignatureReponse corresponding to sigRequests.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:44
isAuthenticated
▸ isAuthenticated(): Promise<boolean>
Check if the wallet has been authenticated
Returns
Promise<boolean>
true | false
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:23
listUnspent
▸ listUnspent(address, options?): Promise<IUnspentOutput[]>
Get a list of the P2PKH UTXOs.
Parameters
| Name | Type | Description |
|---|---|---|
address | Address | The address of the returned UTXOs belongs to. |
options? | UtxoQueryOptions | The optional query conditions, see details in UtxoQueryOptions. |
Returns
Promise<IUnspentOutput[]>
A promise which resolves to a list of UTXO for the query options.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:51
requestAuth
▸ requestAuth(): Promise<{ error: string ; isAuthenticated: boolean }>
Request wallet authentication
Returns
Promise<{ error: string ; isAuthenticated: boolean }>
A promise which resolves to if the wallet has been authenticated and the authenticate error message
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:28
signAndsendTransaction
▸ signAndsendTransaction(tx, options?): Promise<TransactionResponse>
Sign transaction and broadcast it
Parameters
| Name | Type | Description |
|---|---|---|
tx | Transaction | A transaction is signed and broadcast |
options? | SignTransactionOptions | The options for signing, see the details of SignTransactionOptions. |
Returns
Promise<TransactionResponse>
A promise which resolves to the transaction id.
Inherited from
Defined in
dist/bsv/abstract-signer.d.ts:140
signMessage
▸ signMessage(message, address?): Promise<string>
Sign a message string.
Parameters
| Name | Type | Description |
|---|---|---|
message | string | The message to be signed. |
address? | Address | The optional address whose private key will be used to sign message, using the default private key if omitted. |
Returns
Promise<string>
A promise which resolves to the signautre of the message.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:43
signRawTransaction
▸ signRawTransaction(rawTxHex, options): Promise<string>
Sign a raw transaction hex string.
Throws
If any input of the transaction can not be signed properly.
Parameters
| Name | Type | Description |
|---|---|---|
rawTxHex | string | The raw transaction hex to sign. |
options | SignTransactionOptions | The options for signing, see the details of SignTransactionOptions. |
Returns
Promise<string>
A promise which resolves to the signed transaction hex string.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:41
signTransaction
▸ signTransaction(tx, options?): Promise<Transaction>
Sign a transaction object.
Parameters
| Name | Type | Description |
|---|---|---|
tx | Transaction | The transaction object to sign. |
options? | SignTransactionOptions | The options for signing, see the details of SignTransactionOptions. |
Returns
Promise<Transaction>
A promise which resolves to the signed transaction object.
Overrides
Defined in
dist/bsv/signers/dotwallet-signer.d.ts:42
isSigner
▸ Static isSigner(value): value is Signer
Check if an object is a Signer
Parameters
| Name | Type | Description |
|---|---|---|
value | any | The target object |
Returns
value is Signer
Returns true if and only if object is a Provider.
Inherited from
Defined in
dist/bsv/abstract-signer.d.ts:162