Class UserClientBuilder

constructor

• new UserClientBuilder(
      options: BuilderOptions,
      previousRender?: ComputeBlocksResponse,
      previousPending?: AllPending,
  ): UserClientBuilder

  Parameters

  • options: BuilderOptions

    • OptionaluserClient?: UserClientOrClientAndNetwork

      User Client or object with a client and network
  • OptionalpreviousRender: ComputeBlocksResponse

    • blocks: Block[]

      Blocks which have been computed
  • previousPending: AllPending = []

  Returns UserClientBuilder

StaticisInstance

StaticPendingAccount

blocks

• get blocks(): Block[]

  Returns Block[]

defaultOptions

• get defaultOptions(): BuilderOptions

  Returns BuilderOptions

  • OptionaluserClient?: UserClientOrClientAndNetwork

    User Client or object with a client and network

rendered

• get rendered(): boolean

  Returns boolean

clone

• clone(): Promise<UserClientBuilder>

  Returns Promise<UserClientBuilder>

computeBlocks

• computeBlocks(): Promise<ComputeBlocksResponse>

  Returns Promise<ComputeBlocksResponse>

• computeBlocks(
      client?: UserClientOrClientAndNetwork,
  ): Promise<ComputeBlocksResponse>

  Parameters

  • Optionalclient: UserClientOrClientAndNetwork

  Returns Promise<ComputeBlocksResponse>

• computeBlocks(renderOptions: RenderOptions): Promise<ComputeBlocksResponse>

  Parameters

  • renderOptions: RenderOptions

  Returns Promise<ComputeBlocksResponse>

computeFeeBlock

• computeFeeBlock(
      staple: VoteStaple,
      options?: BuilderBlockOptions,
      renderOptions?: RenderOptions | UserClientOrClientAndNetwork,
  ): Promise<Block>

  Parameters

  • staple: VoteStaple
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  • OptionalrenderOptions: RenderOptions | UserClientOrClientAndNetwork

  Returns Promise<Block>

generateIdentifier

• generateIdentifier<CreateArguments extends MultiSigIdentifierCreateArguments>(
      toCreate: CreateArguments,
      options?: BuilderBlockOptions,
  ): PendingAccount<CreateArguments["type"]>

  Create a new identifier for the given arguments and add to the pending operations

  Type Parameters

  • CreateArguments extends MultiSigIdentifierCreateArguments

  Parameters

  • toCreate: CreateArguments

    The arguments used to create the identifier (ex: multisig configuration)
  • Optionaloptions: BuilderBlockOptions

    The options to use for the request

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns PendingAccount<CreateArguments["type"]>

  The identifier that was generated
• generateIdentifier<CreateKeyType extends NETWORK | TOKEN | STORAGE>(
      type: CreateKeyType,
      options?: BuilderBlockOptions,
  ): PendingAccount<CreateKeyType>

  Create a new identifier with the given type and add to the pending operations

  Type Parameters

  • CreateKeyType extends NETWORK | TOKEN | STORAGE

  Parameters

  • type: CreateKeyType

    The type of identifier to generate
  • Optionaloptions: BuilderBlockOptions

    The options to use for the request

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns PendingAccount<CreateKeyType>

  The identifier that was generated
• generateIdentifier(
      toCreate: NETWORK | TOKEN | STORAGE | MultiSigIdentifierCreateArguments,
      options?: BuilderBlockOptions,
  ): PendingAccount<NETWORK | TOKEN | STORAGE | MULTISIG>

  Create a new identifier and add to the pending operations

  Parameters

  • toCreate: NETWORK | TOKEN | STORAGE | MultiSigIdentifierCreateArguments

    The type of identifier or the arguments to create an identifier
  • Optionaloptions: BuilderBlockOptions

    The options to use for the request

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns PendingAccount<NETWORK | TOKEN | STORAGE | MULTISIG>

  The identifier that was generated

modifyCertificate

• modifyCertificate(
      method: ADD | SUBTRACT,
      certificate: Certificate,
      intermediateCertificates?: null | CertificateBundle,
      options?: BuilderBlockOptions,
  ): void

  Parameters

  • method: ADD | SUBTRACT
  • certificate: Certificate
  • intermediateCertificates: null | CertificateBundle = null
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

modifyTokenBalance

