mixin_bot 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59e234762e65de8e0858a88eaae1c25a8951076345728b20e65d2c15294fc831
-  data.tar.gz: 190b8385d4501ff7e603751670f160257f69651679cb4572f4037c4d7c955a67
+  metadata.gz: 769e68c946637d91db6a89c5583ab7c49763193ca8c7088fbd95038cb2bf5f20
+  data.tar.gz: 31405213d094fb3a3d39c4f2e1b2f4e51ce7555c591148c539eb669c7b9d7ccb
 SHA512:
-  metadata.gz: 92d6704e15ce02a56e5f3451c75689b27caf6b7a782597a5535e736926c0c6090cc75d7f40d2190c29ddb32858b910f4b3f0bbcf7f295d474298258ae60c73d6
-  data.tar.gz: 19b4de6e5645793750091cb311b38ecedf5e5ba5b6fd0ffaa1916d0be9f2c5fd53a33be658e21e992fdaffe01bbeee83c500b2cb0223ea04fdcd5fda1db87270
+  metadata.gz: 1105ff54db0cb2eef406ebeaed844227fbb009006ddc71c4ca96bd45967b87fadd8e4a596c2f383e6c4f37558c22fec33111aa051546abf046a2944f0a3d100e
+  data.tar.gz: 5bfce8c2db0ddfc6f204babffd5314988055a59529634d16657943c69373130640e706bb25c339c2dbb8e5f6045b796e636b76cea870746db04d3548086a52d4

data/lib/mixin_bot.rb

@@ -11,6 +11,7 @@ require 'msgpack'
 require 'open3'
 require 'openssl'
 require 'rbnacl'
+require 'sha3'
 
 require_relative './mixin_bot/api'
 require_relative './mixin_bot/cli'

data/lib/mixin_bot/api.rb

@@ -13,6 +13,7 @@ require_relative './api/multisig'
 require_relative './api/payment'
 require_relative './api/pin'
 require_relative './api/snapshot'
+require_relative './api/transaction'
 require_relative './api/transfer'
 require_relative './api/user'
 require_relative './api/withdraw'
@@ -65,6 +66,7 @@ module MixinBot
     include MixinBot::API::Payment
     include MixinBot::API::Pin
     include MixinBot::API::Snapshot
+    include MixinBot::API::Transaction
     include MixinBot::API::Transfer
     include MixinBot::API::User
     include MixinBot::API::Withdraw

data/lib/mixin_bot/api/conversation.rb

@@ -17,19 +17,106 @@ module MixinBot
       end
       alias read_conversation_by_user_id conversation_by_user_id
 
-      def create_contact_conversation(user_id)
+      def create_conversation(category:, conversation_id:, participants:, name: nil, access_token: nil)
         path = '/conversations'
         payload = {
+          category: category,
+          conversation_id: conversation_id || SecureRandom.uuid,
+          name: name,
+          participants: participants
+        }
+
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+
+      def create_group_conversation(user_ids:, name:, conversation_id: nil, access_token: nil)
+        create_conversation(
+          category: 'GROUP',
+          conversation_id: conversation_id,
+          name: name,
+          participants: user_ids.map(&->(participant) { { user_id: participant } }),
+          access_token: access_token
+        )
+      end
+
+      def create_contact_conversation(user_id, access_token: nil)
+        create_conversation(
           category: 'CONTACT',
           conversation_id: unique_conversation_id(user_id),
           participants: [
             {
-              action: 'ADD',
-              role: '',
               user_id: user_id
             }
-          ]
+          ],
+          access_token: access_token
+        )
+      end
+
+      def update_group_conversation_name(name:, conversation_id:, access_token: nil)
+        path = format('/conversations/%<id>s', id: conversation_id)
+        payload = {
+          name: name
+        }
+
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+
+      def update_group_conversation_announcement(announcement:, conversation_id:, access_token: nil)
+        path = format('/conversations/%<id>s', id: conversation_id)
+        payload = {
+          announcement: announcement
         }
