{"_id":"@d11k-ts/dojima","_rev":"2-cc2de0667e7a20fc5c9c5fe2bf382043","name":"@d11k-ts/dojima","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@d11k-ts/dojima","version":"0.1.0","description":"dojima module for d11k chain","keywords":["d11k","dojima"],"author":{"name":"yerramreddyuday","email":"uday.prasad@dojima.network"},"homepage":"https://github.com/dojimanetwork/d11k-ts#readme","license":"ISC","main":"lib/index.js","module":"lib/index.esm.js","typings":"lib/index.d.ts","publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/dojimanetwork/d11k-ts.git"},"scripts":{"clean":"rimraf lib/**","build":"yarn && yarn clean && rollup -c","test":"jest","lint":"eslint \"{src,__tests__, __mocks__}/**/*.ts\" --fix --max-warnings 0","prepublishOnly":"yarn build"},"bugs":{"url":"https://github.com/dojimanetwork/d11k-ts/issues"},"dependencies":{"@d11k-ts/client":"^0.1.5","@d11k-ts/crypto":"^0.1.1","bignumber.js":"^9.1.1","ethers":"^5.7.2","web3":"^1.8.1"},"devDependencies":{},"peerDependencies":{"@d11k-ts/client":"^0.1.5","@d11k-ts/crypto":"^0.1.1","bignumber.js":"^9.1.1","ethers":"^5.7.2","web3":"^1.8.1"},"_id":"@d11k-ts/dojima@0.1.0","dist":{"shasum":"84b24b028b8df50d1324ae4a562dbd7b99fc565c","integrity":"sha512-VlIQVh9Yjpvs35cVOtY84RrCd64Jumnk52SxoIN7M/QStuEEKs3tNDShZiwi7evP8doo+c72X4XJebQhZQ8tsA==","tarball":"https://registry.npmjs.org/@d11k-ts/dojima/-/dojima-0.1.0.tgz","fileCount":12,"unpackedSize":62417,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD3oZGDRvUFm2m816jzNAlkiX8Tfvdz8d5cGzFEGqNaCgIgNLJPbk+jAuc7a24jThI6sqpXajzFlp8RoVNdO6LlrUY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvUGcACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq/5RAAmIiYtuyLcsHn28JS3qfICaghWKuyEz5qSEUHDY+RvxDtPsG9\r\nF11kOxeFG0GO4rwngjrlsubycZOlcr2u+p7GzVZcNue19ZCjcpLrVOVXoQtV\r\nlF00nVf9/wn+Jq+HJEDiOY+/VVOTu424VMZvrF72aI9GHmgUeutnQdOOLcAX\r\nlRdEc0pVZfkdLpMJX5JQrwk3uLU2CGio6uVFXmbDqqaNEzDnrW25q6oalnGV\r\nYqWK8mnzk6/II4wh6H4xVns7QqVYBeFfeJhZh2g8AGS+bUn4s94AfrYPoRi1\r\n+W26VyDjGR7+FHriZM+8cU3p2xCSTyn07xkg62SDBkghJpc6mlsraab8nkjC\r\nVaNIiDU2FW1jeK4XaMPFEcjuRM87Vj4MKec1bqz8k/gkd+Jtb7otQXc7rHRW\r\nh5jNLMawCwW66fAnU0Dz4VhOjUTEM+ZO7L4/CMv03cClRQ2XRURYPsCV1P/n\r\nbtm1bMZk1nrDcvZLGbxxjAJ4yruobEdqxaUvA850FMC8n9BP29Z6GUmvVFsD\r\nrUpeeqcsIifuPqKNXvKmWfGqTthZFm/PYBHrsuQYWw2aFoepjscgNcc1EfbY\r\nFQCCK1Y9RLRTGOc5KyJ0MF5/4FJt8t/tBqxbT5nBpy7DipNSxK7zrE0EeJDj\r\n4EO3+AyfMww0tleVYz6A33cqoeSCoIpeOHA=\r\n=Re9c\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"dojima-network","email":"dojimanetwork@gmail.com"},"directories":{},"maintainers":[{"name":"dojima-network","email":"dojimanetwork@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dojima_0.1.0_1673347484439_0.45456108819082375"},"_hasShrinkwrap":false},"0.1.1":{"name":"@d11k-ts/dojima","version":"0.1.1","description":"dojima module for d11k chain","keywords":["d11k","dojima"],"author":{"name":"yerramreddyuday","email":"uday.prasad@dojima.network"},"homepage":"https://github.com/dojimanetwork/d11k-ts#readme","license":"ISC","main":"lib/index.js","module":"lib/index.esm.js","typings":"lib/index.d.ts","publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/dojimanetwork/d11k-ts.git"},"scripts":{"clean":"rimraf lib/**","build":"yarn && yarn clean && rollup -c","test":"jest","lint":"eslint \"{src,__tests__, __mocks__}/**/*.ts\" --fix --max-warnings 0","prepublishOnly":"yarn build"},"bugs":{"url":"https://github.com/dojimanetwork/d11k-ts/issues"},"dependencies":{"@d11k-ts/client":"^0.1.6","@d11k-ts/crypto":"^0.1.1","bignumber.js":"^9.1.1","ethers":"^5.7.2","web3":"^1.8.1"},"devDependencies":{},"peerDependencies":{"@d11k-ts/client":"^0.1.6","@d11k-ts/crypto":"^0.1.1","bignumber.js":"^9.1.1","ethers":"^5.7.2","web3":"^1.8.1"},"_id":"@d11k-ts/dojima@0.1.1","dist":{"shasum":"df49e6a9f19590b0d6b5555b441880cf28e8c908","integrity":"sha512-LfawDxuuPeu6L+Z5hlBxkPyjrRUpm04ulJwicyse6F88lyFade7WA9k2HmIn+vvr7MUxtwTHupYPZhKdruK/ug==","tarball":"https://registry.npmjs.org/@d11k-ts/dojima/-/dojima-0.1.1.tgz","fileCount":12,"unpackedSize":62187,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDVCrB+0iRKYU36iQqEVflPdO01hN/+m4HS3bqXyKr/kgIgB3yId/3rLlUedJcKDGdXBTcoOUavaVihigIKNi8vBEw="}]},"_npmUser":{"name":"yerramreddyuday","email":"uday.prasad@dojima.network"},"directories":{},"maintainers":[{"name":"yerramreddyuday","email":"uday.prasad@dojima.network"},{"name":"dojima-network","email":"dojimanetwork@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dojima_0.1.1_1686196178223_0.4350925685719722"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-10T10:44:44.316Z","0.1.0":"2023-01-10T10:44:44.633Z","modified":"2023-06-08T03:49:38.632Z","0.1.1":"2023-06-08T03:49:38.493Z"},"maintainers":[{"name":"yerramreddyuday","email":"uday.prasad@dojima.network"},{"name":"dojima-network","email":"dojimanetwork@gmail.com"}],"description":"dojima module for d11k chain","homepage":"https://github.com/dojimanetwork/d11k-ts#readme","keywords":["d11k","dojima"],"repository":{"type":"git","url":"git+https://github.com/dojimanetwork/d11k-ts.git"},"author":{"name":"yerramreddyuday","email":"uday.prasad@dojima.network"},"bugs":{"url":"https://github.com/dojimanetwork/d11k-ts/issues"},"license":"ISC","readme":"# `@d11k-ts/dojima`\n\n## Modules\n\n- `client` - Custom client for communicating with Dojima by using [`web3`](https://github.com/ethereum/web3.js) and [`ethers`](https://github.com/ethers-io/ethers.js)\n\n## Installation\n\n```\nyarn add @d11k-ts/dojima\n```\n\n## Documentation : Basic usage examples\n\n### Connect wallet to new DojimaClient\n\n- Create new DojimaClient client\n- Network default is `Mainnet`\n- InfuraApiKey: Optional (Api key provided by 'Infura' for mainnet calls. Sign up for getting one)\n\n```ts\n// Imports\nimport {Network} from '@d11k-ts/client'\nimport {DojimaClient} from '@d11k-ts/dojima'\n\n//Connect wallet, validate address and check balance \nconst connectWallet = async () => {\n  let phrase = \"phrase\"\n  // Mainnet\n  const dojClient = new DojimaClient({\n    phrase\n  })\n  // DojTestnet\n  // const dojClient = new DojimaClient({ \n  //    phrase, \n  //    network: Network.DojTestnet,\n  //    rpcUrl: 'https://api-test.d11k.dojima.network:8545/',\n  //  })\n  let address = dojClient.getAddress()\n  try {\n    const balance = await dojClient.getBalance(address)\n    console.log(`Adress: ${address} with balance ${balance}`)\n\n  } catch (error) {\n    console.log(`Caught: ${error} `)\n  }\n}\n```\n\n### Transfer doj using DojimaClient\n\n- Create new DojimaClient instance\n- Returns txHash as string\n- Note: Uses only required gas for Tx and remaining will be sent back\n\n```ts\nconst transferDoj = async () => {\n  // First initiate DojimaClient\n  let amount = 0.001\n  let recipient = 'insert address'\n  console.log(\"Building transaction\")\n  try {\n    const txid = await dojClient.transfer({\n      amount,\n      recipient,\n      // fee: number,  // optional. Calculated by default(if not provided) based on input amount.\n      // memo: string,  // optional\n    })\n    console.log(`Transaction sent: ${txid}`)\n    return txid\n  } catch (error) {\n    console.log(`Caught: ${error} `)\n  }\n}\n```\n\n### Get transaction Data\n\n- Create new DojimaClient instance\n- Call getTransactionData(hash) returns hash-details\n\n```ts\n// Retrieve transaction data for a particular hash\nconst transactionData = async () => {\n  let hash = \"insert hash\"\n  try {\n    const txData = await dojClient.getTransactionData(\n      hash,\n    )\n    console.log(`Transaction data ${txData}`)\n  } catch (error) {\n    console.log(`Caught: ${error} `)\n  }\n}\n```\n\n### Get transfer Fees estimations\n\n- Retrieve estimated gas fees from dojima client\n\n```ts\n// Retrieve fee estimations from transaction parameters\nconst feeEstimations = async () => {\n  let amountToTransfer = 0.001\n  try {\n    const fees = await dojClient.gasFees({\n      amount: amount,\n      // memo: string          // optional\n    })\n    console.log(`Fees : ${fees}`)\n\n  } catch (error) {\n    console.log(`Caught: ${error} `)\n  }\n}\n```\n\n### Example Code\n\nFor sample code check out example test case in `./examples/test.ts`","readmeFilename":"README.md"}