@0xobelisk/client 0.1.3 → 0.2.3

package/src/obelisk.ts

@@ -5,7 +5,7 @@ import {
   SuiTransactionBlockResponse,
   SuiMoveNormalizedModules,
   DynamicFieldName,
-  SuiAddress
+  SuiAddress,
 } from '@mysten/sui.js';
 import { SuiAccountManager } from './libs/suiAccountManager';
 import { SuiTxBlock } from './libs/suiTxBuilder';
@@ -14,47 +14,79 @@ import { SuiSharedObject, SuiOwnedObject } from './libs/suiModel';
 
 import { ObeliskObjectData } from 'src/types';
 import { SuiContractFactory } from './libs/suiContractFactory';
-import { SuiMoveMoudleValueType, SuiMoveMoudleFuncType } from './libs/suiContractFactory/types';
+import {
+  SuiMoveMoudleValueType,
+  SuiMoveMoudleFuncType,
+} from './libs/suiContractFactory/types';
 import {
   ObeliskParams,
   DerivePathParams,
-  SuiTxArg, SuiVecTxArg,
+  SuiTxArg,
+  SuiVecTxArg,
   ComponentContentType,
-  SuiTxArgument, ContractQuery,
-  ContractTx, MapMoudleFuncQuery,
-  MapMoudleFuncTx, FaucetNetworkType
+  SuiTxArgument,
+  ContractQuery,
+  ContractTx,
+  MapMoudleFuncQuery,
+  MapMoudleFuncTx,
+  FaucetNetworkType,
 } from './types';
-import {capitalizeFirstLetter} from "./utils"
-import keccak256 from "keccak256";
+import { capitalizeFirstLetter } from './utils';
+import keccak256 from 'keccak256';
 
-export function isUndefined (value?: unknown): value is undefined {
+export function isUndefined(value?: unknown): value is undefined {
   return value === undefined;
 }
 
-export function withMeta<T extends { meta: SuiMoveMoudleFuncType }>(meta: SuiMoveMoudleFuncType,creator: Omit<T, 'meta'>): T {
-  (creator as T).meta = meta
+export function withMeta<T extends { meta: SuiMoveMoudleFuncType }>(
+  meta: SuiMoveMoudleFuncType,
+  creator: Omit<T, 'meta'>
+): T {
+  (creator as T).meta = meta;
 
   return creator as T;
 }
 
 function createQuery(
   meta: SuiMoveMoudleFuncType,
-  fn: (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean) => Promise<DevInspectResults | TransactionBlock>
+  fn: (
+    tx: TransactionBlock,
+    params: SuiTxArgument[],
+    isRaw?: boolean
+  ) => Promise<DevInspectResults | TransactionBlock>
 ): ContractQuery {
-  return withMeta(meta, async (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean): Promise<DevInspectResults | TransactionBlock> => {
-    const result = await fn(tx, params, isRaw);
-    return result;
-  });
+  return withMeta(
+    meta,
+    async (
+      tx: TransactionBlock,
+      params: SuiTxArgument[],
+      isRaw?: boolean
+    ): Promise<DevInspectResults | TransactionBlock> => {
+      const result = await fn(tx, params, isRaw);
+      return result;
+    }
+  );
 }
 
 function createTx(
   meta: SuiMoveMoudleFuncType,
-  fn: (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean) => Promise<SuiTransactionBlockResponse | TransactionBlock>
+  fn: (
+    tx: TransactionBlock,
+    params: SuiTxArgument[],
+    isRaw?: boolean
+  ) => Promise<SuiTransactionBlockResponse | TransactionBlock>
 ): ContractTx {
-  return withMeta(meta, async (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean): Promise<SuiTransactionBlockResponse | TransactionBlock> => {
-    const result = await fn(tx, params, isRaw);
-    return result;
-  });
+  return withMeta(
+    meta,
+    async (
+      tx: TransactionBlock,
+      params: SuiTxArgument[],
+      isRaw?: boolean
+    ): Promise<SuiTransactionBlockResponse | TransactionBlock> => {
+      const result = await fn(tx, params, isRaw);
+      return result;
+    }
+  );
 }
 
 /**
@@ -88,7 +120,7 @@ export class Obelisk {
     networkType,
     fullnodeUrls,
     packageId,
-    metadata
+    metadata,
   }: ObeliskParams = {}) {
     // Init the account manager
     this.accountManager = new SuiAccountManager({ mnemonics, secretKey });
@@ -99,49 +131,59 @@ export class Obelisk {
     this.packageId = packageId;
     if (metadata !== undefined) {
       this.metadata = metadata as SuiMoveNormalizedModules;
-      Object.values(metadata as SuiMoveNormalizedModules).forEach(value => {
+      Object.values(metadata as SuiMoveNormalizedModules).forEach((value) => {
         let data = value as SuiMoveMoudleValueType;
         let moduleName = data.name;
         Object.entries(data.exposedFunctions).forEach(([funcName, value]) => {
           let meta = value as SuiMoveMoudleFuncType;
           meta.moudleName = moduleName;
           meta.funcName = funcName;
-  
+
           if (isUndefined(this.#query[moduleName])) {
             this.#query[moduleName] = {};
           }
           if (isUndefined(this.#query[moduleName][funcName])) {
-            this.#query[moduleName][funcName] = createQuery(meta, (tx, p, isRaw) => this.#read(meta, tx, p, isRaw))
+            this.#query[moduleName][funcName] = createQuery(
+              meta,
+              (tx, p, isRaw) => this.#read(meta, tx, p, isRaw)
+            );
           }
-  
+
           if (isUndefined(this.#tx[moduleName])) {
             this.#tx[moduleName] = {};
           }
           if (isUndefined(this.#tx[moduleName][funcName])) {
-            this.#tx[moduleName][funcName] = createTx(meta, (tx, p, isRaw) => this.#exec(meta, tx, p, isRaw))
+            this.#tx[moduleName][funcName] = createTx(meta, (tx, p, isRaw) =>
+              this.#exec(meta, tx, p, isRaw)
+            );
           }
         });
-      })
+      });
     }
     this.contractFactory = new SuiContractFactory({
       packageId,
-      metadata
-    })
+      metadata,
+    });
   }
 
-  public get query (): MapMoudleFuncQuery {
+  public get query(): MapMoudleFuncQuery {
     return this.#query;
   }
 
-  public get tx (): MapMoudleFuncTx {
+  public get tx(): MapMoudleFuncTx {
     return this.#tx;
   }
 
-  #exec = async (meta: SuiMoveMoudleFuncType, tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean) => {
+  #exec = async (
+    meta: SuiMoveMoudleFuncType,
+    tx: TransactionBlock,
+    params: SuiTxArgument[],
+    isRaw?: boolean
+  ) => {
     tx.moveCall({
       target: `${this.contractFactory.packageId}::${meta.moudleName}::${meta.funcName}`,
       arguments: params,
-    })
+    });
 
     if (isRaw === true) {
       return tx;
@@ -149,13 +191,17 @@ export class Obelisk {
     return await this.signAndSendTxn(tx);
   };
 
-
-  #read = async (meta: SuiMoveMoudleFuncType, tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean) => {
+  #read = async (
+    meta: SuiMoveMoudleFuncType,
+    tx: TransactionBlock,
+    params: SuiTxArgument[],
+    isRaw?: boolean
+  ) => {
     tx.moveCall({
       target: `${this.contractFactory.packageId}::${meta.moudleName}::${meta.funcName}`,
       arguments: params,
-    })
-    
+    });
+
     if (isRaw === true) {
       return tx;
     }
@@ -200,7 +246,7 @@ export class Obelisk {
   }
 
   getMetadata() {
-    return this.contractFactory.metadata
+    return this.contractFactory.metadata;
   }
   /**
    * Request some SUI from faucet
@@ -224,7 +270,6 @@ export class Obelisk {
     return this.suiInteractor.getObjects(objectIds);
   }
 
-
   async signTxn(
     tx: Uint8Array | TransactionBlock | SuiTxBlock,
     derivePathParams?: DerivePathParams
@@ -399,45 +444,53 @@ export class Obelisk {
   }
 
   async getWorld(worldObjectId: string) {
-    return this.suiInteractor.getObject(worldObjectId)
+    return this.suiInteractor.getObject(worldObjectId);
   }
 
-  async getComponents(worldId: string) {
-    const parentId = (await this.suiInteractor.getObject(worldId)).objectFields.components.fields.id.id;
+  async getComponents(worldId: string, cursor?: string, limit?: number) {
+    const parentId = (await this.suiInteractor.getObject(worldId)).objectFields
+      .comps.fields.id.id;
 
-    return await this.suiInteractor.getDynamicFields(parentId);
+    return await this.suiInteractor.getDynamicFields(parentId, cursor, limit);
   }
 
-
   async getComponentByName(worldId: string, componentName: string) {
-    const componentId = keccak256(`${capitalizeFirstLetter(componentName)} Component`);
+    const componentNameId = `${componentName}`;
+    const componentId = keccak256(componentNameId);
     return await this.getComponent(worldId, componentId);
   }
 
   async getComponent(worldId: string, componentId: Buffer) {
     const componentIdValue: number[] = Array.from(componentId);
-    const parentId = (await this.suiInteractor.getObject(worldId)).objectFields.components.fields.id.id;
-
+    const parentId = (await this.suiInteractor.getObject(worldId)).objectFields
+      .comps.fields.id.id;
     const name = {
-      type: "vector<u8>",
-      value: componentIdValue
+      type: 'address',
+      value: componentIdValue,
       // value: [250,208,186,160,39,171,62,206,98,224,138,41,11,217,63,100,248,104,207,64,78,126,43,109,129,68,64,127,236,113,152,132]
-    } as DynamicFieldName
+    } as DynamicFieldName;
     return await this.suiInteractor.getDynamicFieldObject(parentId, name);
   }
 
   async getOwnedEntities(owner: SuiAddress, cursor?: string, limit?: number) {
-    const ownedObjects = await this.suiInteractor.getOwnedObjects(owner, cursor, limit)
+    const ownedObjects = await this.suiInteractor.getOwnedObjects(
+      owner,
+      cursor,
+      limit
+    );
     let ownedEntities: ObeliskObjectData[] = [];
-  
+
     for (const object of ownedObjects.data) {
       let objectDetail = await this.getObject(object.data!.objectId);
-  
-      if (objectDetail.objectType.split("::")[0] === this.contractFactory.packageId) {
+
+      if (
+        objectDetail.objectType.split('::')[0] ===
+        this.contractFactory.packageId
+      ) {
         ownedEntities.push(objectDetail);
       }
     }
-  
+
     return ownedEntities;
   }
 }

package/LICENSE

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2023 Scallop Labs
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.