+
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+
+      # participants = [{ user_id: "" }]
+      def add_conversation_participants(conversation_id:, user_ids:, access_token: nil)
+        path = format('/conversations/%<id>s/participants/ADD', id: conversation_id)
+        payload = user_ids.map(&->(participant) { { user_id: participant } })
+
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+
+      # participants = [{ user_id: "" }]
+      def remove_conversation_participants(conversation_id:, user_ids:, access_token: nil)
+        path = format('/conversations/%<id>s/participants/REMOVE', id: conversation_id)
+        payload = user_ids.map(&->(participant) { { user_id: participant } })
+
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+
+      def exit_conversation(conversation_id, access_token: nil)
+        path = format('/conversations/%<id>s/exit', id: conversation_id)
+
+        access_token ||= access_token('POST', path)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization })
+      end
+
+      def rotate_conversation(conversation_id, access_token: nil)
+        path = format('/conversations/%<id>s/rotate', id: conversation_id)
+
+        access_token ||= access_token('POST', path)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization })
+      end
+
+      # participants = [{ user_id: "", role: "ADMIN" }]
+      def update_conversation_participants_role(conversation_id:, participants:, access_token: nil)
+        path = format('/conversations/%<id>s/participants/ROLE', id: conversation_id)
+        payload = participants
+
         access_token ||= access_token('POST', path, payload.to_json)
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.post(path, headers: { 'Authorization': authorization }, json: payload)

data/lib/mixin_bot/api/multisig.rb

@@ -28,26 +28,28 @@ module MixinBot
       #     "signed_tx":""
       #   }
       # ]}
-      def multisigs(limit: 100, offset: nil, access_token: nil)
-        path = format('/multisigs?limit=%<limit>s&offset=%<offset>s', limit: limit, offset: offset)
+      def outputs(**kwargs)
+        limit = kwargs[:limit] || 100
+        offset = kwargs[:offset] || ''
+        state = kwargs[:state] || ''
+        members = kwargs[:members] || []
+        threshold = kwargs[:threshold] || ''
+        access_token = kwargs[:access_token]
+        members = SHA3::Digest::SHA256.hexdigest(members&.sort&.join)
+
+        path = format(
+          '/multisigs/outputs?limit=%<limit>s&offset=%<offset>s&state=%<state>s&members=%<members>s&threshold=%<threshold>s',
+          limit: limit,
+          offset: offset,
+          state: state,
+          members: members,
+          threshold: threshold
+        )
         access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
-
-      def all_multisigs(utxos: [], offset: nil, access_token: nil)
-        res = multisigs(limit: 100, offset: offset, access_token: access_token)
-
-        return [] if res['data'].nil?
-
-        utxos += res['data']
-
-        if res['data'].length < 100
-          utxos
-        else
-          all_multisigs(utxos: utxos, offset: utxos[-1]['created_at'], access_token: access_token)
-        end
-      end
+      alias multisigs outputs
 
       def create_output(receivers:, index:, access_token: nil)
         path = '/outputs'
@@ -64,7 +66,7 @@ module MixinBot
       # create a request for multi sign
       # for now, raw(RAW-TRANSACTION-HEX) can only be generated by Mixin SDK of Golang or Javascript
       def create_sign_multisig_request(raw, access_token: nil)
