Neatly Packaged Manuals

    iou-issuer
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.3 • Public • Published

    iou-issuer

    Issue and send IOUs on the XRP Ledger

    oclif Version Downloads/week License

    Usage

    $ npm install -g iou-issuer
    $ iou-issuer COMMAND
    running command...
    $ iou-issuer (-v|--version|version)
    iou-issuer/0.0.3 darwin-x64 node-v12.18.3
    $ iou-issuer --help [COMMAND]
    USAGE
      $ iou-issuer COMMAND
    ...

    Commands

    iou-issuer default-ripple ACCOUNT SECRET

    Enable rippling on the trust lines of an account

    USAGE
      $ iou-issuer default-ripple ACCOUNT SECRET
    
    ARGUMENTS
      ACCOUNT  Account Address
      SECRET   Secret
    
    OPTIONS
      -h, --help              show CLI help
      -s, --server=server     [default: wss://s.altnet.rippletest.net:51233] rippled server
      -v, --value=true|false  [default: true] Value of DefaultRipple
    
    EXAMPLE
      $ iou-issuer default-ripple rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD sshcfshUQBZHVtTVrFCdYHcZzYefN
      accepted: true
      account_sequence_available: 10489006
      account_sequence_next: 10489006
      applied: true
      broadcast: true
      engine_result: tesSUCCESS
      engine_result_code: 0
      engine_result_message: The transaction was applied. Only final in a validated ledger.
      kept: true
      open_ledger_cost: 10
      queued: false
      tx_blob: 
      12000322800000002400A00CAD201B00A00F5C20210000000868400000000000000C732103424E00965CD2E2528E69A947BE148F7E0DFE99377F9F
      2A6F991BA53DDF83D51274473045022100D9274BBA67E14F6DB420E7BB29B74BDFDD2AF2290AA0ADC1759B33BAB8749CC602206AD6A1C58EF3DEF5
      3807F000B0E15A087D79F34114C0DA9C37193BAD36A934638114A02CAD0E2EDDACEA4B7C3AF520A0791E1DFDA04E
      tx_json: 
      {"Account":"rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD","Fee":"12","Flags":2147483648,"LastLedgerSequence":10489692,"Sequence"
      :10489005,"SetFlag":8,"SigningPubKey":"03424E00965CD2E2528E69A947BE148F7E0DFE99377F9F2A6F991BA53DDF83D512","Transactio
      nType":"AccountSet","TxnSignature":"3045022100D9274BBA67E14F6DB420E7BB29B74BDFDD2AF2290AA0ADC1759B33BAB8749CC602206AD6
      A1C58EF3DEF53807F000B0E15A087D79F34114C0DA9C37193BAD36A93463","hash":"99D7251014D252B5CC18F91F49AF5C9340D3A822CAD548C9
      23B94F65A49DFA4D"}
      validated_ledger_index: 10489689
    

    See code: src/commands/default-ripple.ts

    iou-issuer hello [FILE]

    describe the command here

    USAGE
      $ iou-issuer hello [FILE]
    
    OPTIONS
      -f, --force
      -h, --help       show CLI help
      -n, --name=name  name to print
    
    EXAMPLE
      $ iou-issuer hello
      hello world from ./src/hello.ts!
    

    See code: src/commands/hello.ts

    iou-issuer help [COMMAND]

    display help for iou-issuer

    USAGE
      $ iou-issuer help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    iou-issuer send ACCOUNT SECRET

    Send payment

    USAGE
      $ iou-issuer send ACCOUNT SECRET
    
    ARGUMENTS
      ACCOUNT  Account Address
      SECRET   Secret
    
    OPTIONS
      -c, --currency=currency        [default: XRP] Amount currency to send
      -d, --destination=destination  (required) Destination account address
      -h, --help                     show CLI help
      -s, --server=server            [default: wss://s.altnet.rippletest.net:51233] rippled server
      -v, --value=value              (required) Amount value to send
    
    EXAMPLE
      $ iou-issuer send rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD sshcfshUQBZHVtTVrFCdYHcZzYefN   
      --destination=r9vYkdnueogdPSZ4pT9tyXpxtjX2P31nP3 --value=100 --currency=USD
      accepted: true
      account_sequence_available: 10489010
      account_sequence_next: 10489010
      applied: true
      broadcast: true
      engine_result: tesSUCCESS
      engine_result_code: 0
      engine_result_message: The transaction was applied. Only final in a validated ledger.
      kept: true
      open_ledger_cost: 10
      queued: false
      tx_blob: 
      12000022800000002400A00CB1201B00A0243D61D5038D7EA4C680000000000000000000000000005553440000000000A02CAD0E2EDDACEA4B7C3A
      F520A0791E1DFDA04E68400000000000000C69D5038D7EA4C680000000000000000000000000005553440000000000A02CAD0E2EDDACEA4B7C3AF5
      20A0791E1DFDA04E732103424E00965CD2E2528E69A947BE148F7E0DFE99377F9F2A6F991BA53DDF83D51274473045022100875E3E2DDBE2EA303B
      823760101AD25380E0BB75ABC9AC6A037B7D3F1E7C2A3E0220224732931413EE220D03BF8B58259CE6362E4D756D5490B8DCFC6D3314861CAE8114
      A02CAD0E2EDDACEA4B7C3AF520A0791E1DFDA04E831461E18EBCCCA6BC1A10B43DB3AB7C5AE939AFA161
      tx_json: 
      {"Account":"rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD","Amount":{"currency":"USD","issuer":"rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQB
      D","value":"100"},"Destination":"r9vYkdnueogdPSZ4pT9tyXpxtjX2P31nP3","Fee":"12","Flags":2147483648,"LastLedgerSequence
      ":10495037,"SendMax":{"currency":"USD","issuer":"rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD","value":"100"},"Sequence":1048900
      9,"SigningPubKey":"03424E00965CD2E2528E69A947BE148F7E0DFE99377F9F2A6F991BA53DDF83D512","TransactionType":"Payment","Tx
      nSignature":"3045022100875E3E2DDBE2EA303B823760101AD25380E0BB75ABC9AC6A037B7D3F1E7C2A3E0220224732931413EE220D03BF8B582
      59CE6362E4D756D5490B8DCFC6D3314861CAE","hash":"470BEAD95B008EE18431B2010898474D8A7A7FA2151A4ACB2D1A9A547F69908C"}
      validated_ledger_index: 10495034
    

    See code: src/commands/send.ts

    iou-issuer trust ACCOUNT SECRET

    Create trust line: Trust an account up to the specified amount of currency

    USAGE
      $ iou-issuer trust ACCOUNT SECRET
    
    ARGUMENTS
      ACCOUNT  Account Address
      SECRET   Secret
    
    OPTIONS
      -c, --currency=currency  (required) Currency of trust line
      -h, --help               show CLI help
      -i, --issuer=issuer      (required) Issuer account address
      -s, --server=server      [default: wss://s.altnet.rippletest.net:51233] rippled server
      -v, --value=value        (required) Limit of trust line
    
    EXAMPLE
      $ iou-issuer trust r9vYkdnueogdPSZ4pT9tyXpxtjX2P31nP3 sawFJgo2bqcUBH2utvhSZV6FfsfSk   
      --issuer=rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD --value=100 --currency=USD
      accepted: true
      account_sequence_available: 10490189
      account_sequence_next: 10490189
      applied: true
      broadcast: true
      engine_result: tesSUCCESS
      engine_result_code: 0
      engine_result_message: The transaction was applied. Only final in a validated ledger.
      kept: true
      open_ledger_cost: 10
      queued: false
      tx_blob: 
      12001422800000002400A0114C201B00A023D163D5438D7EA4C680000000000000000000000000005553440000000000A02CAD0E2EDDACEA4B7C3A
      F520A0791E1DFDA04E68400000000000000C7321026E2F3E476282A3A6B3A2FDE75FF032BB7299336B4368B04B0BCFA58094AE9339744730450221
      00FEA8F2E555EFB8128C3200ADE1D8EE7874A8FFD2F2FED617F2847A897806A52B02206E581D79A45AD9B2CA40DC14614305035E1E6779B8A153FA
      1D921FF9A14B508E811461E18EBCCCA6BC1A10B43DB3AB7C5AE939AFA161
      tx_json: 
      {"Account":"r9vYkdnueogdPSZ4pT9tyXpxtjX2P31nP3","Fee":"12","Flags":2147483648,"LastLedgerSequence":10494929,"LimitAmou
      nt":{"currency":"USD","issuer":"rEbvdqTyRZVvYun1zdNU5pqZgWdNZRYQBD","value":"1000"},"Sequence":10490188,"SigningPubKey
      ":"026E2F3E476282A3A6B3A2FDE75FF032BB7299336B4368B04B0BCFA58094AE9339","TransactionType":"TrustSet","TxnSignature":"30
      45022100FEA8F2E555EFB8128C3200ADE1D8EE7874A8FFD2F2FED617F2847A897806A52B02206E581D79A45AD9B2CA40DC14614305035E1E6779B8
      A153FA1D921FF9A14B508E","hash":"81675A683CE705357CE06B0A1BA53F0E61E79891ABADC6E3B2A1B004728E479E"}
      validated_ledger_index: 10494926
    

    See code: src/commands/trust.ts

    Keywords

    Install

    npm i iou-issuer

    DownloadsWeekly Downloads

    5

    Version

    0.0.3

    License

    MIT

    Unpacked Size

    31.9 kB

    Total Files

    19

    Last publish

    Collaborators

    • intelliot