@xchainjs/xchain-radix 0.1.1 → 1.0.1

package/README.md

@@ -14,6 +14,20 @@ Radix module for XChainJS clients
 yarn add @xchainjs/xchain-radix
 ```
 
+## Create a new account
+
+```
+import { generateMnemonic } from 'bip39'
+
+const mnemonic = generateMnemonic()
+const params: XChainClientParams = {
+  network: Network.Testnet,
+  phrase: mnemonic,
+}
+const client = new Client(params)
+const address = await client.getAddressAsync()
+```
+
 ## Fund an account in testnet
 
 ```

package/lib/client.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="node" />
 import { GatewayApiClient, TransactionSubmitResponse } from '@radixdlt/babylon-gateway-api-sdk';
 import { Curve, Intent, NotarizedTransaction, PrivateKey, PublicKey, TransactionHash } from '@radixdlt/radix-engine-toolkit';
-import { AssetInfo, Balance, BaseXChainClient, Fees, Network, PreparedTx, Tx, TxHistoryParams, TxParams, TxsPage, XChainClientParams } from '@xchainjs/xchain-client';
-import { Address, Asset } from '@xchainjs/xchain-util';
+import { AssetInfo, BaseXChainClient, Fees, Network, PreparedTx, TxHistoryParams, XChainClientParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+import { Balance, CompatibleAsset, Tx, TxParams, TxsPage } from './types/radix';
 /**
  * The main client for the Radix network which is then wrapped by the {Client} adapting it to have
  * a {BaseXChainClient} interface.
@@ -95,7 +96,7 @@ export default class Client extends BaseXChainClient {
      * @param {Asset[]} assets - Assets to retrieve the balance for (optional).
      * @returns {Promise<Balance[]>} An array containing the balance of the address.
      */
-    getBalance(address: Address, assets?: Asset[]): Promise<Balance[]>;
+    getBalance(address: Address, assets?: CompatibleAsset[]): Promise<Balance[]>;
     /**
      * Get transaction history of a given address with pagination options.
      * @param {TxHistoryParams} params The options to get transaction history. (optional)

package/lib/index.esm.js

@@ -2,7 +2,7 @@ import { GatewayApiClient } from '@radixdlt/babylon-gateway-api-sdk';
 import { NetworkId, PrivateKey, generateRandomNonce, RadixEngineToolkit, Convert, ManifestBuilder, decimal, address, bucket, enumeration, PublicKey, LTSRadixEngineToolkit, TransactionBuilder } from '@radixdlt/radix-engine-toolkit';
 import { Network, BaseXChainClient, singleFee, FeeType, TxType } from '@xchainjs/xchain-client';
 import { getSeed } from '@xchainjs/xchain-crypto';
-import { assetToBase, assetAmount, baseAmount } from '@xchainjs/xchain-util';
+import { AssetType, assetToBase, assetAmount, baseAmount } from '@xchainjs/xchain-util';
 import { bech32m } from 'bech32';
 import BIP32Factory from 'bip32';
 import { derivePath } from 'ed25519-hd-key';
@@ -13909,13 +13909,13 @@ const XRD_DECIMAL = 18;
 const XrdAssetMainnet = {
     symbol: 'resource_tdx_2_1tknxxxxxxxxxradxrdxxxxxxxxx009923554798xxxxxxxxxtfd2jc',
     ticker: 'XRD',
-    synth: false,
+    type: AssetType.NATIVE,
     chain: RadixChain,
 };
 const XrdAssetStokenet = {
     symbol: 'resource_tdx_2_1tknxxxxxxxxxradxrdxxxxxxxxx009923554798xxxxxxxxxtfd2jc',
     ticker: 'XRD',
-    synth: false,
+    type: AssetType.NATIVE,
     chain: RadixChain,
 };
 const xrdRootDerivationPaths = {
@@ -14033,7 +14033,7 @@ class RadixSpecificClient {
                             chain: RadixChain,
                             symbol: item.resource_address,
                             ticker: item.resource_address,
-                            synth: false,
+                            type: AssetType.TOKEN,
                         };
                         const divisibility = divisibilities.get(item.resource_address) || 0;
                         // We need to do this because item.amount can be either string or number
@@ -14533,7 +14533,7 @@ class Client extends BaseXChainClient {
                         from.push({
                             from: withdrawAccount,
                             amount: baseAmount(withdrawAmount),
-                            asset: { symbol: withdrawResource, ticker: withdrawResource, synth: false, chain: RadixChain },
+                            asset: { symbol: withdrawResource, ticker: withdrawResource, type: AssetType.TOKEN, chain: RadixChain },
                         });
                     }
                 }
@@ -14544,7 +14544,7 @@ class Client extends BaseXChainClient {
                         to.push({
                             to: depositAccount,
                             amount: baseAmount(depositAmount),
-                            asset: { symbol: depositResource, ticker: depositResource, synth: false, chain: RadixChain },
+                            asset: { symbol: depositResource, ticker: depositResource, type: AssetType.TOKEN, chain: RadixChain },
                         });
                     }
                 }
@@ -14554,7 +14554,7 @@ class Client extends BaseXChainClient {
                     date: confirmed_at,
                     type: TxType.Transfer,
                     hash: intent_hash,
-                    asset: { symbol: '', ticker: '', synth: false, chain: RadixChain },
+                    asset: { symbol: '', ticker: '', type: AssetType.TOKEN, chain: RadixChain },
                 };
                 return transaction;
             }

package/lib/index.js

@@ -13921,13 +13921,13 @@ const XRD_DECIMAL = 18;
 const XrdAssetMainnet = {
     symbol: 'resource_tdx_2_1tknxxxxxxxxxradxrdxxxxxxxxx009923554798xxxxxxxxxtfd2jc',
     ticker: 'XRD',
-    synth: false,
+    type: xchainUtil.AssetType.NATIVE,
     chain: RadixChain,
 };
 const XrdAssetStokenet = {
     symbol: 'resource_tdx_2_1tknxxxxxxxxxradxrdxxxxxxxxx009923554798xxxxxxxxxtfd2jc',
     ticker: 'XRD',
-    synth: false,
+    type: xchainUtil.AssetType.NATIVE,
     chain: RadixChain,
 };
 const xrdRootDerivationPaths = {
@@ -14045,7 +14045,7 @@ class RadixSpecificClient {
                             chain: RadixChain,
                             symbol: item.resource_address,
                             ticker: item.resource_address,
-                            synth: false,
+                            type: xchainUtil.AssetType.TOKEN,
                         };
                         const divisibility = divisibilities.get(item.resource_address) || 0;
                         // We need to do this because item.amount can be either string or number
@@ -14545,7 +14545,7 @@ class Client extends xchainClient.BaseXChainClient {
                         from.push({
                             from: withdrawAccount,
                             amount: xchainUtil.baseAmount(withdrawAmount),
-                            asset: { symbol: withdrawResource, ticker: withdrawResource, synth: false, chain: RadixChain },
+                            asset: { symbol: withdrawResource, ticker: withdrawResource, type: xchainUtil.AssetType.TOKEN, chain: RadixChain },
                         });
                     }
                 }
@@ -14556,7 +14556,7 @@ class Client extends xchainClient.BaseXChainClient {
                         to.push({
                             to: depositAccount,
                             amount: xchainUtil.baseAmount(depositAmount),
-                            asset: { symbol: depositResource, ticker: depositResource, synth: false, chain: RadixChain },
+                            asset: { symbol: depositResource, ticker: depositResource, type: xchainUtil.AssetType.TOKEN, chain: RadixChain },
                         });
                     }
                 }
@@ -14566,7 +14566,7 @@ class Client extends xchainClient.BaseXChainClient {
                     date: confirmed_at,
                     type: xchainClient.TxType.Transfer,
                     hash: intent_hash,
-                    asset: { symbol: '', ticker: '', synth: false, chain: RadixChain },
+                    asset: { symbol: '', ticker: '', type: xchainUtil.AssetType.TOKEN, chain: RadixChain },
                 };
                 return transaction;
             }

package/lib/types/radix.d.ts

@@ -1,3 +1,6 @@
+import { Balance as BaseBalance, Tx as BaseTx, TxFrom as BaseTxFrom, TxParams as BaseTxParams, TxTo as BaseTxTo, TxsPage as BaseTxsPage } from '@xchainjs/xchain-client';
+import { Asset, TokenAsset } from '@xchainjs/xchain-util';
+export type CompatibleAsset = Asset | TokenAsset;
 export type Transaction = {
     manifest: string;
     start_epoch_inclusive: number;
@@ -16,4 +19,39 @@ type TransactionFlag = {
     assume_all_signature_proofs: boolean;
     skip_epoch_check: boolean;
 };
+/**
+ * Radix balance
+ */
+export type Balance = BaseBalance & {
+    asset: CompatibleAsset;
+};
+/**
+ * Type definition for the sender of a Radix transaction.
+ */
+export type TxFrom = BaseTxFrom & {
+    asset?: CompatibleAsset;
+};
+/**
+ * Type definition for the recipient of a Radix transaction.
+ */
+export type TxTo = BaseTxTo & {
+    asset?: CompatibleAsset;
+};
+/**
+ * Type definition for a Radix transaction.
+ */
+export type Tx = BaseTx & {
+    asset: CompatibleAsset;
+    from: TxFrom[];
+    to: TxTo[];
+};
+/**
+ * Type definition for a page of Radix transactions.
+ */
+export type TxsPage = BaseTxsPage & {
+    txs: Tx[];
+};
+export type TxParams = BaseTxParams & {
+    asset?: CompatibleAsset;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-radix",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "description": "Custom Radix client and utilities used by XChainJS clients",
   "keywords": [
     "XRD",
@@ -44,6 +44,7 @@
     "@xchainjs/xchain-util": "workspace:*",
     "bech32": "^2.0.0",
     "bip32": "^4.0.0",
+    "bip39": "^3.1.0",
     "ed25519-hd-key": "^1.3.0"
   }
 }