Class SigningRequest

constructor

• new SigningRequest(
      version: number,
      data: RequestDataV3 | RequestDataV2,
      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: RequestDataV3 | RequestDataV2
  • Optionalzlib: ZlibProvider
  • OptionalabiProvider: AbiProvider
  • Optionalsignature: RequestSignature

  Returns SigningRequest

data

Optionalsignature

version

clone

• clone(): SigningRequest

  Return a deep copy of this request.

  Returns SigningRequest

encode

• encode(compress?: boolean, slashes?: boolean, scheme?: string): string

  Encode this request into an esr: uri.

  Parameters

  • Optionalcompress: boolean
  • Optionalslashes: boolean
  • Optionalscheme: string

  Returns string

  An esr uri string.

  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.

fetchAbis

• fetchAbis(abiProvider?: AbiProvider): Promise<AbiMap>

  Resolve required ABI definitions.

  Parameters

  • OptionalabiProvider: AbiProvider

  Returns Promise<AbiMap>

getChainId

• getChainId(): ChainId

  Get the id of the chain where this request is valid.

  Returns ChainId

  The 32-byte chain id as hex encoded string.

getChainIds

• getChainIds(): ChainId[] | null

  Chain IDs this request is valid for, only valid for multi chain requests. Value of null when isMultiChain is true denotes any chain.

  Returns ChainId[] | null

getData

• getData(): Uint8Array

  Get the request data without header or signature.

  Returns Uint8Array

getIdentity

• getIdentity(): Name | null

  Present if the request is an identity request and requests a specific account.

  Returns Name | null

  Note

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

getIdentityPermission

• getIdentityPermission(): Name | null

  Present if the request is an identity request and requests a specific permission.

  Returns Name | null

  Note

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

getIdentityScope

• getIdentityScope(): Name | null

  Present if the request is an identity request and requests a specific permission.

  Returns Name | null

  Note

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

getInfoKey

• getInfoKey(key: string): string

  Get a metadata key.

  Parameters

  • key: string

  Returns string

• getInfoKey<T extends ABISerializableConstructor>(
      key: string,
      type: T,
  ): InstanceType<T>

  Get a metadata key.

  Type Parameters

  • T extends ABISerializableConstructor

  Parameters

  • key: string
  • type: T

  Returns InstanceType<T>

• getInfoKey(key: string, type: ABISerializableType): any

  Get a metadata key.

  Parameters

  • key: string
  • type: ABISerializableType

  Returns any

getRawActions

• getRawActions(): Action[]

  Return the actions in this request with action data encoded.

  Returns Action[]

getRawInfo

• getRawInfo(): { [key: string]: Bytes }

  Get raw info dict

  Returns { [key: string]: Bytes }

getRawInfoKey

• getRawInfoKey(key: string): Bytes | undefined

  Parameters

  • key: string

  Returns Bytes | undefined

getRawTransaction

• getRawTransaction(): Transaction

  Unresolved transaction.

  Returns Transaction

getRequiredAbis

• getRequiredAbis(): Name[]

  ABI definitions required to resolve request.

  Returns Name[]

getSignatureData

• getSignatureData(): Uint8Array

  Get signature data, returns an empty array if request is not signed.

  Returns Uint8Array

getSignatureDigest

• getSignatureDigest(): Checksum256

  Get the signature digest for this request.

  Returns Checksum256

isIdentity

• isIdentity(): boolean

  Whether the request is an identity request.

  Returns boolean

isMultiChain

• isMultiChain(): boolean

  True if chainId is set to chain alias 0 which indicates that the request is valid for any chain.

  Returns boolean

requiresTapos

• requiresTapos(): boolean

  Whether TaPoS values are required to resolve request.

  Returns boolean

resolve

• resolve(
      abis: AbiMap,
      signer: PermissionLevelType,
      ctx?: TransactionContext,
  ): ResolvedSigningRequest

  Parameters

  • abis: AbiMap
  • signer: PermissionLevelType
  • Optionalctx: TransactionContext

  Returns ResolvedSigningRequest

resolveActions

• resolveActions(abis: AbiMap, signer?: PermissionLevelType): ResolvedAction[]

  Decode raw actions actions to object representations.

  Parameters

  • abis: AbiMap

    ABI defenitions required to decode all actions.

  • Optionalsigner: PermissionLevelType

    Placeholders in actions will be resolved to signer if set.

  Returns ResolvedAction[]

resolveTransaction

• resolveTransaction(
      abis: AbiMap,
      signer: PermissionLevelType,
      ctx?: TransactionContext,
  ): ResolvedTransaction

  Parameters

  • abis: AbiMap
  • signer: PermissionLevelType
  • Optionalctx: TransactionContext

  Returns ResolvedTransaction

setBroadcast

• setBroadcast(broadcast: boolean): void

  Set broadcast flag.

  Parameters

  • broadcast: boolean

    Whether the transaction should be broadcast by receiver.

  Returns void

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

setChainIds

• setChainIds(ids: ChainIdType[]): void

  Set chain IDs this request is valid for, only considered for multi chain requests.

  Parameters

  • ids: ChainIdType[]

  Returns void

setInfoKey

• setInfoKey(
      key: string,
      object: ABISerializable,
      type?: ABISerializableType,
  ): void

  Set a metadata key.

  Parameters

  • key: string
  • object: ABISerializable
  • Optionaltype: ABISerializableType

  Returns void

setRawInfoKey

• setRawInfoKey(key: string, value: BytesType): void

  Parameters

  • key: string
  • value: BytesType

  Returns void

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

shouldBroadcast

• shouldBroadcast(): boolean

  Whether the request should be broadcast by signer.

  Returns boolean

sign

• sign(signatureProvider: SignatureProvider): void

  Sign the request, mutating.

  Parameters

  • signatureProvider: SignatureProvider

    The signature provider that provides a signature for the signer.

  Returns void

toJSON

• toJSON(): string

  Returns string

toString

• toString(): string

  Returns string

Staticcreate

• create(
      args: SigningRequestCreateArguments,
      options?: SigningRequestEncodingOptions,
  ): Promise<SigningRequest>

  Create a new signing request.

  Parameters

  • args: SigningRequestCreateArguments
  • Optionaloptions: SigningRequestEncodingOptions

  Returns Promise<SigningRequest>

StaticcreateSync

• createSync(
      args: SigningRequestCreateArguments,
      options?: SigningRequestEncodingOptions,
      abis?: Record<string, ABIDef>,
  ): SigningRequest

  Synchronously create a new signing request.

  Parameters

  • args: SigningRequestCreateArguments
  • Optionaloptions: SigningRequestEncodingOptions
  • Optionalabis: Record<string, ABIDef>

  Returns SigningRequest

  Throws

  If an un-encoded action with no abi def is encountered.

Staticfrom

• from(uri: string, options?: SigningRequestEncodingOptions): SigningRequest

  Creates a signing request from encoded esr: uri string.

  Parameters

  • uri: string
  • Optionaloptions: SigningRequestEncodingOptions

  Returns SigningRequest

StaticfromData

• fromData(
      data: BytesType,
      options?: SigningRequestEncodingOptions,
  ): SigningRequest

  Parameters

  • data: BytesType
  • Optionaloptions: SigningRequestEncodingOptions

  Returns SigningRequest

StaticfromTransaction

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

  • Optionaloptions: SigningRequestEncodingOptions

    Creation options.

  Returns SigningRequest

Staticidentity

• identity(
      args: SigningRequestCreateIdentityArguments,
      options?: SigningRequestEncodingOptions,
  ): SigningRequest

  Creates an identity request.

  Parameters

  • args: SigningRequestCreateIdentityArguments
  • Optionaloptions: SigningRequestEncodingOptions

  Returns SigningRequest