Initial version of helper.ts for CW721-base #131

volkrass · 2020-10-21T07:57:53Z

This is my initial version of helper.ts for CW721-base contract.

npx @cosmjs/cli@^0.23 --init contracts/cosmons/helpers.ts

Following methods are implemented and will be part of helper.ts - comments below will be part of next version. Here for review:

Setup Contract

const client = await useOptions(defaultOptions).setup(<YOUR PASSWORD>);
const partner = await useOptions(defaultOptions).setup(<YOUR PASSWORD>, ".wallet2.key");
const cw721 = CW721(client);
const codeId = <your CodeID>;
const initMsg = { name: "Cosmons", symbol: "mons",  minter: address };
const contract = await client.instantiate(codeId, initMsg, "Virtual Cosmons 1");
const mine = cw721.use(contract.contractAddress);

Transfer Token to Partner

mine.transferNft(partnerAddr, "monster112a9lf95atqvyejqe22xnna8x4mfqd75tkq2kvwcjyysarcsb");

Approve Contract

// Don't call transferNft before, otherwise it fails
mine.approve(address, "monster112a9lf95atqvyejqe22xnna8x4mfqd75tkq2kvwcjyysarcsb");

Queries

mine.nftInfo("monster112a9lf95atqvyejqe22xnna8x4mfqd75tkq2kvwcjyysarcsb")
mine.ownerOf("monster112a9lf95atqvyejqe22xnna8x4mfqd75tkq2kvwcjyysarcsb")
mine.numTokens()
mine.tokens(address, "", 10)
mine.allNftInfo("monster112a9lf95atqvyejqe22xnna8x4mfqd75tkq2kvwcjyysarcsb")
mine.allTokens("", 10)

CLAassistant · 2020-10-21T07:57:57Z

All committers have signed the CLA.

ethanfrey

Nice work here.

Added a lot of very minor comments on it, just some tips to polish it up to a very high quality interface.

Hope this is working well for you in your UI.

ethanfrey · 2020-10-21T10:00:11Z

contracts/cw721-base/helpers.ts

