clanker-sdk 3.1.5 → 3.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +1 -1
  2. package/dist/index.d.mts +28 -17
  3. package/dist/index.d.ts +28 -17
  4. package/dist/index.js +635 -221
  5. package/dist/index.mjs +638 -225
  6. package/package.json +4 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Clanker SDK
2
2
 
3
- The official TypeScript SDK for deploying tokens using Clanker v3.1.4.
3
+ The official TypeScript SDK for deploying tokens using Clanker v3.1.6.
4
4
 
5
5
  ## Installation
6
6
 
package/dist/index.d.mts CHANGED
@@ -1,12 +1,12 @@
1
- import { Address, WalletClient } from 'viem';
1
+ import { WalletClient, PublicClient, Address } from 'viem';
2
2
 
3
3
  interface TokenConfig {
4
4
  name: string;
5
5
  symbol: string;
6
6
  salt: `0x${string}`;
7
7
  image: string;
8
- metadata: string;
9
- context: string;
8
+ metadata: IClankerMetadata;
9
+ context: IClankerSocialContext;
10
10
  originatingChainId: bigint;
11
11
  }
12
12
  interface VaultConfig {
@@ -30,21 +30,20 @@ interface RewardsConfig {
30
30
  }
31
31
  interface ClankerConfig {
32
32
  wallet: WalletClient;
33
- factoryAddress: Address;
34
- chainId: number;
33
+ publicClient: PublicClient;
34
+ factoryAddress?: Address;
35
35
  }
36
36
  interface SimpleTokenConfig {
37
37
  name: string;
38
38
  symbol: string;
39
- initialMarketCap: bigint;
40
- initialBuy: bigint;
39
+ image?: string;
40
+ salt?: `0x${string}`;
41
41
  vault?: {
42
42
  percentage: number;
43
43
  durationInDays: number;
44
44
  };
45
- image?: string;
46
- metadata?: string;
47
- context?: string;
45
+ metadata?: IClankerMetadata;
46
+ context?: IClankerSocialContext;
48
47
  }
49
48
  interface DeploymentConfig {
50
49
  tokenConfig: TokenConfig;
@@ -59,8 +58,8 @@ interface DeploymentConfig {
59
58
  symbol: string;
60
59
  salt: `0x${string}`;
61
60
  image: string;
62
- metadata: string;
63
- context: string;
61
+ metadata: IClankerMetadata;
62
+ context: IClankerSocialContext;
64
63
  originatingChainId: bigint;
65
64
  };
66
65
  poolConfig: {
@@ -83,11 +82,24 @@ interface DeploymentConfig {
83
82
  interfaceRewardRecipient: Address;
84
83
  };
85
84
  }
85
+ interface IClankerMetadata {
86
+ description?: string;
87
+ socialMediaUrls?: {
88
+ platform: string;
89
+ url: string;
90
+ }[];
91
+ auditUrls?: string[];
92
+ }
93
+ interface IClankerSocialContext {
94
+ interface: string;
95
+ platform?: string;
96
+ messageId?: string;
97
+ id?: string;
98
+ }
86
99
 
87
100
  declare class Clanker {
88
- private wallet;
89
- private factoryAddress;
90
- private chainId;
101
+ private readonly wallet;
102
+ private readonly factoryAddress;
91
103
  private readonly publicClient;
92
104
  private readonly Q96;
93
105
  private readonly TICK_BASE;
@@ -107,7 +119,6 @@ declare class Clanker {
107
119
  */
108
120
  private log1000196;
109
121
  private calculateTick;
110
- private generateSalt;
111
122
  private handleError;
112
123
  deploy(config: DeploymentConfig): Promise<Address>;
113
124
  /**
@@ -118,4 +129,4 @@ declare class Clanker {
118
129
  deployToken(config: SimpleTokenConfig): Promise<Address>;
119
130
  }
120
131
 
121
- export { Clanker, type ClankerConfig, type DeploymentConfig, type InitialBuyConfig, type PoolConfig, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };
132
+ export { Clanker, type ClankerConfig, type DeploymentConfig, type IClankerMetadata, type IClankerSocialContext, type InitialBuyConfig, type PoolConfig, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };
package/dist/index.d.ts CHANGED
@@ -1,12 +1,12 @@
1
- import { Address, WalletClient } from 'viem';
1
+ import { WalletClient, PublicClient, Address } from 'viem';
2
2
 
3
3
  interface TokenConfig {
4
4
  name: string;
5
5
  symbol: string;
6
6
  salt: `0x${string}`;
7
7
  image: string;
8
- metadata: string;
9
- context: string;
8
+ metadata: IClankerMetadata;
9
+ context: IClankerSocialContext;
10
10
  originatingChainId: bigint;
11
11
  }
12
12
  interface VaultConfig {
@@ -30,21 +30,20 @@ interface RewardsConfig {
30
30
  }
31
31
  interface ClankerConfig {
32
32
  wallet: WalletClient;
33
- factoryAddress: Address;
34
- chainId: number;
33
+ publicClient: PublicClient;
34
+ factoryAddress?: Address;
35
35
  }
36
36
  interface SimpleTokenConfig {
37
37
  name: string;
38
38
  symbol: string;
39
- initialMarketCap: bigint;
40
- initialBuy: bigint;
39
+ image?: string;
40
+ salt?: `0x${string}`;
41
41
  vault?: {
42
42
  percentage: number;
43
43
  durationInDays: number;
44
44
  };
45
- image?: string;
46
- metadata?: string;
47
- context?: string;
45
+ metadata?: IClankerMetadata;
46
+ context?: IClankerSocialContext;
48
47
  }
49
48
  interface DeploymentConfig {
50
49
  tokenConfig: TokenConfig;
@@ -59,8 +58,8 @@ interface DeploymentConfig {
59
58
  symbol: string;
60
59
  salt: `0x${string}`;
61
60
  image: string;
62
- metadata: string;
63
- context: string;
61
+ metadata: IClankerMetadata;
62
+ context: IClankerSocialContext;
64
63
  originatingChainId: bigint;
65
64
  };
66
65
  poolConfig: {
@@ -83,11 +82,24 @@ interface DeploymentConfig {
83
82
  interfaceRewardRecipient: Address;
84
83
  };
85
84
  }
85
+ interface IClankerMetadata {
86
+ description?: string;
87
+ socialMediaUrls?: {
88
+ platform: string;
89
+ url: string;
90
+ }[];
91
+ auditUrls?: string[];
92
+ }
93
+ interface IClankerSocialContext {
94
+ interface: string;
95
+ platform?: string;
96
+ messageId?: string;
97
+ id?: string;
98
+ }
86
99
 
87
100
  declare class Clanker {
88
- private wallet;
89
- private factoryAddress;
90
- private chainId;
101
+ private readonly wallet;
102
+ private readonly factoryAddress;
91
103
  private readonly publicClient;
92
104
  private readonly Q96;
93
105
  private readonly TICK_BASE;
@@ -107,7 +119,6 @@ declare class Clanker {
107
119
  */
108
120
  private log1000196;
109
121
  private calculateTick;
110
- private generateSalt;
111
122
  private handleError;
112
123
  deploy(config: DeploymentConfig): Promise<Address>;
113
124
  /**
@@ -118,4 +129,4 @@ declare class Clanker {
118
129
  deployToken(config: SimpleTokenConfig): Promise<Address>;
119
130
  }
120
131
 
121
- export { Clanker, type ClankerConfig, type DeploymentConfig, type InitialBuyConfig, type PoolConfig, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };
132
+ export { Clanker, type ClankerConfig, type DeploymentConfig, type IClankerMetadata, type IClankerSocialContext, type InitialBuyConfig, type PoolConfig, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };