0.15.0

zkcloudworker · Jan 8, 2025 · d2bb582 · d2bb582
1 parent 4c39ee2
commit d2bb582
Show file tree

Hide file tree

Showing 464 changed files with 14,954 additions and 10,564 deletions.
diff --git a/docs/abi.src.Function.buildTokenLaunchTransaction.md b/docs/abi.src.Function.buildTokenLaunchTransaction.md
@@ -23,6 +23,8 @@ function buildTokenLaunchTransaction(params: {
 }>
 ```
 
+Defined in: [packages/abi/src/token/build.ts:32](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/build.ts#L32)
+
 ## Parameters
 
 ### params
@@ -55,7 +57,3 @@ function buildTokenLaunchTransaction(params: {
   `tx`: `Transaction`\<`false`, `false`\>;
   `verificationKeyHashes`: `string`[];
  \}\>
-
-## Defined in
-
-[packages/abi/src/token/build.ts:32](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/build.ts#L32)
diff --git a/docs/abi.src.Function.buildTokenTransaction.md b/docs/abi.src.Function.buildTokenTransaction.md
@@ -37,6 +37,8 @@ function buildTokenTransaction(params: {
 }>
 ```
 
+Defined in: [packages/abi/src/token/build.ts:222](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/build.ts#L222)
+
 ## Parameters
 
 ### params
@@ -83,7 +85,3 @@ function buildTokenTransaction(params: {
   `tx`: `Transaction`\<`false`, `false`\>;
   `verificationKeyHashes`: `string`[];
  \}\>
-
-## Defined in
-
-[packages/abi/src/token/build.ts:222](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/build.ts#L222)
diff --git a/docs/abi.src.Function.checkAddress.md b/docs/abi.src.Function.checkAddress.md
@@ -0,0 +1,25 @@
+---
+title: checkAddress
+category: 6749c4dba3a7a4005bae1197
+hidden: false
+slug: abi.src.Function.checkAddress
+order: 22
+---
+
+# Function: checkAddress()
+
+```ts
+function checkAddress(address: undefined | string): Promise<boolean>
+```
+
+Defined in: [packages/abi/src/info/address.ts:3](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/info/address.ts#L3)
+
+## Parameters
+
+### address
+
+`undefined` | `string`
+
+## Returns
+
+`Promise`\<`boolean`\>
diff --git a/docs/abi.src.Function.fetchMinaAccount.md b/docs/abi.src.Function.fetchMinaAccount.md
@@ -3,7 +3,7 @@ title: fetchMinaAccount
 category: 6749c4dba3a7a4005bae1197
 hidden: false
 slug: abi.src.Function.fetchMinaAccount
-order: 22
+order: 23
 ---
 
 # Function: fetchMinaAccount()
@@ -16,6 +16,8 @@ function fetchMinaAccount(params: {
 }): Promise<Account | undefined>
 ```
 
+Defined in: [packages/abi/src/fetch.ts:11](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/fetch.ts#L11)
+
 Fetches the Mina account for a given public key with error handling
 
 ## Parameters
@@ -47,7 +49,3 @@ the token id of the account
 `Promise`\<`Account` \| `undefined`\>
 
 the account object
-
-## Defined in
-
-[packages/abi/src/fetch.ts:11](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/fetch.ts#L11)
diff --git a/docs/abi.src.Function.getContractInfo.md b/docs/abi.src.Function.getContractInfo.md
@@ -0,0 +1,49 @@
+---
+title: getContractInfo
+category: 6749c4dba3a7a4005bae1197
+hidden: false
+slug: abi.src.Function.getContractInfo
+order: 24
+---
+
+# Function: getContractInfo()
+
+```ts
+function getContractInfo(params: {
+  address: string | PublicKey;
+  chain: "mainnet" | "devnet";
+  decimals: number;
+  parentTokenId: Field;
+  tokenId: string | Field;
+}): Promise<ContractInfo[]>
+```
+
+Defined in: [packages/abi/src/token/info.ts:22](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/info.ts#L22)
+
+## Parameters
+
+### params
+
+#### address
+
+`string` \| `PublicKey`
+
+#### chain
+
+`"mainnet"` \| `"devnet"`
+
+#### decimals
+
+`number`
+
+#### parentTokenId
+
+`Field`
+
+#### tokenId
+
+`string` \| `Field`
+
+## Returns
+
+`Promise`\<`ContractInfo`[]\>
diff --git a/docs/abi.src.Function.getTokenSymbolAndAdmin.md b/docs/abi.src.Function.getTokenSymbolAndAdmin.md
@@ -3,7 +3,7 @@ title: getTokenSymbolAndAdmin
 category: 6749c4dba3a7a4005bae1197
 hidden: false
 slug: abi.src.Function.getTokenSymbolAndAdmin
-order: 23
+order: 25
 ---
 
 # Function: getTokenSymbolAndAdmin()
@@ -26,6 +26,8 @@ function getTokenSymbolAndAdmin(params: {
 }>
 ```
 
+Defined in: [packages/abi/src/token/build.ts:714](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/build.ts#L714)
+
 ## Parameters
 
 ### params
@@ -64,7 +66,3 @@ function getTokenSymbolAndAdmin(params: {
   `symbol`: `string`;
   `verificationKeyHashes`: `string`[];
  \}\>
-
-## Defined in
-
-[packages/abi/src/token/build.ts:658](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/build.ts#L658)
diff --git a/docs/abi.src.Function.tokenBalance.md b/docs/abi.src.Function.tokenBalance.md
@@ -0,0 +1,25 @@
+---
+title: tokenBalance
+category: 6749c4dba3a7a4005bae1197
+hidden: false
+slug: abi.src.Function.tokenBalance
+order: 26
+---
+
+# Function: tokenBalance()
+
+```ts
+function tokenBalance(params: BalanceRequestParams): Promise<BalanceResponse>
+```
+
+Defined in: [packages/abi/src/token/info.ts:172](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/info.ts#L172)
+
+## Parameters
+
+### params
+
+`BalanceRequestParams`
+
+## Returns
+
+`Promise`\<`BalanceResponse`\>
diff --git a/docs/abi.src.TypeAlias.ChainVerificationKeysList.md b/docs/abi.src.TypeAlias.ChainVerificationKeysList.md
@@ -14,7 +14,7 @@ order: 10
 - vk:  Record<string, {
   data: string;
   hash: string;
-  type: "token" | "admin" | "upgrade" | "user";
+  type: "token" | "admin" | "upgrade" | "user" | "nft" | "collection";
 }>; [↗](#vk)
 
 ```ts
@@ -23,11 +23,13 @@ type ChainVerificationKeysList = {
   vk: Record<string, {
      data: string;
      hash: string;
-     type: "token" | "admin" | "upgrade" | "user";
+     type: "token" | "admin" | "upgrade" | "user" | "nft" | "collection";
     }>;
 };
 ```
 
+Defined in: [packages/abi/src/vk/types.ts:1](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/types.ts#L1)
+
 ## Type declaration
 
 ### o1js
@@ -42,10 +44,6 @@ o1js: string;
 vk: Record<string, {
   data: string;
   hash: string;
-  type: "token" | "admin" | "upgrade" | "user";
+  type: "token" | "admin" | "upgrade" | "user" | "nft" | "collection";
 }>;
 ```
-
-## Defined in
-
-[packages/abi/src/vk/types.ts:1](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/types.ts#L1)
diff --git a/docs/abi.src.TypeAlias.Compilable.md b/docs/abi.src.TypeAlias.Compilable.md
@@ -19,6 +19,8 @@ type Compilable = {
 };
 ```
 
+Defined in: [packages/abi/src/token/contracts.ts:12](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/contracts.ts#L12)
+
 ## Type declaration
 
 ### compile()
@@ -39,7 +41,3 @@ type Compilable = {
      `hash`: `Field`;
     \};
  \}\>
-
-## Defined in
-
-[packages/abi/src/token/contracts.ts:12](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/contracts.ts#L12)
diff --git a/docs/abi.src.TypeAlias.CompileDependencies.md b/docs/abi.src.TypeAlias.CompileDependencies.md
@@ -12,6 +12,4 @@ order: 12
 type CompileDependencies = Record<string, string[]>;
 ```
 
-## Defined in
-
-[packages/abi/src/token/contracts.ts:31](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/contracts.ts#L31)
+Defined in: [packages/abi/src/token/contracts.ts:31](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/contracts.ts#L31)
diff --git a/docs/abi.src.TypeAlias.VerificationKeysList.md b/docs/abi.src.TypeAlias.VerificationKeysList.md
@@ -12,6 +12,4 @@ order: 13
 type VerificationKeysList = Record<"mainnet" | "devnet", ChainVerificationKeysList>;
 ```
 
-## Defined in
-
-[packages/abi/src/vk/types.ts:13](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/types.ts#L13)
+Defined in: [packages/abi/src/vk/types.ts:13](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/types.ts#L13)
diff --git a/docs/abi.src.TypeAlias.blockchain.md b/docs/abi.src.TypeAlias.blockchain.md
@@ -12,8 +12,6 @@ order: 9
 type blockchain = "local" | "devnet" | "lightnet" | "mainnet" | "zeko";
 ```
 
-blockchain is the type for the chain ID.
-
-## Defined in
+Defined in: [packages/abi/src/types.ts:4](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/types.ts#L4)
 
-[packages/abi/src/types.ts:4](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/types.ts#L4)
+blockchain is the type for the chain ID.
diff --git a/docs/abi.src.Variable.LAUNCH_FEE.md b/docs/abi.src.Variable.LAUNCH_FEE.md
@@ -12,6 +12,4 @@ order: 15
 const LAUNCH_FEE: 1000000000 = 1e9;
 ```
 
-## Defined in
-
-[packages/abi/src/fee.ts:1](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/fee.ts#L1)
+Defined in: [packages/abi/src/fee.ts:1](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/fee.ts#L1)
diff --git a/docs/abi.src.Variable.TRANSACTION_FEE.md b/docs/abi.src.Variable.TRANSACTION_FEE.md
@@ -12,6 +12,4 @@ order: 19
 const TRANSACTION_FEE: 100000000 = 1e8;
 ```
 
-## Defined in
-
-[packages/abi/src/fee.ts:2](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/fee.ts#L2)
+Defined in: [packages/abi/src/fee.ts:2](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/fee.ts#L2)
diff --git a/docs/abi.src.Variable.devnet.md b/docs/abi.src.Variable.devnet.md
@@ -12,6 +12,4 @@ order: 14
 const devnet: ChainVerificationKeysList;
 ```
 
-## Defined in
-
-[packages/abi/src/vk/devnet.ts:4](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/devnet.ts#L4)
+Defined in: [packages/abi/src/vk/devnet.ts:4](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/devnet.ts#L4)
diff --git a/docs/abi.src.Variable.mainnet.md b/docs/abi.src.Variable.mainnet.md
@@ -12,6 +12,4 @@ order: 16
 const mainnet: ChainVerificationKeysList;
 ```
 
-## Defined in
-
-[packages/abi/src/vk/mainnet.ts:4](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/mainnet.ts#L4)
+Defined in: [packages/abi/src/vk/mainnet.ts:4](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/mainnet.ts#L4)
diff --git a/docs/abi.src.Variable.tokenContracts.md b/docs/abi.src.Variable.tokenContracts.md
@@ -12,6 +12,4 @@ order: 17
 const tokenContracts: Record<string, Compilable>;
 ```
 
-## Defined in
-
-[packages/abi/src/token/contracts.ts:21](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/contracts.ts#L21)
+Defined in: [packages/abi/src/token/contracts.ts:21](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/token/contracts.ts#L21)
diff --git a/docs/abi.src.Variable.tokenVerificationKeys.md b/docs/abi.src.Variable.tokenVerificationKeys.md
@@ -12,6 +12,4 @@ order: 18
 const tokenVerificationKeys: VerificationKeysList;
 ```
 
-## Defined in
-
-[packages/abi/src/vk/vk.ts:5](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/vk.ts#L5)
+Defined in: [packages/abi/src/vk/vk.ts:5](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/abi/src/vk/vk.ts#L5)
diff --git a/docs/abi.src.md b/docs/abi.src.md
@@ -9,17 +9,15 @@ order: 3
 
 # ABI
 
-## Index
-
-### Type Aliases
+## Type Aliases
 
 - [blockchain](abisrctypealiasblockchain)
 - [ChainVerificationKeysList](abisrctypealiaschainverificationkeyslist)
 - [Compilable](abisrctypealiascompilable)
 - [CompileDependencies](abisrctypealiascompiledependencies)
 - [VerificationKeysList](abisrctypealiasverificationkeyslist)
 
-### Variables
+## Variables
 
 - [devnet](abisrcvariabledevnet)
 - [LAUNCH\_FEE](abisrcvariablelaunch_fee)
@@ -28,9 +26,12 @@ order: 3
 - [tokenVerificationKeys](abisrcvariabletokenverificationkeys)
 - [TRANSACTION\_FEE](abisrcvariabletransaction_fee)
 
-### Functions
+## Functions
 
 - [buildTokenLaunchTransaction](abisrcfunctionbuildtokenlaunchtransaction)
 - [buildTokenTransaction](abisrcfunctionbuildtokentransaction)
+- [checkAddress](abisrcfunctioncheckaddress)
 - [fetchMinaAccount](abisrcfunctionfetchminaaccount)
+- [getContractInfo](abisrcfunctiongetcontractinfo)
 - [getTokenSymbolAndAdmin](abisrcfunctiongettokensymbolandadmin)
+- [tokenBalance](abisrcfunctiontokenbalance)
diff --git a/docs/api.src.Function.airdropTokens.md b/docs/api.src.Function.airdropTokens.md
@@ -3,15 +3,17 @@ title: airdropTokens
 category: 6749c4dba3a7a4005bae1197
 hidden: false
 slug: api.src.Function.airdropTokens
-order: 148
+order: 158
 ---
 
 # Function: airdropTokens()
 
 ```ts
-function airdropTokens<ThrowOnError>(options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & AirdropTokensData & Pick<RequestOptions<ThrowOnError, string>, "headers">): RequestResult<AirdropTransactionResponse, ErrorResponse, ThrowOnError>
+function airdropTokens<ThrowOnError>(options: OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & AirdropTokensData & Pick<RequestOptions<ThrowOnError>, "headers">): RequestResult<AirdropTransactionResponse, ErrorResponse, ThrowOnError>
 ```
 
+Defined in: [packages/api/src/client/sdk.gen.ts:150](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/api/src/client/sdk.gen.ts#L150)
+
 Distribute tokens to multiple addresses via airdrop.
 Allows users to distribute tokens to multiple addresses in a single transaction.
 This is efficient for distributing tokens during events like token launches or community rewards.
@@ -24,12 +26,8 @@ This is efficient for distributing tokens during events like token launches or c
 
 ### options
 
-`OmitKeys`\<`RequestOptions`\<`ThrowOnError`, `string`\>, `"body"` \| `"url"`\> & [`AirdropTokensData`](apisrctypealiasairdroptokensdata) & `Pick`\<`RequestOptions`\<`ThrowOnError`, `string`\>, `"headers"`\>
+`OmitKeys`\<`RequestOptions`\<`ThrowOnError`\>, `"body"` \| `"url"`\> & [`AirdropTokensData`](apisrctypealiasairdroptokensdata) & `Pick`\<`RequestOptions`\<`ThrowOnError`\>, `"headers"`\>
 
 ## Returns
 
 `RequestResult`\<[`AirdropTransactionResponse`](apisrctypealiasairdroptransactionresponse), [`ErrorResponse`](apisrctypealiaserrorresponse), `ThrowOnError`\>
-
-## Defined in
-
-[packages/api/src/client/sdk.gen.ts:139](https://github.com/zkcloudworker/minatokens-lib/blob/main/packages/api/src/client/sdk.gen.ts#L139)