@aeternity/aepp-sdk 13.3.3 → 14.1.0

package/es/aens.d.ts

@@ -6,188 +6,167 @@
  * repository.
  */
 import BigNumber from 'bignumber.js';
-import { Tag, AensName } from './tx/builder/constants';
-import { Encoded, Encoding } from './utils/encoder';
-import { getName } from './chain';
-import { sendTransaction, SendTransactionOptions } from './send-transaction';
-import { BuildTxOptions } from './tx/builder';
-import { TransformNodeType } from './Node';
-import { NameEntry, NamePointer } from './apis/node';
-import AccountBase from './account/Base';
-import { AddressEncodings } from './tx/builder/field-types/address';
+import { Tag, AensName } from './tx/builder/constants.js';
+import { Encoded, Encoding } from './utils/encoder.js';
+import { sendTransaction, SendTransactionOptions } from './send-transaction.js';
+import { Optional } from './utils/other.js';
+import { BuildTxOptions } from './tx/builder/index.js';
+import Node from './Node.js';
+import AccountBase from './account/Base.js';
+import { AddressEncodings } from './tx/builder/field-types/address.js';
+interface NameRevokeOptions extends BuildTxOptions<Tag.NameRevokeTx, 'nameId' | 'accountId'>, Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {
+}
 interface KeyPointers {
     [key: string]: Encoded.Generic<AddressEncodings | Encoding.Bytearray>;
 }