• modifyTokenBalance(
      token: TokenOrPending,
      amount: bigint,
      isSet?: boolean,
      options?: BuilderBlockOptions,
  ): void

  Parameters

  • token: TokenOrPending
  • amount: bigint
  • isSet: boolean = false
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

modifyTokenSupply

• modifyTokenSupply(amount: bigint, options?: BuilderBlockOptions): void

  Parameters

  • amount: bigint
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

pendingToJSON

• pendingToJSON(): AllPendingJSON

  Returns AllPendingJSON

  • nonRendered: [AccountSignerOptionsJSON, PendingOperationsJSON][]

    Blocks which have not been rendered

  • renderedBlocks: string[]

    Blocks which have been rendered

publish

• publish(
      options?: PublishOptions,
  ): Promise<
      | { from: "direct"; publish: boolean; voteStaple: VoteStaple }
      | { blocks: Block[]; from: "publish-aid"; publish: boolean },
  >

  Parameters

  • Optionaloptions: PublishOptions

  Returns Promise<
      | { from: "direct"; publish: boolean; voteStaple: VoteStaple }
      | { blocks: Block[]; from: "publish-aid"; publish: boolean },
  >

• publish(
      options?: PublishOptions,
      client?: UserClientOrClientAndNetwork,
  ): Promise<
      | { from: "direct"; publish: boolean; voteStaple: VoteStaple }
      | { blocks: Block[]; from: "publish-aid"; publish: boolean },
  >

  Parameters

  • Optionaloptions: PublishOptions
  • Optionalclient: UserClientOrClientAndNetwork

  Returns Promise<
      | { from: "direct"; publish: boolean; voteStaple: VoteStaple }
      | { blocks: Block[]; from: "publish-aid"; publish: boolean },
  >

receive

• receive(
      from: AccountOrPending,
      amount: bigint,
      token: TokenOrPending,
      exact?: boolean,
      forward?: GenericAccount,
      options?: BuilderBlockOptions,
  ): void

  Parameters

  • from: AccountOrPending
  • amount: bigint
  • token: TokenOrPending
  • exact: boolean = false
  • Optionalforward: GenericAccount
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

send

• send(
      recipient: AccountOrPending,
      amount: bigint,
      token: TokenOrPending,
      external?: string,
      options?: BuilderBlockOptions,
  ): void

  Parameters

  • recipient: AccountOrPending
  • amount: bigint
  • token: TokenOrPending
  • Optionalexternal: string
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

setInfo

• setInfo(info: AccountInfoWithoutAccount, options?: BuilderBlockOptions): void

  Parameters

  • info: AccountInfoWithoutAccount
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

setRep

• setRep(to: Account, options?: BuilderBlockOptions): void

  Parameters

  • to: Account
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

updateAccounts

• updateAccounts(accountOptions: Partial<AccountSignerOptions>): void

  Parameters

  • accountOptions: Partial<AccountSignerOptions>

  Returns void

updatePermissions

• updatePermissions(
      principal: GenericAccount,
      permissions: AcceptedPermissionTypes,
      target?: GenericAccount,
      method?: AdjustMethod,
      options?: BuilderBlockOptions,
  ): void

  Parameters

  • principal: GenericAccount
  • permissions: AcceptedPermissionTypes
  • Optionaltarget: GenericAccount
  • Optionalmethod: AdjustMethod
  • options: BuilderBlockOptions = {}

    • Optionalaccount?: GenericAccount

    • Optionalsigner?: Account<KeyPairKeyAlgorithm>

  Returns void

StaticFromPendingJSON

• FromPendingJSON(
      options: BuilderOptions,
      getPrivateKey: (acct: Account) => Promise<Account<KeyPairKeyAlgorithm>>,
      multiAllPending: AllPendingJSON[],
  ): Promise<UserClientBuilder>

  Parameters

  • options: BuilderOptions

    • OptionaluserClient?: UserClientOrClientAndNetwork

      User Client or object with a client and network
  • getPrivateKey: (acct: Account) => Promise<Account<KeyPairKeyAlgorithm>>
  • multiAllPending: AllPendingJSON[]

    • nonRendered: [AccountSignerOptionsJSON, PendingOperationsJSON][]

      Blocks which have not been rendered

    • renderedBlocks: string[]

      Blocks which have been rendered

  Returns Promise<UserClientBuilder>