Skip to content

Latest commit

 

History

History
68 lines (54 loc) · 2.46 KB

stellar.md

File metadata and controls

68 lines (54 loc) · 2.46 KB
Raw

Tokens in Stellar

Instantiate Cryptum SDK first:

const sdk = new CryptumSdk({
  environment: 'testnet',
  apiKey: 'YOUR-API-KEY'
})

Transfer tokens

Transfer tokens in Stellar blockchain.

sdk.token.transfer(opts)

  • opts.protocol (string)(required) - blockchain protocol must be STELLAR.
  • opts.wallet (Wallet)(required) - wallet to sign the transaction with.
  • opts.token (string)(required) - token symbol to transfer or XLM if you're transferring the native token.
  • opts.issuer (string)(optional) - token issuer account. Required only if you're not transferring the native token.
  • opts.amount (string)(required) - token amount to be transferred.
  • opts.destination (string)(required) - destination address.
  • opts.memo (string)(optional) - optional message to be attached with this transaction, otherwise leave it undefined. This memo must be a string up to 28-bytes long or a 32-byte hash.

This function returns the transaction hash.

const { hash } = await sdk.token.transfer({
  protocol: 'STELLAR',
  wallet,
  token: 'FOO',
  issuer: 'GRPT1SJQ2YGR...JKU9DYFZBPAYE'
  destination: 'GARMPVGIGZ4P...SBK8PYV45WTP',
  amount: '7.5',
  memo: ''
})

Establish trustline in Stellar

sdk.token.setTrustline(opts)

Create a trustline transaction in Stellar blockchain. It is used to create or delete assets (trustline). https://developers.stellar.org/docs/issuing-assets/how-to-issue-an-asset/

  • opts.protocol (Wallet)(required) - blockchain protocol must be STELLAR.
  • opts.wallet (Wallet)(required) - wallet to sign the transaction with.
  • opts.symbol (string)(required) - asset symbol.
  • opts.issuer (string)(required) - issuer account to be used in the trustline.
  • opts.limit (string)(required) - limit for the trustline. To create the trustline this limit should be bigger than 0 and to delete the trustline it should be 0.
  • opts.memo (string)(optional) - optional message to be attached with this transaction, otherwise leave it undefined. This memo must be a string up to 28-bytes long or a 32-byte hash.

This function returns the hash of the transaction.

Example:

const { hash } = await sdk.token.setTrustline({
  protocol: 'STELLAR',
  wallet,
  symbol: 'FOO',
  issuer: 'GDTAUZE6T...3EYISAOAPYIQMVP2JO',
  limit: '100000000',
  memo: 'create-trustline',
})