-/**
- * Revoke a name
- * @category AENS
- * @param name - Name hash
- * @param options - Options
- * @returns Transaction result
- * @example
- * ```js
- * const name = 'test.chain'
- * const nameObject = await sdkInstance.aensQuery(name)
- *
- * await sdkInstance.aensRevoke(name, { fee, ttl , nonce })
- * // or
- * await nameObject.revoke({ fee, ttl, nonce })
- * ```
- */
-export declare function aensRevoke(name: AensName, options: AensRevokeOptions): ReturnType<typeof sendTransaction>;
-interface AensRevokeOptions extends BuildTxOptions<Tag.NameRevokeTx, 'nameId' | 'accountId' | 'onNode'>, SendTransactionOptions {
-}
-/**
- * Update a name
- * @category AENS
- * @param name - AENS name
- * @param pointers - Map of pointer keys to corresponding addresses
- * @param options - Options
- * @throws Invalid pointer array error
- * @example
- * ```js
- * const name = 'test.chain'
- * const pointersArray = ['ak_asd23dasdas...,' 'ct_asdf34fasdasd...']
- * const nameObject = await sdkInstance.aensQuery(name)
- *
- * await sdkInstance.aensUpdate(name, pointersArray, { nameTtl, ttl, fee, nonce, clientTtl })
- * // or
- * await nameObject.update(pointers, { nameTtl, ttl, fee, nonce, clientTtl })
- * ```
- */
-export declare function aensUpdate(name: AensName, pointers: KeyPointers, { extendPointers, ...options }: AensUpdateOptions): ReturnType<typeof sendTransaction>;
-interface AensUpdateOptions extends BuildTxOptions<Tag.NameUpdateTx, 'nameId' | 'accountId' | 'pointers' | 'clientTtl' | 'nameTtl' | 'onNode'>, SendTransactionOptions {
+interface NameUpdateOptions extends BuildTxOptions<Tag.NameUpdateTx, 'nameId' | 'accountId' | 'pointers'>, Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {
     /**
      * Get the pointers from the node and merge with provided ones. Pointers with the same key will be
      * overwritten.
      */
     extendPointers?: boolean;
-    /**
-     * a suggestion as to how long any clients should cache this information
-     */
-    clientTtl?: number;
-    /**
-     * Name ttl represented in number of blocks (Max value is 50000 blocks)
-     */
-    nameTtl?: number;
 }
-/**
- * Transfer a domain to another account
- * @category AENS
- * @param name - AENS name
- * @param account - Recipient account publick key
- * @param options - Options
- * @returns Transaction result
- * @example
- * ```js
- * const name = 'test.chain'
- * const recipientPub = 'ak_asd23dasdas...'
- * const nameObject = await sdkInstance.aensQuery(name)
- *
- * await sdkInstance.aensTransfer(name, recipientPub, { ttl, fee, nonce })
- * // or
- * await nameObject.transfer(recipientPub, { ttl, fee, nonce })
- * ```
- */
-export declare function aensTransfer(name: AensName, account: Encoded.AccountAddress, options: AensTransferOptions): ReturnType<typeof sendTransaction>;
-interface AensTransferOptions extends BuildTxOptions<Tag.NameTransferTx, 'nameId' | 'accountId' | 'recipientId' | 'onNode'>, SendTransactionOptions {
+interface NameTransferOptions extends BuildTxOptions<Tag.NameTransferTx, 'nameId' | 'accountId' | 'recipientId'>, Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {
 }
-/**
- * Query the AENS name info from the node
- * and return the object with info and predefined functions for manipulating name
- * @category AENS
- * @param name - AENS name
- * @param opt - Options
- * @example
- * ```js
- * const nameObject = sdkInstance.aensQuery('test.chain')
- * console.log(nameObject)
- * {
- *  id, // name hash
- *  pointers, // array of pointers
- *  update, // Update name function
- *  extendTtl, // Extend Ttl name function
- *  transfer, // Transfer name function
- *  revoke // Revoke name function
- * }
- * ```
- */
-export declare function aensQuery(name: AensName, opt: Parameters<typeof getName>[1] & Parameters<typeof aensUpdate>[2] & Parameters<typeof aensTransfer>[2]): Promise<Readonly<TransformNodeType<NameEntry> & {
-    id: Encoded.Name;
-    owner: Encoded.AccountAddress;
-    pointers: KeyPointers | NamePointer[];
-    ttl: number;
-    update: (pointers: KeyPointers, options?: Omit<Parameters<typeof aensQuery>[1], 'onNode' | 'onCompiler' | 'onAccount'> & {
-        onAccount?: AccountBase;
-    }) => ReturnType<typeof aensUpdate> & ReturnType<typeof aensQuery>;
-    transfer: (account: Encoded.AccountAddress, options?: Parameters<typeof aensQuery>[1]) => ReturnType<typeof aensUpdate> & ReturnType<typeof aensQuery>;
-    revoke: (options?: Omit<Parameters<typeof aensRevoke>[1], 'onNode' | 'onCompiler' | 'onAccount'> & {
-        onAccount?: AccountBase;
-    }) => ReturnType<typeof aensRevoke>;
-    extendTtl: (nameTtl?: number, options?: Omit<Parameters<typeof aensQuery>[1], 'onNode' | 'onCompiler' | 'onAccount'>) => ReturnType<typeof aensUpdate> & ReturnType<typeof aensQuery>;
-}>>;
-/**
- * Claim a previously preclaimed registration. This can only be done after the
- * preclaim step
- * @category AENS
- * @param name - AENS name
- * @param salt - Salt from pre-claim, or 0 if it's a bid or claiming without preclaim (in Ceres)
- * @param options - options
- * @returns Transaction result
- * @example
- * ```js
- * const name = 'test.chain'
- * const salt = preclaimResult.salt // salt from pre-claim transaction
- *
- * await sdkInstance.aensClaim(name, salt, { ttl, fee, nonce, nameFee })
- * ```
- */
-export declare function aensClaim(name: AensName, salt: number, options: AensClaimOptions): Promise<AensClaimReturnType>;
-type AensClaimOptionsType = BuildTxOptions<Tag.NameClaimTx, 'accountId' | 'nameSalt' | 'name'> & SendTransactionOptions & Parameters<typeof aensQuery>[1];
-interface AensClaimOptions extends AensClaimOptionsType {
+interface NamePreclaimOptions extends BuildTxOptions<Tag.NamePreclaimTx, 'accountId' | 'commitmentId'>, Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {
 }
-interface AensClaimReturnType extends Awaited<ReturnType<typeof sendTransaction>>, Partial<Awaited<ReturnType<typeof aensQuery>>> {
+interface NameClaimOptions extends BuildTxOptions<Tag.NameClaimTx, 'accountId' | 'name'>, Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {
 }
 /**
- * Preclaim a name. Sends a hash of the name and a random salt to the node
  * @category AENS
- * @param name - AENS name
- * @param options - Options
  * @example
  * ```js
- * const name = 'test.chain'
- * const salt = preclaimResult.salt // salt from pre-claim transaction
- *
- * await sdkInstance.aensPreclaim(name, { ttl, fee, nonce })
- * {
- *   ...transactionResult,
- *   claim, // Claim function (options={}) => claimTransactionResult
- *   salt,
- *   commitmentId
- * }
+ * const name = new Name('test.chain', aeSdk.getContext())
  * ```
  */
-export declare function aensPreclaim(name: AensName, options: AensPreclaimOptions): Promise<Readonly<Awaited<ReturnType<typeof sendTransaction>> & {
-    salt: number;
-    commitmentId: string;
-    claim: (opts?: Parameters<typeof aensClaim>[2]) => ReturnType<typeof aensClaim>;
-}>>;
-interface AensPreclaimOptions extends BuildTxOptions<Tag.NamePreclaimTx, 'accountId' | 'commitmentId' | 'onNode'>, SendTransactionOptions, Omit<AensClaimOptions, 'version'> {
+export default class Name {
+    #private;
+    readonly value: AensName;
+    options: {
+        onNode: Node;
+        onAccount: AccountBase;
+    } & Omit<NameRevokeOptions & NameUpdateOptions & NameTransferOptions & NamePreclaimOptions & NameClaimOptions, 'version'>;
+    /**
+     * @param value - AENS name
+     * @param options - Options
+     * @param options.onNode - Node to use
+     * @param options.onAccount - Account to use
+     */
+    constructor(value: AensName, options: {
+        onNode: Node;
+        onAccount: AccountBase;
+    } & Omit<NameRevokeOptions & NameUpdateOptions & NameTransferOptions & NamePreclaimOptions & NameClaimOptions, 'version'>);
+    /**
+     * Name ID encoded as nm_-prefixed string
+     */
+    get id(): Encoded.Name;
+    /**
+     * Revoke a name
+     * @param options - Options
+     * @returns mined transaction details
+     * @example
+     * ```js
+     * await name.revoke({ fee, ttl, nonce })
+     * ```
+     */
+    revoke(options?: NameRevokeOptions): ReturnType<typeof sendTransaction>;
+    /**
+     * Update a name
+     * @param pointers - Map of pointer keys to corresponding addresses
+     * @param options - Options
+     * @example
+     * ```js
+     * const name = 'test.chain'
+     * const channel = 'ch_2519mBs...'
+     * const pointers = {
+     *   account_pubkey: 'ak_asd23dasdas...,',
+     *   contract_pubkey: 'ct_asdf34fasdasd...',
+     *   [getDefaultPointerKey(channel)]: channel,
+     * }
+     * await name.update(pointers, { nameTtl, ttl, fee, nonce, clientTtl })
+     * ```
+     */
+    update(pointers: KeyPointers, options?: NameUpdateOptions): ReturnType<typeof sendTransaction>;
+    /**
+     * Transfer a name to another account
+     * @param address - Recipient account public key
+     * @param options - Options
+     * @returns mined transaction details
+     * @example
+     * ```js
+     * await name.transfer('ak_asd23dasdas...', { ttl, fee, nonce })
+     * ```
+     */
+    transfer(address: Encoded.AccountAddress, options?: NameTransferOptions): ReturnType<typeof sendTransaction>;
+    /**
+     * Query the AENS name info from the node and return the object with info
+     * @param options - Options
+     * @example
+     * ```js
+     * const nameEntry = await name.getState()
+     * console.log(nameEntry.owner)
+     * ```
+     */
+    getState(options?: {
+        onNode?: Node;
+    }): Promise<Awaited<ReturnType<Node['getNameEntryByName']>> & {
+        id: Encoded.Name;
+        owner: Encoded.AccountAddress;
+    }>;
+    /**
+     * Query the AENS auction info from the node and return the object with info
+     * @param options - Options
+     * @example
+     * ```js
+     * const auctionEntry = await name.getAuctionState()
+     * console.log(auctionEntry.highestBidder)
+     * ```
+     */
+    getAuctionState(options?: {
+        onNode?: Node;
+    }): Promise<Awaited<ReturnType<Node['getAuctionEntryByName']>> & {
+        id: Encoded.Name;
+        highestBidder: Encoded.AccountAddress;
+    }>;
+    /**
+     *
+     * @param nameTtl - represents in number of blocks (max and default is 180000)
+     * @param options - Options
+     * @returns mined transaction details
+     */
+    extendTtl(nameTtl?: number, options?: Omit<Parameters<Name['update']>[1], 'extendPointers' | 'nameTtl'>): ReturnType<Name['update']>;
+    /**
+     * Claim a previously preclaimed registration. This can only be done after the preclaim step
+     * @param options - options
+     * @returns mined transaction details
+     * @example
+     * ```js
+     * await name.claim({ ttl, fee, nonce, nameFee })
+     * ```
+     */
+    claim(options?: NameClaimOptions): ReturnType<typeof sendTransaction>;
+    /**
+     * Preclaim a name. Sends a hash of the name and a random salt to the node
+     * @param options - Options
+     * @example
+     * ```js
+     * await name.preclaim({ ttl, fee, nonce })
+     * ```
+     */
+    preclaim(options?: NamePreclaimOptions): Promise<Awaited<ReturnType<typeof sendTransaction>> & {
+        nameSalt: number;
+    }>;
+    /**
+     * Bid to name auction
+     * @param nameFee - Name fee (bid fee)
+     * @param options - Options
+     * @returns mined transaction details
+     * @example
+     * ```js
+     * const bidFee = computeBidFee(name.value, { startFee, increment: 0.42 })
+     * await name.bid(213109412839123, { ttl, fee, nonce })
+     * ```
+     */
+    bid(nameFee: number | string | BigNumber, options?: Omit<NameClaimOptions, 'nameFee'>): ReturnType<typeof sendTransaction>;
 }
-/**
- * Bid to name auction
- * @category AENS
- * @param name - Domain name
- * @param nameFee - Name fee (bid fee)
- * @param options - Options
- * @returns Transaction result
- * @example
- * ```js
- * const name = 'test.chain'
- * const bidFee = computeBidFee(name, { startFee, increment: 0.42 })
- *
- * await sdkInstance.aensBid(name, 213109412839123, { ttl, fee, nonce })
- * ```
- */
-export declare function aensBid(name: AensName, nameFee: number | string | BigNumber, options: Omit<Parameters<typeof aensClaim>[2], 'nameFee'>): ReturnType<typeof aensClaim>;
 export {};

package/es/aens.js

@@ -0,0 +1,292 @@
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+/**
+ * Aens methods - routines to interact with the æternity naming system
+ *
+ * The high-level description of the naming system is
+ * https://github.com/aeternity/protocol/blob/master/AENS.md in the protocol
+ * repository.
+ */
+
+import { genSalt, isEncoded } from './utils/crypto.js';
+import { commitmentHash, isAuctionName, produceNameId } from './tx/builder/helpers.js';
+import { Tag } from './tx/builder/constants.js';
+import { Encoding } from './utils/encoder.js';
+import { LogicError } from './utils/errors.js';
+import { sendTransaction } from './send-transaction.js';
+import { buildTxAsync } from './tx/builder/index.js';
+class NotAuctionNameError extends LogicError {
+  constructor(name, action) {
+    super(`Can't ${action} because ${name} is not an auction name`);
+    this.name = 'NotAuctionNameError';
+  }
+}
+
+/**
+ * @category AENS
+ * @example
+ * ```js
+ * const name = new Name('test.chain', aeSdk.getContext())
+ * ```
+ */
+var _salt = /*#__PURE__*/new WeakMap();
+export default class Name {
+  /**
+   * @param value - AENS name
+   * @param options - Options
+   * @param options.onNode - Node to use
+   * @param options.onAccount - Account to use
+   */
+  constructor(value, options) {
+    _classPrivateFieldInitSpec(this, _salt, void 0);
+    this.value = value;
+    this.options = options;
+    this.options = options;
+  }
+
+  /**
+   * Name ID encoded as nm_-prefixed string
+   */
+  get id() {
+    return produceNameId(this.value);
+  }
+
+  /**
+   * Revoke a name
+   * @param options - Options
+   * @returns mined transaction details
+   * @example
+   * ```js
+   * await name.revoke({ fee, ttl, nonce })
+   * ```
+   */
+  async revoke(options = {}) {
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const tx = await buildTxAsync({
+      _isInternalBuild: true,
+      ...opt,
+      tag: Tag.NameRevokeTx,
+      nameId: this.value,
+      accountId: opt.onAccount.address
+    });
+    return sendTransaction(tx, opt);
+  }
+
+  /**
+   * Update a name
+   * @param pointers - Map of pointer keys to corresponding addresses
+   * @param options - Options
+   * @example
+   * ```js
+   * const name = 'test.chain'
+   * const channel = 'ch_2519mBs...'
+   * const pointers = {
+   *   account_pubkey: 'ak_asd23dasdas...,',
+   *   contract_pubkey: 'ct_asdf34fasdasd...',
+   *   [getDefaultPointerKey(channel)]: channel,
+   * }
+   * await name.update(pointers, { nameTtl, ttl, fee, nonce, clientTtl })
+   * ```
+   */
+  async update(pointers, options = {}) {
+    const {
+      extendPointers,
+      ...opt
+    } = {
+      ...this.options,
+      ...options
+    };
+    const allPointers = {
+      ...(extendPointers === true && Object.fromEntries((await opt.onNode.getNameEntryByName(this.value)).pointers.map(({
+        key,
+        id
+      }) => [key, id]))),
+      ...pointers
+    };
+    const hasRawPointers = Object.values(allPointers).some(v => isEncoded(v, Encoding.Bytearray));
+    const tx = await buildTxAsync({
+      _isInternalBuild: true,
+      ...opt,
+      tag: Tag.NameUpdateTx,
+      version: hasRawPointers ? 2 : 1,
+      nameId: this.value,
+      accountId: opt.onAccount.address,
+      pointers: Object.entries(allPointers).map(([key, id]) => ({
+        key,
+        id
+      }))
+    });
+    return sendTransaction(tx, opt);
+  }
+
+  /**
+   * Transfer a name to another account
+   * @param address - Recipient account public key
+   * @param options - Options
+   * @returns mined transaction details
+   * @example
+   * ```js
+   * await name.transfer('ak_asd23dasdas...', { ttl, fee, nonce })
+   * ```
+   */
+  async transfer(address, options = {}) {
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const tx = await buildTxAsync({
+      _isInternalBuild: true,
+      ...opt,
+      tag: Tag.NameTransferTx,
+      nameId: this.value,
+      accountId: opt.onAccount.address,
+      recipientId: address
+    });
+    return sendTransaction(tx, opt);
+  }
+
+  /**
+   * Query the AENS name info from the node and return the object with info
+   * @param options - Options
+   * @example
+   * ```js
+   * const nameEntry = await name.getState()
+   * console.log(nameEntry.owner)
+   * ```
+   */
+  async getState(options = {}) {
+    var _options$onNode;
+    const onNode = (_options$onNode = options.onNode) !== null && _options$onNode !== void 0 ? _options$onNode : this.options.onNode;
+    const nameEntry = await onNode.getNameEntryByName(this.value);
+    return {
+      ...nameEntry,
+      id: nameEntry.id,
+      owner: nameEntry.owner
+    };
+  }
+
+  /**
+   * Query the AENS auction info from the node and return the object with info
+   * @param options - Options
+   * @example
+   * ```js
+   * const auctionEntry = await name.getAuctionState()
+   * console.log(auctionEntry.highestBidder)
+   * ```
+   */
+  async getAuctionState(options = {}) {
+    var _options$onNode2;
+    if (!isAuctionName(this.value)) throw new NotAuctionNameError(this.value, 'get auction state');
+    const onNode = (_options$onNode2 = options.onNode) !== null && _options$onNode2 !== void 0 ? _options$onNode2 : this.options.onNode;
+    const nameEntry = await onNode.getAuctionEntryByName(this.value);
+    return {
+      ...nameEntry,
+      id: nameEntry.id,
+      highestBidder: nameEntry.highestBidder
+    };
+  }
+
+  /**
+   *
+   * @param nameTtl - represents in number of blocks (max and default is 180000)
+   * @param options - Options
+   * @returns mined transaction details
+   */
+  async extendTtl(nameTtl, options = {}) {
+    return this.update({}, {
+      ...options,
+      nameTtl,
+      extendPointers: true
+    });
+  }
+
+  /**
+   * Claim a previously preclaimed registration. This can only be done after the preclaim step
+   * @param options - options
+   * @returns mined transaction details
+   * @example
+   * ```js
+   * await name.claim({ ttl, fee, nonce, nameFee })
+   * ```
+   */
+  async claim(options = {}) {
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const tx = await buildTxAsync({
+      _isInternalBuild: true,
+      nameSalt: _classPrivateFieldGet(_salt, this),
+      ...opt,
+      tag: Tag.NameClaimTx,
+      accountId: opt.onAccount.address,
+      name: this.value
+    });
+    return sendTransaction(tx, opt);
+  }
+
+  /**
+   * Preclaim a name. Sends a hash of the name and a random salt to the node
+   * @param options - Options
+   * @example
+   * ```js
+   * await name.preclaim({ ttl, fee, nonce })
+   * ```
+   */
+  async preclaim(options = {}) {
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const nameSalt = genSalt();
+    const tx = await buildTxAsync({
+      _isInternalBuild: true,
+      ...opt,
+      tag: Tag.NamePreclaimTx,
+      accountId: opt.onAccount.address,
+      commitmentId: commitmentHash(this.value, nameSalt)
+    });
+    const result = await sendTransaction(tx, opt);
+    _classPrivateFieldSet(_salt, this, nameSalt);
+    return {
+      ...result,
+      nameSalt
+    };
+  }
+
+  /**
+   * Bid to name auction
+   * @param nameFee - Name fee (bid fee)
+   * @param options - Options
+   * @returns mined transaction details
+   * @example
+   * ```js
+   * const bidFee = computeBidFee(name.value, { startFee, increment: 0.42 })
+   * await name.bid(213109412839123, { ttl, fee, nonce })
+   * ```
+   */
+  async bid(nameFee, options = {}) {
+    if (!isAuctionName(this.value)) throw new NotAuctionNameError(this.value, 'make a bid');
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const tx = await buildTxAsync({
+      _isInternalBuild: true,
+      ...opt,
+      tag: Tag.NameClaimTx,
+      accountId: opt.onAccount.address,
+      nameSalt: 0,
+      name: this.value,
+      nameFee
+    });
+    return sendTransaction(tx, opt);
+  }
+}
+//# sourceMappingURL=aens.js.map

package/es/aens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aens.js","names":["genSalt","isEncoded","commitmentHash","isAuctionName","produceNameId","Tag","Encoding","LogicError","sendTransaction","buildTxAsync","NotAuctionNameError","constructor","name","action","_salt","WeakMap","Name","value","options","_classPrivateFieldInitSpec","id","revoke","opt","tx","_isInternalBuild","tag","NameRevokeTx","nameId","accountId","onAccount","address","update","pointers","extendPointers","allPointers","Object","fromEntries","onNode","getNameEntryByName","map","key","hasRawPointers","values","some","v","Bytearray","NameUpdateTx","version","entries","transfer","NameTransferTx","recipientId","getState","_options$onNode","nameEntry","owner","getAuctionState","_options$onNode2","getAuctionEntryByName","highestBidder","extendTtl","nameTtl","claim","nameSalt","_classPrivateFieldGet","NameClaimTx","preclaim","NamePreclaimTx","commitmentId","result","_classPrivateFieldSet","bid","nameFee"],"sources":["../src/aens.ts"],"sourcesContent":["/**\n * Aens methods - routines to interact with the æternity naming system\n *\n * The high-level description of the naming system is\n * https://github.com/aeternity/protocol/blob/master/AENS.md in the protocol\n * repository.\n */\n\nimport BigNumber from 'bignumber.js';\nimport { genSalt, isEncoded } from './utils/crypto.js';\nimport { commitmentHash, isAuctionName, produceNameId } from './tx/builder/helpers.js';\nimport { Tag, AensName } from './tx/builder/constants.js';\nimport { Encoded, Encoding } from './utils/encoder.js';\nimport { LogicError } from './utils/errors.js';\nimport { sendTransaction, SendTransactionOptions } from './send-transaction.js';\nimport { Optional } from './utils/other.js';\nimport { buildTxAsync, BuildTxOptions } from './tx/builder/index.js';\nimport Node from './Node.js';\nimport AccountBase from './account/Base.js';\nimport { AddressEncodings } from './tx/builder/field-types/address.js';\n\ninterface NameRevokeOptions\n  extends BuildTxOptions<Tag.NameRevokeTx, 'nameId' | 'accountId'>,\n    Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {}\n\ninterface KeyPointers {\n  [key: string]: Encoded.Generic<AddressEncodings | Encoding.Bytearray>;\n}\n\ninterface NameUpdateOptions\n  extends BuildTxOptions<Tag.NameUpdateTx, 'nameId' | 'accountId' | 'pointers'>,\n    Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {\n  /**\n   * Get the pointers from the node and merge with provided ones. Pointers with the same key will be\n   * overwritten.\n   */\n  extendPointers?: boolean;\n}\n\ninterface NameTransferOptions\n  extends BuildTxOptions<Tag.NameTransferTx, 'nameId' | 'accountId' | 'recipientId'>,\n    Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {}\n\ninterface NamePreclaimOptions\n  extends BuildTxOptions<Tag.NamePreclaimTx, 'accountId' | 'commitmentId'>,\n    Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {}\n\ninterface NameClaimOptions\n  extends BuildTxOptions<Tag.NameClaimTx, 'accountId' | 'name'>,\n    Optional<SendTransactionOptions, 'onAccount' | 'onNode'> {}\n\nclass NotAuctionNameError extends LogicError {\n  constructor(name: AensName, action: string) {\n    super(`Can't ${action} because ${name} is not an auction name`);\n    this.name = 'NotAuctionNameError';\n  }\n}\n\n/**\n * @category AENS\n * @example\n * ```js\n * const name = new Name('test.chain', aeSdk.getContext())\n * ```\n */\nexport default class Name {\n  #salt?: number;\n\n  /**\n   * @param value - AENS name\n   * @param options - Options\n   * @param options.onNode - Node to use\n   * @param options.onAccount - Account to use\n   */\n  constructor(\n    public readonly value: AensName,\n    public options: { onNode: Node; onAccount: AccountBase } & Omit<\n      NameRevokeOptions &\n        NameUpdateOptions &\n        NameTransferOptions &\n        NamePreclaimOptions &\n        NameClaimOptions,\n      'version'\n    >,\n  ) {\n    this.options = options;\n  }\n\n  /**\n   * Name ID encoded as nm_-prefixed string\n   */\n  get id(): Encoded.Name {\n    return produceNameId(this.value);\n  }\n\n  /**\n   * Revoke a name\n   * @param options - Options\n   * @returns mined transaction details\n   * @example\n   * ```js\n   * await name.revoke({ fee, ttl, nonce })\n   * ```\n   */\n  async revoke(options: NameRevokeOptions = {}): ReturnType<typeof sendTransaction> {\n    const opt = { ...this.options, ...options };\n    const tx = await buildTxAsync({\n      _isInternalBuild: true,\n      ...opt,\n      tag: Tag.NameRevokeTx,\n      nameId: this.value,\n      accountId: opt.onAccount.address,\n    });\n    return sendTransaction(tx, opt);\n  }\n\n  /**\n   * Update a name\n   * @param pointers - Map of pointer keys to corresponding addresses\n   * @param options - Options\n   * @example\n   * ```js\n   * const name = 'test.chain'\n   * const channel = 'ch_2519mBs...'\n   * const pointers = {\n   *   account_pubkey: 'ak_asd23dasdas...,',\n   *   contract_pubkey: 'ct_asdf34fasdasd...',\n   *   [getDefaultPointerKey(channel)]: channel,\n   * }\n   * await name.update(pointers, { nameTtl, ttl, fee, nonce, clientTtl })\n   * ```\n   */\n  async update(\n    pointers: KeyPointers,\n    options: NameUpdateOptions = {},\n  ): ReturnType<typeof sendTransaction> {\n    const { extendPointers, ...opt } = { ...this.options, ...options };\n    const allPointers = {\n      ...(extendPointers === true &&\n        Object.fromEntries(\n          (await opt.onNode.getNameEntryByName(this.value)).pointers.map(({ key, id }) => [\n            key,\n            id,\n          ]),\n        )),\n      ...pointers,\n    };\n\n    const hasRawPointers = Object.values(allPointers).some((v) => isEncoded(v, Encoding.Bytearray));\n\n    const tx = await buildTxAsync({\n      _isInternalBuild: true,\n      ...opt,\n      tag: Tag.NameUpdateTx,\n      version: hasRawPointers ? 2 : 1,\n      nameId: this.value,\n      accountId: opt.onAccount.address,\n      pointers: Object.entries(allPointers).map(\n        ([key, id]: [string, Encoded.Generic<AddressEncodings>]) => ({ key, id }),\n      ),\n    });\n    return sendTransaction(tx, opt);\n  }\n\n  /**\n   * Transfer a name to another account\n   * @param address - Recipient account public key\n   * @param options - Options\n   * @returns mined transaction details\n   * @example\n   * ```js\n   * await name.transfer('ak_asd23dasdas...', { ttl, fee, nonce })\n   * ```\n   */\n  async transfer(\n    address: Encoded.AccountAddress,\n    options: NameTransferOptions = {},\n  ): ReturnType<typeof sendTransaction> {\n    const opt = { ...this.options, ...options };\n    const tx = await buildTxAsync({\n      _isInternalBuild: true,\n      ...opt,\n      tag: Tag.NameTransferTx,\n      nameId: this.value,\n      accountId: opt.onAccount.address,\n      recipientId: address,\n    });\n    return sendTransaction(tx, opt);\n  }\n\n  /**\n   * Query the AENS name info from the node and return the object with info\n   * @param options - Options\n   * @example\n   * ```js\n   * const nameEntry = await name.getState()\n   * console.log(nameEntry.owner)\n   * ```\n   */\n  async getState(options: { onNode?: Node } = {}): Promise<\n    Awaited<ReturnType<Node['getNameEntryByName']>> & {\n      id: Encoded.Name;\n      owner: Encoded.AccountAddress;\n    }\n  > {\n    const onNode = options.onNode ?? this.options.onNode;\n    const nameEntry = await onNode.getNameEntryByName(this.value);\n    return {\n      ...nameEntry,\n      id: nameEntry.id as Encoded.Name,\n      owner: nameEntry.owner as Encoded.AccountAddress,\n    };\n  }\n\n  /**\n   * Query the AENS auction info from the node and return the object with info\n   * @param options - Options\n   * @example\n   * ```js\n   * const auctionEntry = await name.getAuctionState()\n   * console.log(auctionEntry.highestBidder)\n   * ```\n   */\n  async getAuctionState(options: { onNode?: Node } = {}): Promise<\n    Awaited<ReturnType<Node['getAuctionEntryByName']>> & {\n      id: Encoded.Name;\n      highestBidder: Encoded.AccountAddress;\n    }\n  > {\n    if (!isAuctionName(this.value)) throw new NotAuctionNameError(this.value, 'get auction state');\n    const onNode = options.onNode ?? this.options.onNode;\n    const nameEntry = await onNode.getAuctionEntryByName(this.value);\n    return {\n      ...nameEntry,\n      id: nameEntry.id as Encoded.Name,\n      highestBidder: nameEntry.highestBidder as Encoded.AccountAddress,\n    };\n  }\n\n  /**\n   *\n   * @param nameTtl - represents in number of blocks (max and default is 180000)\n   * @param options - Options\n   * @returns mined transaction details\n   */\n  async extendTtl(\n    nameTtl?: number,\n    options: Omit<Parameters<Name['update']>[1], 'extendPointers' | 'nameTtl'> = {},\n  ): ReturnType<Name['update']> {\n    return this.update({}, { ...options, nameTtl, extendPointers: true });\n  }\n\n  /**\n   * Claim a previously preclaimed registration. This can only be done after the preclaim step\n   * @param options - options\n   * @returns mined transaction details\n   * @example\n   * ```js\n   * await name.claim({ ttl, fee, nonce, nameFee })\n   * ```\n   */\n  async claim(options: NameClaimOptions = {}): ReturnType<typeof sendTransaction> {\n    const opt = { ...this.options, ...options };\n    const tx = await buildTxAsync({\n      _isInternalBuild: true,\n      nameSalt: this.#salt,\n      ...opt,\n      tag: Tag.NameClaimTx,\n      accountId: opt.onAccount.address,\n      name: this.value,\n    });\n    return sendTransaction(tx, opt);\n  }\n\n  /**\n   * Preclaim a name. Sends a hash of the name and a random salt to the node\n   * @param options - Options\n   * @example\n   * ```js\n   * await name.preclaim({ ttl, fee, nonce })\n   * ```\n   */\n  async preclaim(\n    options: NamePreclaimOptions = {},\n  ): Promise<Awaited<ReturnType<typeof sendTransaction>> & { nameSalt: number }> {\n    const opt = { ...this.options, ...options };\n    const nameSalt = genSalt();\n    const tx = await buildTxAsync({\n      _isInternalBuild: true,\n      ...opt,\n      tag: Tag.NamePreclaimTx,\n      accountId: opt.onAccount.address,\n      commitmentId: commitmentHash(this.value, nameSalt),\n    });\n    const result = await sendTransaction(tx, opt);\n    this.#salt = nameSalt;\n    return { ...result, nameSalt };\n  }\n\n  /**\n   * Bid to name auction\n   * @param nameFee - Name fee (bid fee)\n   * @param options - Options\n   * @returns mined transaction details\n   * @example\n   * ```js\n   * const bidFee = computeBidFee(name.value, { startFee, increment: 0.42 })\n   * await name.bid(213109412839123, { ttl, fee, nonce })\n   * ```\n   */\n  async bid(\n    nameFee: number | string | BigNumber,\n    options: Omit<NameClaimOptions, 'nameFee'> = {},\n  ): ReturnType<typeof sendTransaction> {\n    if (!isAuctionName(this.value)) throw new NotAuctionNameError(this.value, 'make a bid');\n    const opt = { ...this.options, ...options };\n    const tx = await buildTxAsync({\n      _isInternalBuild: true,\n      ...opt,\n      tag: Tag.NameClaimTx,\n      accountId: opt.onAccount.address,\n      nameSalt: 0,\n      name: this.value,\n      nameFee,\n    });\n    return sendTransaction(tx, opt);\n  }\n}\n"],"mappings":";;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,OAAO,EAAEC,SAAS,QAAQ,mBAAmB;AACtD,SAASC,cAAc,EAAEC,aAAa,EAAEC,aAAa,QAAQ,yBAAyB;AACtF,SAASC,GAAG,QAAkB,2BAA2B;AACzD,SAAkBC,QAAQ,QAAQ,oBAAoB;AACtD,SAASC,UAAU,QAAQ,mBAAmB;AAC9C,SAASC,eAAe,QAAgC,uBAAuB;AAE/E,SAASC,YAAY,QAAwB,uBAAuB;AAmCpE,MAAMC,mBAAmB,SAASH,UAAU,CAAC;EAC3CI,WAAWA,CAACC,IAAc,EAAEC,MAAc,EAAE;IAC1C,KAAK,CAAC,SAASA,MAAM,YAAYD,IAAI,yBAAyB,CAAC;IAC/D,IAAI,CAACA,IAAI,GAAG,qBAAqB;EACnC;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AANA,IAAAE,KAAA,oBAAAC,OAAA;AAOA,eAAe,MAAMC,IAAI,CAAC;EAGxB;AACF;AACA;AACA;AACA;AACA;EACEL,WAAWA,CACOM,KAAe,EACxBC,OAON,EACD;IAlBFC,0BAAA,OAAAL,KAAK;IAAU,KASGG,KAAe,GAAfA,KAAe;IAAA,KACxBC,OAON,GAPMA,OAON;IAED,IAAI,CAACA,OAAO,GAAGA,OAAO;EACxB;;EAEA;AACF;AACA;EACE,IAAIE,EAAEA,CAAA,EAAiB;IACrB,OAAOhB,aAAa,CAAC,IAAI,CAACa,KAAK,CAAC;EAClC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMI,MAAMA,CAACH,OAA0B,GAAG,CAAC,CAAC,EAAsC;IAChF,MAAMI,GAAG,GAAG;MAAE,GAAG,IAAI,CAACJ,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAMK,EAAE,GAAG,MAAMd,YAAY,CAAC;MAC5Be,gBAAgB,EAAE,IAAI;MACtB,GAAGF,GAAG;MACNG,GAAG,EAAEpB,GAAG,CAACqB,YAAY;MACrBC,MAAM,EAAE,IAAI,CAACV,KAAK;MAClBW,SAAS,EAAEN,GAAG,CAACO,SAAS,CAACC;IAC3B,CAAC,CAAC;IACF,OAAOtB,eAAe,CAACe,EAAE,EAAED,GAAG,CAAC;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMS,MAAMA,CACVC,QAAqB,EACrBd,OAA0B,GAAG,CAAC,CAAC,EACK;IACpC,MAAM;MAAEe,cAAc;MAAE,GAAGX;IAAI,CAAC,GAAG;MAAE,GAAG,IAAI,CAACJ,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAClE,MAAMgB,WAAW,GAAG;MAClB,IAAID,cAAc,KAAK,IAAI,IACzBE,MAAM,CAACC,WAAW,CAChB,CAAC,MAAMd,GAAG,CAACe,MAAM,CAACC,kBAAkB,CAAC,IAAI,CAACrB,KAAK,CAAC,EAAEe,QAAQ,CAACO,GAAG,CAAC,CAAC;QAAEC,GAAG;QAAEpB;MAAG,CAAC,KAAK,CAC9EoB,GAAG,EACHpB,EAAE,CACH,CACH,CAAC,CAAC;MACJ,GAAGY;IACL,CAAC;IAED,MAAMS,cAAc,GAAGN,MAAM,CAACO,MAAM,CAACR,WAAW,CAAC,CAACS,IAAI,CAAEC,CAAC,IAAK3C,SAAS,CAAC2C,CAAC,EAAEtC,QAAQ,CAACuC,SAAS,CAAC,CAAC;IAE/F,MAAMtB,EAAE,GAAG,MAAMd,YAAY,CAAC;MAC5Be,gBAAgB,EAAE,IAAI;MACtB,GAAGF,GAAG;MACNG,GAAG,EAAEpB,GAAG,CAACyC,YAAY;MACrBC,OAAO,EAAEN,cAAc,GAAG,CAAC,GAAG,CAAC;MAC/Bd,MAAM,EAAE,IAAI,CAACV,KAAK;MAClBW,SAAS,EAAEN,GAAG,CAACO,SAAS,CAACC,OAAO;MAChCE,QAAQ,EAAEG,MAAM,CAACa,OAAO,CAACd,WAAW,CAAC,CAACK,GAAG,CACvC,CAAC,CAACC,GAAG,EAAEpB,EAAE,CAA8C,MAAM;QAAEoB,GAAG;QAAEpB;MAAG,CAAC,CAC1E;IACF,CAAC,CAAC;IACF,OAAOZ,eAAe,CAACe,EAAE,EAAED,GAAG,CAAC;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM2B,QAAQA,CACZnB,OAA+B,EAC/BZ,OAA4B,GAAG,CAAC,CAAC,EACG;IACpC,MAAMI,GAAG,GAAG;MAAE,GAAG,IAAI,CAACJ,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAMK,EAAE,GAAG,MAAMd,YAAY,CAAC;MAC5Be,gBAAgB,EAAE,IAAI;MACtB,GAAGF,GAAG;MACNG,GAAG,EAAEpB,GAAG,CAAC6C,cAAc;MACvBvB,MAAM,EAAE,IAAI,CAACV,KAAK;MAClBW,SAAS,EAAEN,GAAG,CAACO,SAAS,CAACC,OAAO;MAChCqB,WAAW,EAAErB;IACf,CAAC,CAAC;IACF,OAAOtB,eAAe,CAACe,EAAE,EAAED,GAAG,CAAC;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM8B,QAAQA,CAAClC,OAA0B,GAAG,CAAC,CAAC,EAK5C;IAAA,IAAAmC,eAAA;IACA,MAAMhB,MAAM,IAAAgB,eAAA,GAAGnC,OAAO,CAACmB,MAAM,cAAAgB,eAAA,cAAAA,eAAA,GAAI,IAAI,CAACnC,OAAO,CAACmB,MAAM;IACpD,MAAMiB,SAAS,GAAG,MAAMjB,MAAM,CAACC,kBAAkB,CAAC,IAAI,CAACrB,KAAK,CAAC;IAC7D,OAAO;MACL,GAAGqC,SAAS;MACZlC,EAAE,EAAEkC,SAAS,CAAClC,EAAkB;MAChCmC,KAAK,EAAED,SAAS,CAACC;IACnB,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMC,eAAeA,CAACtC,OAA0B,GAAG,CAAC,CAAC,EAKnD;IAAA,IAAAuC,gBAAA;IACA,IAAI,CAACtD,aAAa,CAAC,IAAI,CAACc,KAAK,CAAC,EAAE,MAAM,IAAIP,mBAAmB,CAAC,IAAI,CAACO,KAAK,EAAE,mBAAmB,CAAC;IAC9F,MAAMoB,MAAM,IAAAoB,gBAAA,GAAGvC,OAAO,CAACmB,MAAM,cAAAoB,gBAAA,cAAAA,gBAAA,GAAI,IAAI,CAACvC,OAAO,CAACmB,MAAM;IACpD,MAAMiB,SAAS,GAAG,MAAMjB,MAAM,CAACqB,qBAAqB,CAAC,IAAI,CAACzC,KAAK,CAAC;IAChE,OAAO;MACL,GAAGqC,SAAS;MACZlC,EAAE,EAAEkC,SAAS,CAAClC,EAAkB;MAChCuC,aAAa,EAAEL,SAAS,CAACK;IAC3B,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,SAASA,CACbC,OAAgB,EAChB3C,OAA0E,GAAG,CAAC,CAAC,EACnD;IAC5B,OAAO,IAAI,CAACa,MAAM,CAAC,CAAC,CAAC,EAAE;MAAE,GAAGb,OAAO;MAAE2C,OAAO;MAAE5B,cAAc,EAAE;IAAK,CAAC,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM6B,KAAKA,CAAC5C,OAAyB,GAAG,CAAC,CAAC,EAAsC;IAC9E,MAAMI,GAAG,GAAG;MAAE,GAAG,IAAI,CAACJ,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAMK,EAAE,GAAG,MAAMd,YAAY,CAAC;MAC5Be,gBAAgB,EAAE,IAAI;MACtBuC,QAAQ,EAAEC,qBAAA,CAAKlD,KAAK,EAAV,IAAS,CAAC;MACpB,GAAGQ,GAAG;MACNG,GAAG,EAAEpB,GAAG,CAAC4D,WAAW;MACpBrC,SAAS,EAAEN,GAAG,CAACO,SAAS,CAACC,OAAO;MAChClB,IAAI,EAAE,IAAI,CAACK;IACb,CAAC,CAAC;IACF,OAAOT,eAAe,CAACe,EAAE,EAAED,GAAG,CAAC;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM4C,QAAQA,CACZhD,OAA4B,GAAG,CAAC,CAAC,EAC4C;IAC7E,MAAMI,GAAG,GAAG;MAAE,GAAG,IAAI,CAACJ,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAM6C,QAAQ,GAAG/D,OAAO,CAAC,CAAC;IAC1B,MAAMuB,EAAE,GAAG,MAAMd,YAAY,CAAC;MAC5Be,gBAAgB,EAAE,IAAI;MACtB,GAAGF,GAAG;MACNG,GAAG,EAAEpB,GAAG,CAAC8D,cAAc;MACvBvC,SAAS,EAAEN,GAAG,CAACO,SAAS,CAACC,OAAO;MAChCsC,YAAY,EAAElE,cAAc,CAAC,IAAI,CAACe,KAAK,EAAE8C,QAAQ;IACnD,CAAC,CAAC;IACF,MAAMM,MAAM,GAAG,MAAM7D,eAAe,CAACe,EAAE,EAAED,GAAG,CAAC;IAC7CgD,qBAAA,CAAKxD,KAAK,EAAV,IAAI,EAASiD,QAAJ,CAAC;IACV,OAAO;MAAE,GAAGM,MAAM;MAAEN;IAAS,CAAC;EAChC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMQ,GAAGA,CACPC,OAAoC,EACpCtD,OAA0C,GAAG,CAAC,CAAC,EACX;IACpC,IAAI,CAACf,aAAa,CAAC,IAAI,CAACc,KAAK,CAAC,EAAE,MAAM,IAAIP,mBAAmB,CAAC,IAAI,CAACO,KAAK,EAAE,YAAY,CAAC;IACvF,MAAMK,GAAG,GAAG;MAAE,GAAG,IAAI,CAACJ,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAMK,EAAE,GAAG,MAAMd,YAAY,CAAC;MAC5Be,gBAAgB,EAAE,IAAI;MACtB,GAAGF,GAAG;MACNG,GAAG,EAAEpB,GAAG,CAAC4D,WAAW;MACpBrC,SAAS,EAAEN,GAAG,CAACO,SAAS,CAACC,OAAO;MAChCiC,QAAQ,EAAE,CAAC;MACXnD,IAAI,EAAE,IAAI,CAACK,KAAK;MAChBuD;IACF,CAAC,CAAC;IACF,OAAOhE,eAAe,CAACe,EAAE,EAAED,GAAG,CAAC;EACjC;AACF","ignoreList":[]}