Class SigningRequest

Hierarchy

SigningRequest

Constructors

constructor

new SigningRequest(version: number, data: RequestDataV2 | RequestDataV3, zlib?: ZlibProvider, abiProvider?: AbiProvider, signature?: RequestSignature): SigningRequest
Create a new signing request. Normally not used directly, see the create and from class methods.
Parameters
- version: number
- data: RequestDataV2 | RequestDataV3
- Optional zlib: ZlibProvider
- Optional abiProvider: AbiProvider
- Optional signature: RequestSignature
Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:427

Properties

data

data: RequestDataV2 | RequestDataV3

The raw signing request data.

`Optional` signature

signature?: RequestSignature

The request signature.

version

version: number

The signing request version.

Methods

clone

clone(): SigningRequest
Return a deep copy of this request.

Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:538

encode

encode(compress?: boolean, slashes?: boolean, scheme?: string): string
Encode this request into an esr: uri.

Argument
compress Whether to compress the request data using zlib, defaults to true if omitted and zlib is present; otherwise false.

Argument
slashes Whether add slashes after the protocol scheme, i.e. esr://. Defaults to true.

Returns
An esr uri string.
Parameters
- Optional compress: boolean
- Optional slashes: boolean
- Optional scheme: string
Returns string
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:463

fetchAbis

fetchAbis(abiProvider?: AbiProvider): Promise<AbiMap>
Resolve required ABI definitions.
Parameters
- Optional abiProvider: AbiProvider
Returns Promise<AbiMap>
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:473

getChainId

getChainId(): ChainId
Get the id of the chain where this request is valid.

Returns
The 32-byte chain id as hex encoded string.

Returns ChainId
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:486

getChainIds

getChainIds(): null | ChainId[]
Chain IDs this request is valid for, only valid for multi chain requests. Value of null when isMultiChain is true denotes any chain.

Returns null | ChainId[]
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:490

getData

getData(): Uint8Array
Get the request data without header or signature.

Returns Uint8Array
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:465

getIdentity

getIdentity(): null | Name
Present if the request is an identity request and requests a specific account.

Note
This returns nil unless a specific identity has been requested, use isIdentity to check id requests.

Returns null | Name
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:512

getIdentityPermission

getIdentityPermission(): null | Name
Present if the request is an identity request and requests a specific permission.

Note
This returns nil unless a specific permission has been requested, use isIdentity to check id requests.

Returns null | Name
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:518

getIdentityScope

getIdentityScope(): null | Name
Present if the request is an identity request and requests a specific permission.

Note
This returns nil unless a specific permission has been requested, use isIdentity to check id requests.

Returns null | Name
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:524

getInfoKey

getInfoKey(key: string): string
Get a metadata key.
Parameters
- key: string
Returns string
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:534
getInfoKey<T>(key: string, type: T): InstanceType<T>
Type Parameters
- T extends ABISerializableConstructor
Parameters
- key: string
- type: T
Returns InstanceType<T>
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:535
getInfoKey(key: string, type: ABISerializableType): any
Parameters
- key: string
- type: ABISerializableType
Returns any
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:536

getRawActions

getRawActions(): Action[]
Return the actions in this request with action data encoded.

Returns Action[]
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:500

getRawInfo

getRawInfo(): {
[key: string]: Bytes;
}
Get raw info dict

Returns {
[key: string]: Bytes;
}
- [key: string]: Bytes
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:526

getRawInfoKey

getRawInfoKey(key: string): undefined | Bytes
Parameters
- key: string
Returns undefined | Bytes
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:529

getRawTransaction

getRawTransaction(): Transaction
Unresolved transaction.

Returns Transaction
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:502

getRequiredAbis

getRequiredAbis(): Name[]
ABI definitions required to resolve request.

Returns Name[]
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:469

getSignatureData

getSignatureData(): Uint8Array
Get signature data, returns an empty array if request is not signed.

Returns Uint8Array
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:467

getSignatureDigest

getSignatureDigest(): Checksum256
Get the signature digest for this request.

Returns Checksum256
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:436

isIdentity

isIdentity(): boolean
Whether the request is an identity request.

Returns boolean
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:504

isMultiChain

isMultiChain(): boolean
True if chainId is set to chain alias 0 which indicates that the request is valid for any chain.

Returns boolean
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:498

requiresTapos

requiresTapos(): boolean
Whether TaPoS values are required to resolve request.

Returns boolean
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:471

resolve

resolve(abis: AbiMap, signer: PermissionLevelType, ctx?: TransactionContext): ResolvedSigningRequest
Parameters
- abis: AbiMap
- signer: PermissionLevelType
- Optional ctx: TransactionContext
Returns ResolvedSigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:481

resolveActions

resolveActions(abis: AbiMap, signer?: PermissionLevelType): ResolvedAction[]
Decode raw actions actions to object representations.
Parameters
- abis: AbiMap
  
  ABI defenitions required to decode all actions.
- Optional signer: PermissionLevelType
  
  Placeholders in actions will be resolved to signer if set.
Returns ResolvedAction[]
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:479

resolveTransaction

resolveTransaction(abis: AbiMap, signer: PermissionLevelType, ctx?: TransactionContext): ResolvedTransaction
Parameters
- abis: AbiMap
- signer: PermissionLevelType
- Optional ctx: TransactionContext
Returns ResolvedTransaction
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:480

setBroadcast

