Class SuinsTransaction

constructor

• new SuinsTransaction(
      client: SuinsClient,
      transaction: Transaction,
  ): SuinsTransaction

  Parameters

  • client: SuinsClient
  • transaction: Transaction

  Returns SuinsTransaction

suinsClient

transaction

applyCoupon

• applyCoupon(
      intent: TransactionObjectArgument,
      couponCode: string,
  ): TransactionObjectArgument

  Applies a coupon to the payment intent.

  Parameters

  • intent: TransactionObjectArgument
  • couponCode: string

  Returns TransactionObjectArgument

applyDiscount

• applyDiscount(
      intent: TransactionObjectArgument,
      discountInfo: DiscountInfo,
  ): void

  Applies a discount to the payment intent.

  Parameters

  • intent: TransactionObjectArgument
  • discountInfo: DiscountInfo

  Returns void

burnExpired

• burnExpired(
      __namedParameters: { isSubname?: boolean; nft: TransactionObjectInput },
  ): void

  Burns an expired NFT to collect storage rebates.

  Parameters

  • __namedParameters: { isSubname?: boolean; nft: TransactionObjectInput }

  Returns void

calculatePrice

• calculatePrice(
      baseAmount: TransactionObjectArgument,
      paymentType: string,
      priceInfoObjectId: string,
  ): TransactionObjectArgument

  Parameters

  • baseAmount: TransactionObjectArgument
  • paymentType: string
  • priceInfoObjectId: string

  Returns TransactionObjectArgument

calculatePriceAfterDiscount

• calculatePriceAfterDiscount(
      paymentIntent: TransactionObjectArgument,
      paymentType: string,
  ): TransactionObjectArgument

  Parameters

  • paymentIntent: TransactionObjectArgument
  • paymentType: string

  Returns TransactionObjectArgument

createLeafSubName

• createLeafSubName(
      __namedParameters: {
          name: string;
          parentNft: TransactionObjectInput;
          targetAddress: string;
      },
  ): void

  Builds the PTB to create a leaf subdomain. Parent can be a SuinsRegistration or a SubDomainRegistration object. Can be passed in as an ID or a TransactionArgument.

  Parameters

  • __namedParameters: { name: string; parentNft: TransactionObjectInput; targetAddress: string }

  Returns void

createSubName

• createSubName(
      __namedParameters: {
          allowChildCreation: boolean;
          allowTimeExtension: boolean;
          expirationTimestampMs: number;
          name: string;
          parentNft: TransactionObjectInput;
      },
  ): TransactionResult

  Creates a subdomain.

  Parameters

  • __namedParameters: {
        allowChildCreation: boolean;
        allowTimeExtension: boolean;
        expirationTimestampMs: number;
        name: string;
        parentNft: TransactionObjectInput;
    }

  Returns TransactionResult

editSetup

• editSetup(
      __namedParameters: {
          allowChildCreation: boolean;
          allowTimeExtension: boolean;
          name: string;
          parentNft: TransactionObjectInput;
      },
  ): void

  Edits the setup of a subname.

  Parameters

  • __namedParameters: {
        allowChildCreation: boolean;
        allowTimeExtension: boolean;
        name: string;
        parentNft: TransactionObjectInput;
    }

  Returns void

extendExpiration

• extendExpiration(
      __namedParameters: {
          expirationTimestampMs: number;
          nft: TransactionObjectInput;
      },
  ): void

  Extends the expiration of a subname.

  Parameters

  • __namedParameters: { expirationTimestampMs: number; nft: TransactionObjectInput }

  Returns void

finalizeRegister

• finalizeRegister(receipt: TransactionObjectArgument): TransactionObjectArgument

  Parameters

  • receipt: TransactionObjectArgument

  Returns TransactionObjectArgument

finalizeRenew

• finalizeRenew(
      receipt: TransactionObjectArgument,
      nft: TransactionObjectInput,
  ): TransactionObjectArgument

  Parameters

  • receipt: TransactionObjectArgument
  • nft: TransactionObjectInput

  Returns TransactionObjectArgument

generateReceipt

• generateReceipt(params: ReceiptParams): TransactionObjectArgument

  Parameters

  • params: ReceiptParams

  Returns TransactionObjectArgument

handleBasePayment

• handleBasePayment(
      paymentIntent: TransactionObjectArgument,
      payment: TransactionObjectArgument,
      paymentType: string,
  ): TransactionObjectArgument

  Parameters

  • paymentIntent: TransactionObjectArgument
  • payment: TransactionObjectArgument
  • paymentType: string

  Returns TransactionObjectArgument

handlePayment

• handlePayment(
      paymentIntent: TransactionObjectArgument,
      payment: TransactionObjectArgument,
      paymentType: string,
      priceInfoObjectId: string,
      maxAmount?: bigint,
  ): TransactionObjectArgument

  Parameters

  • paymentIntent: TransactionObjectArgument
  • payment: TransactionObjectArgument
  • paymentType: string
  • priceInfoObjectId: string
  • maxAmount: bigint = MAX_U64

  Returns TransactionObjectArgument

initRegistration

• initRegistration(domain: string): TransactionObjectArgument

  Parameters

  • domain: string

  Returns TransactionObjectArgument

initRenewal

• initRenewal(
      nft: TransactionObjectInput,
      years: number,
  ): TransactionObjectArgument

  Parameters

  • nft: TransactionObjectInput
  • years: number

  Returns TransactionObjectArgument

register

• register(params: RegistrationParams): TransactionObjectArgument

  Registers a domain for a number of years.

  Parameters

  • params: RegistrationParams

  Returns TransactionObjectArgument

removeLeafSubName

• removeLeafSubName(
      __namedParameters: { name: string; parentNft: TransactionObjectInput },
  ): void

  Removes a leaf subname.

  Parameters

  • __namedParameters: { name: string; parentNft: TransactionObjectInput }

  Returns void

renew

• renew(params: RenewalParams): void

  Renews an NFT for a number of years.

  Parameters

  • params: RenewalParams

  Returns void

setDefault

• setDefault(name: string): void

  Sets a default name for the user.

  Parameters

  • name: string

  Returns void

setTargetAddress

• setTargetAddress(
      __namedParameters: {
          address?: string;
          isSubname?: boolean;
          nft: TransactionObjectInput;
      },
  ): void

  Sets the target address of an NFT.

  Parameters

  • __namedParameters: { address?: string; isSubname?: boolean; nft: TransactionObjectInput }

  Returns void

setUserData

• setUserData(
      __namedParameters: {
          isSubname?: boolean;
          key: string;
          nft: TransactionObjectInput;
          value: string;
      },
  ): void

  Sets the user data of an NFT.

  Parameters

  • __namedParameters: { isSubname?: boolean; key: string; nft: TransactionObjectInput; value: string }

  Returns void