infra-sdk-typescript 0.1.3 → 0.2.0

package/dist/index.d.ts

@@ -477,40 +477,43 @@ interface MintTokenParams {
 interface TransferTokenParams {
     tokenId: string;
     chainId: string;
+    /** HD address index of the sending holder wallet. */
+    fromAddressIndex: number;
+    toAddress: string;
+    /** Amount to transfer, in token units. */
+    amount: number;
+    memo?: string;
+}
+interface ForcedTransferTokenParams {
+    tokenId: string;
+    chainId: string;
+    /** Holder address to move tokens out of. */
     fromAddress: string;
     toAddress: string;
     /** Amount to transfer, in token units. */
     amount: number;
     memo?: string;
 }
-/** Result of {@link TokenizationResource.mintToken} / {@link TokenizationResource.burnToken}. */
+/**
+ * Result of {@link TokenizationResource.mintToken} / {@link TokenizationResource.burnToken} /
+ * {@link TokenizationResource.forcedTransfer}.
+ */
 interface TokenOperationResult {
     operationRef: string;
     transactionId: string;
     txHash: string;
 }
-/** Result of {@link TokenizationResource.transferToken} — the settled on-chain transfer record. */
+/** Result of {@link TokenizationResource.transferToken}. */
 interface TokenTransferResult {
-    id: string;
-    type: string;
-    chainType: ChainType;
-    network: Network;
-    chainId: number;
-    signerType: string;
-    fromAddress: string;
-    addressIndex: number | null;
+    tokenId: string;
+    status: TokenTransactionStatus;
+    transactionId: string;
+    fromAddressIndex: number;
     toAddress: string;
-    /** Amount in token units, as a decimal string. */
-    amount: string;
-    tokenAddress: string | null;
-    data: string | null;
-    value: string | null;
+    /** Amount transferred, in token units. */
+    amount: number;
     txHash: string;
-    status: TokenTransactionStatus;
-    gasUsed: string | null;
-    feeWei: string | null;
-    createdAt: string;
-    updatedAt: string;
+    operationRef: string;
 }
 interface RegisterTokenWalletParams {
     tokenId: string;
@@ -533,6 +536,21 @@ interface TokenHolder {
     /** Balance in token units, as a decimal string. */
     balance: string;
 }
+interface GetWalletBalanceParams {
+    tokenId: string;
+    chainId: string;
+    walletAddress: string;
+}
+/** A single wallet's balance of a token, returned by {@link TokenizationResource.getWalletBalance}. */
+interface TokenWalletBalance {
+    tokenId: string;
+    ticker: string;
+    chainId: string;
+    walletAddress: string;
+    /** Balance in token units, as a decimal string. */
+    balance: string;
+    decimals: number;
+}
 interface ListTokenTransactionsParams {
     tokenId?: string;
     chainId?: string;
@@ -630,7 +648,7 @@ declare class TokenizationResource extends APIResource {
      * {@link getToken} until `status` is `ACTIVE`. Supply `yieldParams` for a
      * `YIELD_BEARING` token.
      */
-    createToken(params: CreateTokenParams, overrides?: RequestOverrides): Promise<TokenDeploymentResult>;
+    createToken(params: CreateTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenDeploymentResult>;
     /**
      * Returns a paginated list of tokens for the calling project.
      *
@@ -643,15 +661,23 @@ declare class TokenizationResource extends APIResource {
     /** Fetches a single token by id, including its per-chain deployment details. */
     getToken(id: string, overrides?: RequestOverrides): Promise<TokenDetail>;
     /** Mints new units of a token to a recipient address. */
-    mintToken(params: MintTokenParams, overrides?: RequestOverrides): Promise<TokenOperationResult>;
+    mintToken(params: MintTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
     /** Burns units of a token from a holder address. */
-    burnToken(params: BurnTokenParams, overrides?: RequestOverrides): Promise<TokenOperationResult>;
+    burnToken(params: BurnTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
     /** Transfers token units between holder addresses. */
-    transferToken(params: TransferTokenParams, overrides?: RequestOverrides): Promise<TokenTransferResult>;
+    transferToken(params: TransferTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenTransferResult>;
+    /**
+     * Force-transfers token units out of a holder's address without the holder's signature
+     * (issuer/admin compliance action, e.g. recovery or court order). An `Idempotency-Key` is
+     * generated per call unless you pass your own.
+     */
+    forcedTransfer(params: ForcedTransferTokenParams, overrides?: IdempotentRequestOverrides): Promise<TokenOperationResult>;
     /** Registers (whitelists) a wallet address so it can hold a given token. */
-    registerWallet(params: RegisterTokenWalletParams, overrides?: RequestOverrides): Promise<RegisterTokenWalletResult>;
+    registerWallet(params: RegisterTokenWalletParams, overrides?: IdempotentRequestOverrides): Promise<RegisterTokenWalletResult>;
     /** Returns the paginated list of holder wallet addresses and balances for a token on a chain. */
     getTokenHolders(params: GetTokenHoldersParams, overrides?: RequestOverrides): Promise<Page<TokenHolder>>;
+    /** Returns a single wallet's balance of a token on a chain. */
+    getWalletBalance(params: GetWalletBalanceParams, overrides?: RequestOverrides): Promise<TokenWalletBalance>;
     /** Fetches a single token transaction by its reference. */
     getTokenTransaction(ref: string, overrides?: RequestOverrides): Promise<TokenTransactionRecord>;
     /** Returns token transactions, optionally filtered by token. */
@@ -659,13 +685,13 @@ declare class TokenizationResource extends APIResource {
     /** Updates the annual yield rate for a yield-bearing token. */
     updateYield(params: UpdateTokenYieldParams, overrides?: RequestOverrides): Promise<YieldTxResult>;
     /** Funds and distributes a yield payout to holders. Unclaimed funds may be reclaimed after `reclaimAfter`. */
-    distributeYield(params: DistributeYieldParams, overrides?: RequestOverrides): Promise<YieldOperationResult>;
+    distributeYield(params: DistributeYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Pays the scheduled coupon for a yield-bearing token. Set `pushYield` to push funds rather than let investors claim. */
-    payCoupon(params: PayCouponParams, overrides?: RequestOverrides): Promise<YieldOperationResult>;
+    payCoupon(params: PayCouponParams, overrides?: IdempotentRequestOverrides): Promise<YieldOperationResult>;
     /** Claims an investor's yield for a given distribution snapshot. */
-    claimYield(params: ClaimYieldParams, overrides?: RequestOverrides): Promise<YieldTxResult>;
+    claimYield(params: ClaimYieldParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
     /** Redeems principal to holders at maturity. Set `pushYield` to push funds rather than let investors claim. */
-    redeemPrincipal(params: RedeemPrincipalParams, overrides?: RequestOverrides): Promise<YieldTxResult>;
+    redeemPrincipal(params: RedeemPrincipalParams, overrides?: IdempotentRequestOverrides): Promise<YieldTxResult>;
 }
 
 type SubscriptionStatus = LooseUnion<"active" | "paused" | "deleted">;

package/dist/index.js

@@ -570,11 +570,13 @@ var TokenizationResource = class extends APIResource {
    * `YIELD_BEARING` token.
    */
   async createToken(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /**
@@ -604,38 +606,61 @@ var TokenizationResource = class extends APIResource {
   }
   /** Mints new units of a token to a recipient address. */
   async mintToken(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/mint",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Burns units of a token from a holder address. */
   async burnToken(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/burn",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Transfers token units between holder addresses. */
   async transferToken(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/transfer",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
+    });
+  }
+  /**
+   * Force-transfers token units out of a holder's address without the holder's signature
+   * (issuer/admin compliance action, e.g. recovery or court order). An `Idempotency-Key` is
+   * generated per call unless you pass your own.
+   */
+  async forcedTransfer(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
+    return this.client.request({
+      method: "POST",
+      path: "/v1/tokens/forced-transfer",
+      body: params,
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Registers (whitelists) a wallet address so it can hold a given token. */
   async registerWallet(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/register-wallet",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Returns the paginated list of holder wallet addresses and balances for a token on a chain. */
@@ -648,6 +673,15 @@ var TokenizationResource = class extends APIResource {
     }).then((raw) => pageFromFlatResponse(raw, fetchPage));
     return fetchPage({ page: params.page, pageSize: params.pageSize });
   }
+  /** Returns a single wallet's balance of a token on a chain. */
+  async getWalletBalance(params, overrides = {}) {
+    return this.client.request({
+      method: "GET",
+      path: "/v1/tokens/balance",
+      query: { ...params },
+      ...overrides
+    });
+  }
   /** Fetches a single token transaction by its reference. */
   async getTokenTransaction(ref, overrides = {}) {
     return this.client.request({
@@ -677,38 +711,46 @@ var TokenizationResource = class extends APIResource {
   }
   /** Funds and distributes a yield payout to holders. Unclaimed funds may be reclaimed after `reclaimAfter`. */
   async distributeYield(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/yield/distribute",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Pays the scheduled coupon for a yield-bearing token. Set `pushYield` to push funds rather than let investors claim. */
   async payCoupon(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/yield/pay-coupon",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Claims an investor's yield for a given distribution snapshot. */
   async claimYield(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/yield/claim",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
   /** Redeems principal to holders at maturity. Set `pushYield` to push funds rather than let investors claim. */
   async redeemPrincipal(params, overrides = {}) {
+    const { idempotencyKey, ...rest } = overrides;
     return this.client.request({
       method: "POST",
       path: "/v1/tokens/yield/redeem",
       body: params,
-      ...overrides
+      idempotencyKey: idempotencyKey ?? generateIdempotencyKey(),
+      ...rest
     });
   }
 };