+  },
+}
+
+const hackatomOptions: Options = {


These two are pointing to the same network with different faucet, right? Why not unify them?

contracts/cw721-base/helpers.ts

ethanfrey · 2020-10-21T10:02:32Z

contracts/cw721-base/helpers.ts

+  // tokenInfo: () => Promise<any>
+  minter: () => Promise<any>
+  numTokens: () => Promise<any>
+  tokens: (owner:string, start_after: string, limit: number ) => Promise<TokensResponse>


start_after and limit are optional here as well

Actually, probably nicest to use startAfter for the interface and convert in the json sent over the wire.

ethanfrey · 2020-10-21T10:03:08Z

contracts/cw721-base/helpers.ts

+  allAllowances: (owner: string, startAfter?: string, limit?: number) => Promise<AllAllowancesResponse>
+  allAccounts: (startAfter?: string, limit?: number) => Promise<readonly string[]>
+  contractInfo: () => Promise<any>
+  ownerOf: (owner: string) => Promise<any>


this should be tokenId: string not owner: string

ethanfrey · 2020-10-21T10:04:05Z

contracts/cw721-base/helpers.ts

+  allTokens: (start_after?: string, limit?: number ) => Promise<TokensResponse>
+
+  // actions
+  mint: (token_id: string, owner:string, name:string, description?: string) => Promise<string>


Also takes image?: string I believe

I think defining type TokenId = string somewhere above and using it some places would make the return values clearer - no runtime or type-check difference, just more readable. Actually, what is the string returned here... I guess not the TokenId.

Oh, and for public API, nice to use tokenId rather than token_id

ethanfrey · 2020-10-21T10:06:08Z

contracts/cw721-base/helpers.ts

+    };
+
+    const allAllowances = async (owner: string, startAfter?: string, limit?: number): Promise<AllAllowancesResponse> => {
+      return client.queryContractSmart(contractAddress, {all_allowances: { owner, start_after: startAfter, limit }});


ethanfrey · 2020-10-21T10:08:06Z

contracts/cw721-base/helpers.ts

+    };
+*/
+    // mints tokens, returns ?
+    const mint = async (token_id: string, owner: string, name:string, description:string): Promise<string> => {


this is defined as description?: string in the interface above. good to be consistent. (and nice to add image url here as well)

contracts/cw721-base/helpers.ts

ethanfrey

Nice cleanup!

BlockscapeLab · 2020-11-08T16:04:06Z

@ethanfrey, from my point of view helper.ts is ready to merge. Let me know if there is something what I should improve.

ethanfrey · 2020-11-16T16:53:41Z

Sorry for the delay reviewing this. I have been on holiday.

I will check this now. But only one of the 2 github committers has signed the CLA. Could you fix this?

ethanfrey

Looks quite good. Some small changes requested.

Mainly just replacing any with concrete types.

ethanfrey · 2020-11-16T16:55:12Z

contracts/cw721-base/helpers.ts

+    return wallet;
+  };
+
+  const buildFeeTable = (feeToken: string, gasPrice: number): CosmWasmFeeTable => {


You can remove buildFeeTable now, it is unneeded and handles inside the CosmWasmSigningClient

ethanfrey · 2020-11-16T16:57:59Z

contracts/cw721-base/helpers.ts

+      return accounts.accounts;
+    };
+
+    const minter = async (): Promise<any> => {


It would be good to clarify the return types here. (And all the any until ownerOf).

You can either just return the response verbatum, like allowance, or pull out the important field like allAccounts

ethanfrey · 2020-11-16T16:59:13Z

contracts/cw721-base/helpers.ts

+    }
+
+    // total number of tokens issued
+    const numTokens = async (): Promise<any> => {


again, is this a number? a stringified number? (from Uint128)? please define type

Also, I would put all queries together and all messages/transactions together, just for readability

volkrass · 2020-12-02T09:58:41Z

@ethanfrey , I guess we can close this ticket. My collegues has been fixed the issues, so that this pull request is outdated. What do you think?

ethanfrey

Sorry for the delay I missed the notification that this was fixed and it slipped.

Merging now,

Initial version of helper.ts for CW721-base

0819a86

ethanfrey reviewed Oct 21, 2020

View reviewed changes

mwaylabsAdmin added 2 commits October 21, 2020 12:38

fixes after first review

d72d462

Review done

156aa63

ethanfrey reviewed Oct 21, 2020

View reviewed changes

MarcelMWS added 3 commits November 6, 2020 16:27

Merge branch 'master' into cw721-helper

4af1241

add helper.ts with current version

6366aae

rm comments

26739d8

ethanfrey reviewed Nov 16, 2020

View reviewed changes

MarcelMWS added 8 commits November 17, 2020 18:29

rm buildFeeTable

3adf8e3

setup types

599dc9c

add files

b2e2ab5

add axios

8bdfd0d

restructuring

39399cd

comments

8ce5489

add remaning interfaces

7f1a0f3

rm js types

51bb792

ethanfrey approved these changes Dec 2, 2020

View reviewed changes

ethanfrey merged commit 4904145 into CosmWasm:master Dec 2, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial version of helper.ts for CW721-base #131

Initial version of helper.ts for CW721-base #131

volkrass commented Oct 21, 2020

CLAassistant commented Oct 21, 2020 •

edited

Loading

ethanfrey left a comment

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey Oct 21, 2020

ethanfrey left a comment

BlockscapeLab commented Nov 8, 2020

ethanfrey commented Nov 16, 2020

ethanfrey left a comment

ethanfrey Nov 16, 2020

ethanfrey Nov 16, 2020

ethanfrey Nov 16, 2020

ethanfrey Nov 16, 2020

volkrass commented Dec 2, 2020

ethanfrey left a comment

Initial version of helper.ts for CW721-base #131

Initial version of helper.ts for CW721-base #131

Conversation

volkrass commented Oct 21, 2020

Setup Contract

Transfer Token to Partner

Approve Contract

Queries

CLAassistant commented Oct 21, 2020 • edited Loading

ethanfrey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanfrey left a comment

Choose a reason for hiding this comment

BlockscapeLab commented Nov 8, 2020

ethanfrey commented Nov 16, 2020

ethanfrey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

volkrass commented Dec 2, 2020

ethanfrey left a comment

Choose a reason for hiding this comment

CLAassistant commented Oct 21, 2020 •

edited

Loading