-        path = '/multisigs'
+        path = '/multisigs/requests'
         payload = {
           action: 'sign',
           raw: raw
@@ -77,7 +79,7 @@ module MixinBot
       # transfer from the multisig address
       # create a request for unlock a multi-sign
       def create_unlock_multisig_request(raw, access_token: nil)
-        path = '/multisigs'
+        path = '/multisigs/requests'
         payload = {
           action: 'unlock',
           raw: raw
@@ -88,7 +90,7 @@ module MixinBot
       end
 
       def sign_multisig_request(request_id, pin)
-        path = format('/multisigs/%<request_id>s/sign', request_id: request_id)
+        path = format('/multisigs/requests/%<request_id>s/sign', request_id: request_id)
         payload = {
           pin: encrypt_pin(pin)
         }
@@ -98,7 +100,7 @@ module MixinBot
       end
 
       def unlock_multisig_request(request_id, pin)
-        path = format('/multisigs/%<request_id>s/unlock', request_id: request_id)
+        path = format('/multisigs/requests/%<request_id>s/unlock', request_id: request_id)
         payload = {
           pin: encrypt_pin(pin)
         }
@@ -108,7 +110,7 @@ module MixinBot
       end
 
       def cancel_multisig_request(request_id, pin)
-        path = format('/multisigs/%<request_id>s/cancel', request_id: request_id)
+        path = format('/multisigs/requests/%<request_id>s/cancel', request_id: request_id)
         payload = {
           pin: encrypt_pin(pin)
         }
@@ -165,76 +167,42 @@ module MixinBot
         "fffe#{s}"
       end
 
-      # filter utxo by members, asset_id and threshold
-      def filter_utxos(**kwargs)
-        utxos = all_multisigs(access_token: kwargs[:access_token])
-
-        unless kwargs[:members].nil?
-          utxos = utxos.filter(
-            &lambda { |utxo|
-              utxo['members'].sort == kwargs[:members].sort
-            }
-          )
-        end
-
-        unless kwargs[:asset_id].nil?
-          utxos = utxos.filter(
-            &lambda { |utxo|
-              utxo['asset_id'] == kwargs[:asset_id]
-            }
-          )
-        end
-
-        unless kwargs[:threshold].nil?
-          utxos = utxos.filter(
-            &lambda { |utxo|
-              utxo['threshold'] == kwargs[:threshold]
-            }
-          )
-        end
-
-        unless kwargs[:state].nil?
-          utxos = utxos.filter(
-            &lambda { |utxo|
-              utxo['state'] == kwargs[:state]
-            }
-          )
-        end
-
-        utxos
-      end
-
       # kwargs:
       # {
       #   senders: [ uuid ],
       #   receivers: [ uuid ],
       #   threshold: integer,
       #   asset_id: uuid,
-      #   asset_mixin_id: string,
       #   amount: string / float,
       #   memo: string,
       # }
-      def build_raw_transaction(kwargs)
+      RAW_TRANSACTION_ARGUMENTS = %i[senders receivers amount threshold asset_id].freeze
+      def build_raw_transaction(**kwargs)
+        raise ArgumentError, "#{RAW_TRANSACTION_ARGUMENTS.join(', ')} are needed for build raw transaction" unless RAW_TRANSACTION_ARGUMENTS.all? { |param| kwargs.keys.include? param }
+
         senders        = kwargs[:senders]
         receivers      = kwargs[:receivers]
-        asset_id       = kwargs[:asset_id]
-        asset_mixin_id = kwargs[:asset_mixin_id]
         amount         = kwargs[:amount]
-        memo           = kwargs[:memo]
         threshold      = kwargs[:threshold]
-        access_token   = kwargs[:access_token]
+        asset_id       = kwargs[:asset_id]
         utxos          = kwargs[:utxos]
+        memo           = kwargs[:memo]
+        access_token   = kwargs[:access_token]
 
         raise 'access_token required!' if access_token.nil? && !senders.include?(client_id)
 
-        # default to use all unspent utxo
-        utxos ||= filter_utxos(
+        # default to use all(first 100) unspent utxo
+        utxos ||= multisigs(
           members: senders,
-          asset_id: asset_id,
           threshold: threshold,
           state: 'unspent',
           access_token: access_token
+        ).filter(
+          &lambda { |utxo|
+            utxo['asset_id'] == kwargs[:asset_id]
+          }
         )
+
         amount = amount.to_f.round(8)
         input_amount = utxos.map(
           &lambda { |utxo|
@@ -281,7 +249,7 @@ module MixinBot
         extra = Digest.hexencode memo.to_s.slice(0, 140)
         tx = {
           version: 1,
-          asset: asset_mixin_id,
+          asset: SHA3::Digest::SHA256.hexdigest(asset_id),
           inputs: inputs,
           outputs: outputs,
           extra: extra

data/lib/mixin_bot/api/snapshot.rb

@@ -3,7 +3,7 @@
 module MixinBot
   class API
     module Snapshot
-      def network_snapshots(options = {})
+      def network_snapshots(**options)
         path = format(
           '/network/snapshots?limit=%<limit>s&offset=%<offset>s&asset=%<asset>s&order=%<order>s',
           limit: options[:limit],
@@ -18,12 +18,13 @@ module MixinBot
       end
       alias read_network_snapshots network_snapshots
 
-      def snapshots(options = {})
+      def snapshots(**options)
         path = format(
-          '/snapshots?limit=%<limit>s&offset=%<offset>s&asset=%<asset>s',
+          '/snapshots?limit=%<limit>s&offset=%<offset>s&asset=%<asset>s&opponent=%<opponent>s',
           limit: options[:limit],
           offset: options[:offset],
-          asset: options[:asset]
+          asset: options[:asset],
+          opponent: options[:opponent]
         )
 
         access_token = options[:access_token] || access_token('GET', path)
@@ -32,7 +33,7 @@ module MixinBot
       end
       alias read_snapshots snapshots
 
-      def network_snapshot(snapshot_id, options = {})
+      def network_snapshot(snapshot_id, **options)
         path = format('/network/snapshots/%<snapshot_id>s', snapshot_id: snapshot_id)
 
         access_token = options[:access_token] || access_token('GET', path)

data/lib/mixin_bot/api/transaction.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module MixinBot
+  class API
+    module Transaction
+      MULTISIG_TRANSACTION_ARGUMENTS = %i[asset_id receivers threshold amount].freeze
+      def create_multisig_transaction(pin, options = {})
+        raise ArgumentError, "#{MULTISIG_TRANSACTION_ARGUMENTS.join(', ')} are needed for create multisig transaction" unless MULTISIG_TRANSACTION_ARGUMENTS.all? { |param| options.keys.include? param }
+
+        asset_id = options[:asset_id]
+        receivers = options[:receivers]
+        threshold = options[:threshold]
+        amount = options[:amount].to_f
+        memo = options[:memo]
+        trace_id = options[:trace_id] || SecureRandom.uuid
+        encrypted_pin = options[:encrypted_pin] || encrypt_pin(pin)
+
+        path = '/transactions'
+        payload = {
+          asset_id: asset_id,
+          opponent_multisig: {
+            receivers: receivers,
+            threshold: threshold
+          },
+          pin: encrypted_pin,
+          amount: amount.to_s,
+          trace_id: trace_id,
+          memo: memo
+        }
+
+        access_token = options[:access_token]
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+
+      MAINNET_TRANSACTION_ARGUMENTS = %i[asset_id opponent_key amount].freeze
+      def create_mainnet_transaction(pin, options = {})
+        raise ArgumentError, "#{MAINNET_TRANSACTION_ARGUMENTS.join(', ')} are needed for create main net transactions" unless MAINNET_TRANSACTION_ARGUMENTS.all? { |param| options.keys.include? param }
+
+        asset_id = options[:asset_id]
+        opponent_key = options[:opponent_key]
+        amount = options[:amount].to_f
+        memo = options[:memo]
+        trace_id = options[:trace_id] || SecureRandom.uuid
+        encrypted_pin = options[:encrypted_pin] || encrypt_pin(pin)
+
+        path = '/transactions'
+        payload = {
+          asset_id: asset_id,
+          opponent_key: opponent_key,
+          pin: encrypted_pin,
+          amount: amount.to_s,
+          trace_id: trace_id,
+          memo: memo
+        }
+
+        access_token = options[:access_token]
+        access_token ||= access_token('POST', path, payload.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: payload)
+      end
+    end
+  end
+end

data/lib/mixin_bot/client.rb

@@ -32,7 +32,7 @@ module MixinBot
         raise HttpError, e.message
       end
 
-      raise RequestError.new(nil, response.to_s) unless response.status.success?
+      raise RequestError, response.to_s unless response.status.success?
 
       parse_response(response) do |parse_as, result|
         case parse_as

data/lib/mixin_bot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MixinBot
-  VERSION = '0.3.8'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixin_bot
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - an-lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: sha3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +258,7 @@ files:
 - lib/mixin_bot/api/payment.rb
 - lib/mixin_bot/api/pin.rb
 - lib/mixin_bot/api/snapshot.rb
+- lib/mixin_bot/api/transaction.rb
 - lib/mixin_bot/api/transfer.rb
 - lib/mixin_bot/api/user.rb
 - lib/mixin_bot/api/withdraw.rb
@@ -272,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: An API wrapper for Mixin Nexwork