setBroadcast(broadcast: boolean): void
Set broadcast flag.
Parameters
- broadcast: boolean
  
  Whether the transaction should be broadcast by receiver.
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:453

setCallback

setCallback(url: string, background: boolean): void
Set the request callback, mutating.
Parameters
- url: string
  
  Where the callback should be sent.
- background: boolean
  
  Whether the callback should be sent in the background.
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:448

setChainIds

setChainIds(ids: ChainIdType[]): void
Set chain IDs this request is valid for, only considered for multi chain requests.
Parameters
- ids: ChainIdType[]
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:494

setInfoKey

setInfoKey(key: string, object: ABISerializable, type?: ABISerializableType): void
Set a metadata key.
Parameters
- key: string
- object: ABISerializable
- Optional type: ABISerializableType
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:532

setRawInfoKey

setRawInfoKey(key: string, value: BytesType): void
Parameters
- key: string
- value: BytesType
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:530

setSignature

setSignature(signer: string, signature: string): void
Set the signature data for this request, mutating.
Parameters
- signer: string
  
  Account name of signer.
- signature: string
  
  The signature string.
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:442

shouldBroadcast

shouldBroadcast(): boolean
Whether the request should be broadcast by signer.

Returns boolean
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:506

sign

sign(signatureProvider: SignatureProvider): void
Sign the request, mutating.
Parameters
- signatureProvider: SignatureProvider
  
  The signature provider that provides a signature for the signer.
Returns void
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:432

toJSON

toJSON(): string
Returns string
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:540

toString

toString(): string
Returns string
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:539

`Static` create

create(args: SigningRequestCreateArguments, options?: SigningRequestEncodingOptions): Promise<SigningRequest>
Create a new signing request.
Parameters
- args: SigningRequestCreateArguments
- Optional options: SigningRequestEncodingOptions
Returns Promise<SigningRequest>
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:397

`Static` createSync

createSync(args: SigningRequestCreateArguments, options?: SigningRequestEncodingOptions, abis?: Record<string, ABIDef>): SigningRequest
Synchronously create a new signing request.

Throws
If an un-encoded action with no abi def is encountered.
Parameters
- args: SigningRequestCreateArguments
- Optional options: SigningRequestEncodingOptions
- Optional abis: Record<string, ABIDef>
Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:402

`Static` from

from(uri: string, options?: SigningRequestEncodingOptions): SigningRequest
Creates a signing request from encoded esr: uri string.
Parameters
- uri: string
- Optional options: SigningRequestEncodingOptions
Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:413

`Static` fromData

fromData(data: BytesType, options?: SigningRequestEncodingOptions): SigningRequest
Parameters
- data: BytesType
- Optional options: SigningRequestEncodingOptions
Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:414

`Static` fromTransaction

fromTransaction(chainId: ChainIdType, serializedTransaction: BytesType, options?: SigningRequestEncodingOptions): SigningRequest
Create a request from a chain id and serialized transaction.
Parameters
- chainId: ChainIdType
  
  The chain id where the transaction is valid.
- serializedTransaction: BytesType
  
  The serialized transaction.
- Optional options: SigningRequestEncodingOptions
  
  Creation options.
Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:411

`Static` identity

identity(args: SigningRequestCreateIdentityArguments, options?: SigningRequestEncodingOptions): SigningRequest
Creates an identity request.
Parameters
- args: SigningRequestCreateIdentityArguments
- Optional options: SigningRequestEncodingOptions
Returns SigningRequest
- Defined in node_modules/@wharfkit/signing-request/lib/signing-request.d.ts:404

Class SigningRequest

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

version: number

data: RequestDataV2 | RequestDataV3

Optional zlib: ZlibProvider

Optional abiProvider: AbiProvider

Optional signature: RequestSignature

Returns SigningRequest

Properties

data

Optional signature

version

Methods

clone

Returns SigningRequest

encode

Argument

Argument

Returns

Parameters

Optional compress: boolean

Optional slashes: boolean

Optional scheme: string

Returns string

fetchAbis

Parameters

Optional abiProvider: AbiProvider

Returns Promise<AbiMap>

getChainId

Returns

Returns ChainId

getChainIds

Returns null | ChainId[]

getData

Returns Uint8Array

getIdentity

Note

Returns null | Name

getIdentityPermission

Note

Returns null | Name

getIdentityScope

Note

Returns null | Name

getInfoKey

Parameters

key: string

Returns string

Type Parameters

T extends ABISerializableConstructor

Parameters

key: string

type: T

Returns InstanceType<T>

Parameters

key: string

type: ABISerializableType

Returns any

getRawActions

Returns Action[]

getRawInfo

Returns { [key: string]: Bytes; }

[key: string]: Bytes

getRawInfoKey

Parameters

key: string

Returns undefined | Bytes

getRawTransaction

Returns Transaction

getRequiredAbis

Returns Name[]

getSignatureData

Returns Uint8Array

`Optional` zlib: ZlibProvider

`Optional` abiProvider: AbiProvider

`Optional` signature: RequestSignature

`Optional` signature

`Optional` compress: boolean

`Optional` slashes: boolean

`Optional` scheme: string

`Optional` abiProvider: AbiProvider

Returns {
[key: string]: Bytes;
}

`Optional` ctx: TransactionContext

`Optional` signer: PermissionLevelType

`Optional` ctx: TransactionContext

`Optional` type: ABISerializableType

`Static` create

`Optional` options: SigningRequestEncodingOptions

`Static` createSync